From 517f15c7bd827a6bcb8ff45d09acae102c8af1d4 Mon Sep 17 00:00:00 2001 From: NoM0Re Date: Wed, 1 Oct 2025 22:24:58 +0200 Subject: [PATCH] (feat/API) replace Blizzard_APIDocumentation with Wrath Private Data (#72) --- APIDocumentation/APIDocumentation.toc | 370 +-- .../AccountConstantsDocumentation.lua | 115 - .../AccountInfoDocumentation.lua | 62 - .../AchievementDocumentation.lua | 492 ++++ .../AchievementInfoDocumentation.lua | 164 -- .../ActionBarFrameDocumentation.lua | 267 -- .../Documentation/ActionDocumentation.lua | 391 ++- .../Documentation/ActionbarDocumentation.lua | 147 ++ .../Documentation/AddOnsDocumentation.lua | 63 - .../AddonRelatedDocumentation.lua | 207 ++ .../AdventureJournalDocumentation.lua | 96 - .../AdventureMapDocumentation.lua | 53 - .../AppearanceSourceDocumentation.lua | 30 - .../AreaPoiInfoDocumentation.lua | 103 - .../Documentation/ArenaDocumentation.lua | 348 +++ .../Documentation/AuctionDocumentation.lua | 459 ++++ ...ionHouseConstants_ClassicDocumentation.lua | 8 - .../AuctionHouseDocumentation.lua | 105 - .../AuctionHouseEnumsDocumentation.lua | 137 -- .../Awesome_WotLKDocumentation.lua | 444 ++++ .../AzeriteConstantsDocumentation.lua | 22 - .../AzeriteEmpoweredItemDocumentation.lua | 327 --- .../AzeriteEssenceDocumentation.lua | 326 --- .../AzeriteItemDocumentation.lua | 183 -- .../BagConstantsDocumentation.lua | 26 - .../BagIndexConstantsDocumentation.lua | 46 - .../Documentation/BankDocumentation.lua | 77 +- .../Documentation/BarberShopDocumentation.lua | 339 --- .../Documentation/BarbershopDocumentation.lua | 119 + .../Documentation/BaseDocumentation.lua | 15 - .../Documentation/BattleNetDocumentation.lua | 402 ++- .../BattlePetConstantsDocumentation.lua | 396 --- .../Documentation/BattlePetDocumentation.lua | 233 -- .../BattlefieldDocumentation.lua | 619 +++++ .../BehavioralMessagingDocumentation.lua | 41 - .../BlackMarketInfoDocumentation.lua | 70 - .../BlizzardInternalDocumentation.lua | 240 ++ .../Blizzard_APIDocumentationGenerated.toc | 278 --- .../BountySharedDocumentation.lua | 20 - .../Documentation/BrowserDocumentation.lua | 39 - .../Documentation/BuffDocumentation.lua | 117 + .../Documentation/BuildDocumentation.lua | 19 - .../ButtonConstantsDocumentation.lua | 8 - .../Documentation/CVarDocumentation.lua | 124 - .../CalendarConstantsDocumentation.lua | 337 --- .../Documentation/CalendarDocumentation.lua | 1376 ++++++----- .../Documentation/CameraDocumentation.lua | 165 +- .../Documentation/ChannelDocumentation.lua | 842 +++++++ ...racterCustomizationSharedDocumentation.lua | 116 - .../ChatBubblesDocumentation.lua | 34 - .../ChatConstantsDocumentation.lua | 156 -- .../Documentation/ChatDocumentation.lua | 1054 ++++++++ .../Documentation/ChatInfoDocumentation.lua | 2158 ----------------- .../Documentation/CinematicDocumentation.lua | 53 - .../ClassResourceDocumentation.lua | 116 + .../Documentation/ClassTrialDocumentation.lua | 30 - ...ientControlAndInformationDocumentation.lua | 183 ++ .../Documentation/ClientDocumentation.lua | 19 - .../ClientSceneDocumentation.lua | 46 - .../Documentation/ClubDocumentation.lua | 1634 ------------- .../Documentation/ClubSharedDocumentation.lua | 8 - .../Documentation/ColorDocumentation.lua | 8 - .../Documentation/CombatDocumentation.lua | 146 ++ .../Documentation/CombatLogDocumentation.lua | 39 - .../Documentation/CombatlogDocumentation.lua | 174 ++ .../CommentatorDocumentation.lua | 220 ++ .../CommentatorFrameDocumentation.lua | 1569 ------------ .../CommentatorSharedDocumentation.lua | 23 - .../CompactUnitFramesDocumentation.lua | 25 - .../Documentation/CompanionDocumentation.lua | 122 + .../Documentation/ComplaintDocumentation.lua | 130 + .../ConfigurationWarningsDocumentation.lua | 89 - .../Documentation/ConsoleDocumentation.lua | 202 -- .../ConsoleScriptCollectionDocumentation.lua | 116 - .../Documentation/ContainerDocumentation.lua | 462 +--- .../ContentTrackingTypesDocumentation.lua | 110 - .../ContributionCollectorDocumentation.lua | 75 - .../CooldownFrameAPIDocumentation.lua | 359 --- .../Documentation/CraftInfoDocumentation.lua | 35 - .../CreatureInfoDocumentation.lua | 91 - .../CurrencyConstantsDocumentation.lua | 131 - ...CurrencyConstants_ClassicDocumentation.lua | 83 - .../Documentation/CurrencyDocumentation.lua | 177 ++ .../CurrencyInfoDocumentation.lua | 148 -- .../CursorConstDocumentation.lua | 96 - .../Documentation/CursorDocumentation.lua | 525 +++- .../Documentation/CvarDocumentation.lua | 140 ++ .../DamageConstantsDocumentation.lua | 105 - .../DateAndTimeDocumentation.lua | 115 - .../Documentation/DeathInfoDocumentation.lua | 206 -- .../DebuggingAndProfilingDocumentation.lua | 236 ++ .../Documentation/DeprecatedDocumentation.lua | 45 + .../Documentation/DuelDocumentation.lua | 57 + .../Documentation/DuelInfoDocumentation.lua | 44 - .../EditModeManagerDocumentation.lua | 181 -- .../EditModeManagerSharedDocumentation.lua | 507 ---- .../EncounterInfoDocumentation.lua | 90 - ...EncounterJournalConstantsDocumentation.lua | 126 - .../EquipmentManagerDocumentation.lua | 272 +-- .../Documentation/EventUtilsDocumentation.lua | 43 - .../Documentation/ExpansionDocumentation.lua | 196 -- ...nsionLandingPageConstantsDocumentation.lua | 20 - .../ExperienceXpDocumentation.lua | 71 + .../Documentation/FactionDocumentation.lua | 204 ++ .../Documentation/FogOfWarDocumentation.lua | 31 - .../Documentation/FontDocumentation.lua | 40 - ...rameAPICharacterModelBaseDocumentation.lua | 265 -- .../FrameAPICinematicModelDocumentation.lua | 185 -- .../FrameAPICooldownDocumentation.lua | 359 --- .../FrameAPIDressUpModelDocumentation.lua | 99 - .../FrameAPIFogOfWarFrameDocumentation.lua | 153 -- .../FrameAPIModelSceneFrameDocumentation.lua | 558 ----- ...eAPIModelSceneFrameSharedDocumentation.lua | 20 - .../FrameAPISimpleCheckoutDocumentation.lua | 90 - .../FrameAPITabardModelBaseDocumentation.lua | 76 - .../FrameAPITabardModelDocumentation.lua | 71 - ...FrameAPIUnitPositionFrameDocumentation.lua | 153 -- .../FrameScriptDocumentation.lua | 33 - .../Documentation/FriendListDocumentation.lua | 530 ---- ...ON_FOLLOWER_TYPEConstantsDocumentation.lua | 23 - .../GARRISON_TYPEConstantsDocumentation.lua | 22 - .../GMTicketInfoDocumentation.lua | 78 - .../GamePadConstDocumentation.lua | 24 - .../Documentation/GamePadDocumentation.lua | 411 ---- .../Documentation/GameRulesDocumentation.lua | 20 - .../GarrisonConstantsDocumentation.lua | 365 --- .../Documentation/GlueDocumentation.lua | 19 - .../Documentation/GlyphDocumentation.lua | 132 + .../Documentation/GlyphInfoDocumentation.lua | 70 - .../Documentation/GmSurveyDocumentation.lua | 95 + .../Documentation/GmTicketDocumentation.lua | 80 + .../GossipConstantsDocumentation.lua | 95 - .../Documentation/GossipInfoDocumentation.lua | 328 --- .../Documentation/GuildBankDocumentation.lua | 445 +++- .../Documentation/GuildDocumentation.lua | 670 +++++ .../Documentation/GuildInfoDocumentation.lua | 314 --- .../GuildInfoSharedDocumentation.lua | 20 - .../HeirloomInfoDocumentation.lua | 40 - .../Documentation/HyperlinkDocumentation.lua | 461 ++++ .../InGameMoviePlaybackDocumentation.lua | 82 + .../InputConstantsDocumentation.lua | 22 - .../Documentation/InputDocumentation.lua | 19 - .../Documentation/InspectDocumentation.lua | 119 + .../Documentation/InstanceDocumentation.lua | 244 ++ .../InstanceEncounterDocumentation.lua | 63 - .../Documentation/InventoryDocumentation.lua | 429 ++++ .../ItemConstantsDocumentation.lua | 427 ---- .../ItemConstants_ClassicDocumentation.lua | 27 - .../Documentation/ItemDocumentation.lua | 579 +++-- .../ItemLocationSharedDocumentation.lua | 8 - .../Documentation/ItemSharedDocumentation.lua | 8 - .../ItemSocketInfoDocumentation.lua | 54 - .../Documentation/ItemTextDocumentation.lua | 77 +- .../ItemUpgradeDocumentation.lua | 39 - .../KeyBindingsDocumentation.lua | 88 - .../Documentation/KeybindDocumentation.lua | 297 +++ .../Documentation/KeyboardDocumentation.lua | 119 + .../KnowledgeBaseDocumentation.lua | 257 +- .../LFGConstantsDocumentation.lua | 30 - .../Documentation/LFGInfoDocumentation.lua | 234 -- .../LFGListInfoDocumentation.lua | 397 --- .../LevelConstantsDocumentation.lua | 17 - .../LimitedPlayTimeDocumentation.lua | 56 + .../LoadingScreenDocumentation.lua | 30 - .../Documentation/LocaleDocumentation.lua | 28 - .../LocaleSpecificDocumentation.lua | 66 + .../LocalizationDocumentation.lua | 19 - .../LookingForGroupDocumentation.lua | 159 ++ .../LootConstantsDocumentation.lua | 30 - .../Documentation/LootDocumentation.lua | 432 ++-- .../LossOfControlDocumentation.lua | 132 - .../Documentation/LuaLibraryDocumentation.lua | 750 ++++++ .../Documentation/MacClientDocumentation.lua | 227 ++ .../Documentation/MacroDocumentation.lua | 311 +++ .../Documentation/MailDocumentation.lua | 481 ++++ .../Documentation/MailInfoDocumentation.lua | 125 - .../MapConstantsDocumentation.lua | 82 - .../Documentation/MapDocumentation.lua | 545 ++--- .../MapExplorationDocumentation.lua | 80 - .../Documentation/MerchantDocumentation.lua | 325 +++ .../MerchantFrameDocumentation.lua | 58 - .../Documentation/MinigameDocumentation.lua | 45 + .../MinimapConstantsDocumentation.lua | 40 - .../Documentation/MinimapDocumentation.lua | 139 -- .../MinimapFrameAPIDocumentation.lua | 149 -- .../Documentation/ModelSceneDocumentation.lua | 8 - .../ModifiedClickDocumentation.lua | 82 + .../Documentation/MoneyDocumentation.lua | 267 ++ .../Documentation/MovementDocumentation.lua | 186 ++ .../Documentation/MovieDocumentation.lua | 19 - .../MultiCastActionsDocumentation.lua | 31 + .../Documentation/NamePlateDocumentation.lua | 8 - .../NamePlateManagerDocumentation.lua | 74 - .../Documentation/NewItemsDocumentation.lua | 49 - .../NpcGossipDialogDocumentation.lua | 165 ++ .../ObjectivesTrackingDocumentation.lua | 185 ++ .../Documentation/OsDocumentation.lua | 19 - .../PVPMgrConstantsDocumentation.lua | 8 - .../PaperDollInfoDocumentation.lua | 229 -- .../ParentalControlsDocumentation.lua | 19 - .../Documentation/PartyDocumentation.lua | 371 +++ .../Documentation/PartyInfoDocumentation.lua | 240 -- .../PartyPoseUIDocumentation.lua | 46 - .../PerksVendorConstantsDocumentation.lua | 24 - .../PetBattleConstantsDocumentation.lua | 354 --- .../Documentation/PetDocumentation.lua | 423 ++++ .../Documentation/PetInfoDocumentation.lua | 100 - .../PetJournalInfoDocumentation.lua | 39 - .../PetScalingConstantsDocumentation.lua | 8 - .../Documentation/PetStableDocumentation.lua | 157 ++ .../Documentation/PetitionDocumentation.lua | 160 ++ .../PingConstantsDocumentation.lua | 22 - .../Documentation/PlatformDocumentation.lua | 32 - .../Documentation/PlayerDocumentation.lua | 8 - .../Documentation/PlayerInfoDocumentation.lua | 85 - .../PlayerInfoSharedDocumentation.lua | 31 - .../PlayerInformationDocumentation.lua | 750 ++++++ ...teractionManagerConstantsDocumentation.lua | 83 - .../PlayerInteractionManagerDocumentation.lua | 113 - .../PlayerLocationDocumentation.lua | 120 - ...PlayerMentorshipConstantsDocumentation.lua | 34 - .../Documentation/PortraitDocumentation.lua | 19 - .../ProfessionConstantsDocumentation.lua | 318 --- .../PvPFactionConstantsDocumentation.lua | 20 - .../Documentation/PvpDocumentation.lua | 322 +++ .../PvpInfoConstantsDocumentation.lua | 16 - .../Documentation/PvpInfoDocumentation.lua | 461 ---- .../QuestConstantsDocumentation.lua | 78 - .../QuestConstants_ClassicDocumentation.lua | 8 - .../Documentation/QuestDocumentation.lua | 1182 +++++++++ .../QuestInfoSystemDocumentation.lua | 93 - .../QuestLineInfoDocumentation.lua | 49 - .../Documentation/QuestLogDocumentation.lua | 256 -- .../Documentation/QuestOfferDocumentation.lua | 50 - .../QuestRewardsDocumentation.lua | 17 - .../QuestSessionConstantsDocumentation.lua | 67 - .../QuestSessionDocumentation.lua | 200 -- .../QuestTaskInfoDocumentation.lua | 200 -- .../QueueSpecificDocumentation.lua | 25 - .../Documentation/RaidDocumentation.lua | 407 ++++ .../Documentation/RaidLocksDocumentation.lua | 36 - .../RecruitAFriendDocumentation.lua | 112 + .../RecruitAFriendSharedDocumentation.lua | 36 - .../ReportSystemConstantsDocumentation.lua | 73 - .../ReportSystemDocumentation.lua | 134 - .../ReputationInfoDocumentation.lua | 70 - .../RestrictedActionsDocumentation.lua | 58 - .../Documentation/ScreenDocumentation.lua | 19 - .../ScriptRegionSharedDocumentation.lua | 8 - .../ScriptWarningsDocumentation.lua | 30 - .../ScriptedAnimationsDocumentation.lua | 107 - .../SeasonsConstantsDocumentation.lua | 21 - .../Documentation/SeasonsDocumentation.lua | 38 - .../SecureExecutionUtilityDocumentation.lua | 101 + .../SecureTransferDocumentation.lua | 35 - ...redScriptObjectModelLightDocumentation.lua | 21 - ...ptObjectUnitPositionFrameDocumentation.lua | 21 - .../SharedTraitsDocumentation.lua | 822 ------- .../SharedTraitsEnumsDocumentation.lua | 8 - .../SimpleAnimAPIDocumentation.lua | 441 ---- .../SimpleAnimAlphaAPIDocumentation.lua | 63 - .../SimpleAnimFlipBookAPIDocumentation.lua | 129 - .../SimpleAnimGroupAPIDocumentation.lua | 342 --- .../SimpleAnimPathAPIDocumentation.lua | 83 - .../SimpleAnimRotationAPIDocumentation.lua | 89 - .../SimpleAnimScaleAPIDocumentation.lua | 117 - .../SimpleAnimScaleLineAPIDocumentation.lua | 19 - ...extureCoordTranslationAPIDocumentation.lua | 43 - .../SimpleAnimTranslationAPIDocumentation.lua | 43 - ...pleAnimTranslationLineAPIDocumentation.lua | 19 - ...SimpleAnimatableObjectAPIDocumentation.lua | 55 - .../SimpleBrowserAPIDocumentation.lua | 128 - .../SimpleButtonAPIDocumentation.lua | 482 ---- .../SimpleCheckboxAPIDocumentation.lua | 85 - .../SimpleColorSelectAPIDocumentation.lua | 167 -- .../SimpleControlPointAPIDocumentation.lua | 75 - .../SimpleEditBoxAPIDocumentation.lua | 839 ------- .../SimpleFontAPIDocumentation.lua | 266 -- .../SimpleFontStringAPIDocumentation.lua | 544 ----- .../SimpleFrameAPIDocumentation.lua | 1072 -------- ...impleFrameScriptObjectAPIDocumentation.lua | 80 - .../SimpleHTMLAPIDocumentation.lua | 311 --- .../SimpleHTMLSharedDocumentation.lua | 18 - .../SimpleLineAPIDocumentation.lua | 105 - .../SimpleMaskTextureAPIDocumentation.lua | 19 - .../SimpleMessageFrameAPIDocumentation.lua | 404 --- .../SimpleModelAPIDocumentation.lua | 723 ------ .../SimpleModelFFXAPIDocumentation.lua | 57 - .../SimpleMovieAPIDocumentation.lua | 69 - .../SimpleObjectAPIDocumentation.lua | 68 - .../SimpleOffScreenFrameAPIDocumentation.lua | 120 - .../SimpleRegionAPIDocumentation.lua | 185 -- .../SimpleScriptRegionAPIDocumentation.lua | 485 ---- ...leScriptRegionResizingAPIDocumentation.lua | 154 -- .../SimpleScrollFrameAPIDocumentation.lua | 119 - .../SimpleSliderAPIDocumentation.lua | 227 -- .../SimpleStatusBarAPIDocumentation.lua | 259 -- .../SimpleTextureAPIDocumentation.lua | 64 - .../SimpleTextureBaseAPIDocumentation.lua | 384 --- .../Documentation/SkillDocumentation.lua | 99 + .../Documentation/SkillInfoDocumentation.lua | 25 - .../Documentation/SocialDocumentation.lua | 255 ++ .../Documentation/SocialInfoDocumentation.lua | 56 - .../SocialQueueDocumentation.lua | 87 - .../SocialRestrictionsDocumentation.lua | 92 - .../Documentation/SocketingDocumentation.lua | 201 ++ .../SoftTargetConstantsDocumentation.lua | 22 - .../Documentation/SoundDocumentation.lua | 159 +- .../SpecializationInfoDocumentation.lua | 76 - .../SpecializationSharedDocumentation.lua | 35 - .../SpellActivationOverlayDocumentation.lua | 62 - .../Documentation/SpellBookDocumentation.lua | 149 -- .../Documentation/SpellDocumentation.lua | 744 +++++- .../Documentation/StableInfoDocumentation.lua | 58 - .../StanceshapeshiftDocumentation.lua | 86 + .../StatInformationDocumentation.lua | 519 ++++ .../StorePublicUIDocumentation.lua | 61 - .../Documentation/StringUtilDocumentation.lua | 37 - .../Documentation/SummonInfoDocumentation.lua | 73 - .../Documentation/SummoningDocumentation.lua | 66 + .../Documentation/SystemDocumentation.lua | 201 -- .../Documentation/SystemTimeDocumentation.lua | 19 - .../TTSSettingsDocumentation.lua | 218 -- .../Documentation/TalentDocumentation.lua | 340 +++ .../Documentation/TargetingDocumentation.lua | 178 ++ .../Documentation/TaxiMapDocumentation.lua | 116 - .../Documentation/TaxiflightDocumentation.lua | 228 ++ .../TextureSharedDocumentation.lua | 8 - .../TextureUtilsDocumentation.lua | 134 - .../Documentation/ThreatDocumentation.lua | 91 + .../Documentation/TimeDocumentation.lua | 22 - .../TooltipComparisonDocumentation.lua | 44 - .../TooltipConstantsDocumentation.lua | 51 - .../TooltipInfoDocumentation.lua | 44 - .../TooltipInfoSharedDocumentation.lua | 128 - .../Documentation/ToyBoxInfoDocumentation.lua | 63 - .../Documentation/TrackingDocumentation.lua | 62 + .../Documentation/TradeDocumentation.lua | 253 ++ .../Documentation/TradeInfoDocumentation.lua | 96 - .../TradeSkillUIDocumentation.lua | 86 - .../TradeSkillUITypesDocumentation.lua | 72 - .../Documentation/TradeskillDocumentation.lua | 463 ++++ .../Documentation/TrainerDocumentation.lua | 276 ++- .../TraitConfigDocumentation.lua | 20 - .../TraitConstantsDocumentation.lua | 299 --- .../TransmogSharedDocumentation.lua | 122 - .../Documentation/TutorialDocumentation.lua | 27 +- .../Documentation/UIColorDocumentation.lua | 38 - .../UIFileAssetSharedDocumentation.lua | 8 - .../UIGenericWidgetDisplayDocumentation.lua | 51 - .../Documentation/UIMacrosDocumentation.lua | 43 - .../Documentation/UIManagerDocumentation.lua | 80 - .../UIModelInfoDocumentation.lua | 231 -- .../UIModelInfoSharedDocumentation.lua | 8 - .../Documentation/UISharedDocumentation.lua | 31 - ...UISystemVisibilityManagerDocumentation.lua | 50 - .../UITextureAssetSharedDocumentation.lua | 8 - .../Documentation/UITimerDocumentation.lua | 74 - .../UIWidgetManagerDocumentation.lua | 501 ---- .../UIWidgetManagerSharedDocumentation.lua | 74 - .../Documentation/URLDocumentation.lua | 19 - .../UiModelSceneConstantsDocumentation.lua | 33 - .../Documentation/UivisualDocumentation.lua | 143 ++ .../UncategorizedDocumentation.lua | 1305 ++++++++++ .../UncategorizedeventsDocumentation.lua | 212 ++ .../Documentation/UnitAuraDocumentation.lua | 28 - .../UnitConstantsDocumentation.lua | 8 - .../Documentation/UnitDocumentation.lua | 2084 +++++++++------- .../UnitSexConstantsDocumentation.lua | 23 - .../Documentation/UnitSharedDocumentation.lua | 8 - .../UserFeedbackDocumentation.lua | 49 - .../Documentation/UtilityDocumentation.lua | 459 ++++ .../ValidateNameConstantsDocumentation.lua | 50 - .../VectorSharedDocumentation.lua | 8 - .../VehicleConstantsDocumentation.lua | 8 - .../Documentation/VehicleDocumentation.lua | 407 +++- .../Documentation/VideoDocumentation.lua | 297 ++- .../VignetteConstantsDocumentation.lua | 23 - .../VignetteInfoDocumentation.lua | 40 - .../Documentation/VoiceChatDocumentation.lua | 1344 ---------- .../Documentation/VoiceDocumentation.lua | 647 +++++ .../VoidStorageInfoDocumentation.lua | 59 - .../WeeklyRewardsSharedDocumentation.lua | 8 - .../Documentation/WoWGuidDocumentation.lua | 8 - .../WorldStateInfoDocumentation.lua | 58 - .../WowEntitlementInfoDocumentation.lua | 67 - .../WowLabsConstantsDocumentation.lua | 8 - .../Documentation/WowTokenUIDocumentation.lua | 119 - .../Documentation/XMLUtilDocumentation.lua | 75 - .../ZoneInformationDocumentation.lua | 101 + APIDocumentation/EventsAPIMixin.lua | 5 +- APIDocumentation/FunctionsAPIMixin.lua | 3 - 392 files changed, 29576 insertions(+), 43596 deletions(-) delete mode 100644 APIDocumentation/Documentation/AccountConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AccountInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/AchievementDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AchievementInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ActionBarFrameDocumentation.lua create mode 100644 APIDocumentation/Documentation/ActionbarDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AddOnsDocumentation.lua create mode 100644 APIDocumentation/Documentation/AddonRelatedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AdventureJournalDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AdventureMapDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AppearanceSourceDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AreaPoiInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/ArenaDocumentation.lua create mode 100644 APIDocumentation/Documentation/AuctionDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AuctionHouseConstants_ClassicDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AuctionHouseDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AuctionHouseEnumsDocumentation.lua create mode 100644 APIDocumentation/Documentation/Awesome_WotLKDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AzeriteConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AzeriteEssenceDocumentation.lua delete mode 100644 APIDocumentation/Documentation/AzeriteItemDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BagConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BagIndexConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BarberShopDocumentation.lua create mode 100644 APIDocumentation/Documentation/BarbershopDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BaseDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BattlePetDocumentation.lua create mode 100644 APIDocumentation/Documentation/BattlefieldDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BehavioralMessagingDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BlackMarketInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/BlizzardInternalDocumentation.lua delete mode 100644 APIDocumentation/Documentation/Blizzard_APIDocumentationGenerated.toc delete mode 100644 APIDocumentation/Documentation/BountySharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BrowserDocumentation.lua create mode 100644 APIDocumentation/Documentation/BuffDocumentation.lua delete mode 100644 APIDocumentation/Documentation/BuildDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ButtonConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CVarDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CalendarConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/ChannelDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ChatBubblesDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ChatConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/ChatDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ChatInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CinematicDocumentation.lua create mode 100644 APIDocumentation/Documentation/ClassResourceDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ClassTrialDocumentation.lua create mode 100644 APIDocumentation/Documentation/ClientControlAndInformationDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ClientDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ClientSceneDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ClubDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ClubSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ColorDocumentation.lua create mode 100644 APIDocumentation/Documentation/CombatDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CombatLogDocumentation.lua create mode 100644 APIDocumentation/Documentation/CombatlogDocumentation.lua create mode 100644 APIDocumentation/Documentation/CommentatorDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CommentatorFrameDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CommentatorSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua create mode 100644 APIDocumentation/Documentation/CompanionDocumentation.lua create mode 100644 APIDocumentation/Documentation/ComplaintDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ConfigurationWarningsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ConsoleDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ConsoleScriptCollectionDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ContributionCollectorDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CooldownFrameAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CraftInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CreatureInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CurrencyConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CurrencyConstants_ClassicDocumentation.lua create mode 100644 APIDocumentation/Documentation/CurrencyDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CurrencyInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/CursorConstDocumentation.lua create mode 100644 APIDocumentation/Documentation/CvarDocumentation.lua delete mode 100644 APIDocumentation/Documentation/DamageConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/DateAndTimeDocumentation.lua delete mode 100644 APIDocumentation/Documentation/DeathInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/DebuggingAndProfilingDocumentation.lua create mode 100644 APIDocumentation/Documentation/DeprecatedDocumentation.lua create mode 100644 APIDocumentation/Documentation/DuelDocumentation.lua delete mode 100644 APIDocumentation/Documentation/DuelInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/EditModeManagerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/EditModeManagerSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/EncounterInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/EncounterJournalConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/EventUtilsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ExpansionDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ExpansionLandingPageConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/ExperienceXpDocumentation.lua create mode 100644 APIDocumentation/Documentation/FactionDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FogOfWarDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FontDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPICharacterModelBaseDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPICinematicModelDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPICooldownDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPIDressUpModelDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPIFogOfWarFrameDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPIModelSceneFrameDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPIModelSceneFrameSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPITabardModelBaseDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPITabardModelDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameAPIUnitPositionFrameDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FrameScriptDocumentation.lua delete mode 100644 APIDocumentation/Documentation/FriendListDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GMTicketInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GamePadConstDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GamePadDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GameRulesDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GarrisonConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GlueDocumentation.lua create mode 100644 APIDocumentation/Documentation/GlyphDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GlyphInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/GmSurveyDocumentation.lua create mode 100644 APIDocumentation/Documentation/GmTicketDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GossipConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GossipInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/GuildDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GuildInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/GuildInfoSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/HeirloomInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/HyperlinkDocumentation.lua create mode 100644 APIDocumentation/Documentation/InGameMoviePlaybackDocumentation.lua delete mode 100644 APIDocumentation/Documentation/InputConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/InputDocumentation.lua create mode 100644 APIDocumentation/Documentation/InspectDocumentation.lua create mode 100644 APIDocumentation/Documentation/InstanceDocumentation.lua delete mode 100644 APIDocumentation/Documentation/InstanceEncounterDocumentation.lua create mode 100644 APIDocumentation/Documentation/InventoryDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ItemConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ItemConstants_ClassicDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ItemSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ItemUpgradeDocumentation.lua delete mode 100644 APIDocumentation/Documentation/KeyBindingsDocumentation.lua create mode 100644 APIDocumentation/Documentation/KeybindDocumentation.lua create mode 100644 APIDocumentation/Documentation/KeyboardDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LFGConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LFGInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LFGListInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LevelConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/LimitedPlayTimeDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LoadingScreenDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LocaleDocumentation.lua create mode 100644 APIDocumentation/Documentation/LocaleSpecificDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LocalizationDocumentation.lua create mode 100644 APIDocumentation/Documentation/LookingForGroupDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LootConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/LossOfControlDocumentation.lua create mode 100644 APIDocumentation/Documentation/LuaLibraryDocumentation.lua create mode 100644 APIDocumentation/Documentation/MacClientDocumentation.lua create mode 100644 APIDocumentation/Documentation/MacroDocumentation.lua create mode 100644 APIDocumentation/Documentation/MailDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MailInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MapConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MapExplorationDocumentation.lua create mode 100644 APIDocumentation/Documentation/MerchantDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MerchantFrameDocumentation.lua create mode 100644 APIDocumentation/Documentation/MinigameDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MinimapConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MinimapDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MinimapFrameAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ModelSceneDocumentation.lua create mode 100644 APIDocumentation/Documentation/ModifiedClickDocumentation.lua create mode 100644 APIDocumentation/Documentation/MoneyDocumentation.lua create mode 100644 APIDocumentation/Documentation/MovementDocumentation.lua delete mode 100644 APIDocumentation/Documentation/MovieDocumentation.lua create mode 100644 APIDocumentation/Documentation/MultiCastActionsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/NamePlateDocumentation.lua delete mode 100644 APIDocumentation/Documentation/NamePlateManagerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/NewItemsDocumentation.lua create mode 100644 APIDocumentation/Documentation/NpcGossipDialogDocumentation.lua create mode 100644 APIDocumentation/Documentation/ObjectivesTrackingDocumentation.lua delete mode 100644 APIDocumentation/Documentation/OsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PVPMgrConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PaperDollInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ParentalControlsDocumentation.lua create mode 100644 APIDocumentation/Documentation/PartyDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PartyInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PartyPoseUIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PerksVendorConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PetBattleConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/PetDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PetInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PetJournalInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PetScalingConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/PetStableDocumentation.lua create mode 100644 APIDocumentation/Documentation/PetitionDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PingConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlatformDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerInfoSharedDocumentation.lua create mode 100644 APIDocumentation/Documentation/PlayerInformationDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerInteractionManagerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerLocationDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PlayerMentorshipConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PortraitDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ProfessionConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PvPFactionConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/PvpDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/PvpInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestConstants_ClassicDocumentation.lua create mode 100644 APIDocumentation/Documentation/QuestDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestLineInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestLogDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestOfferDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestRewardsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestSessionConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestSessionDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QuestTaskInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/QueueSpecificDocumentation.lua create mode 100644 APIDocumentation/Documentation/RaidDocumentation.lua delete mode 100644 APIDocumentation/Documentation/RaidLocksDocumentation.lua create mode 100644 APIDocumentation/Documentation/RecruitAFriendDocumentation.lua delete mode 100644 APIDocumentation/Documentation/RecruitAFriendSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ReportSystemDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ReputationInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/RestrictedActionsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ScreenDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ScriptRegionSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ScriptWarningsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ScriptedAnimationsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SeasonsConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SeasonsDocumentation.lua create mode 100644 APIDocumentation/Documentation/SecureExecutionUtilityDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SecureTransferDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SharedScriptObjectModelLightDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SharedTraitsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SharedTraitsEnumsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimAlphaAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimFlipBookAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimGroupAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimPathAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimRotationAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimScaleAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimScaleLineAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimTextureCoordTranslationAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimTranslationAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimTranslationLineAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleAnimatableObjectAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleBrowserAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleButtonAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleCheckboxAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleColorSelectAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleControlPointAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleEditBoxAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleFontAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleFontStringAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleFrameAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleFrameScriptObjectAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleHTMLAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleHTMLSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleMaskTextureAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleMessageFrameAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleModelAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleModelFFXAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleMovieAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleObjectAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleOffScreenFrameAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleRegionAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleScriptRegionAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleScriptRegionResizingAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleScrollFrameAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleSliderAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleStatusBarAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleTextureAPIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SimpleTextureBaseAPIDocumentation.lua create mode 100644 APIDocumentation/Documentation/SkillDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SkillInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/SocialDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SocialInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SocialQueueDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SocialRestrictionsDocumentation.lua create mode 100644 APIDocumentation/Documentation/SocketingDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SoftTargetConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SpecializationInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SpecializationSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SpellActivationOverlayDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SpellBookDocumentation.lua delete mode 100644 APIDocumentation/Documentation/StableInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/StanceshapeshiftDocumentation.lua create mode 100644 APIDocumentation/Documentation/StatInformationDocumentation.lua delete mode 100644 APIDocumentation/Documentation/StorePublicUIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/StringUtilDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SummonInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/SummoningDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SystemDocumentation.lua delete mode 100644 APIDocumentation/Documentation/SystemTimeDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TTSSettingsDocumentation.lua create mode 100644 APIDocumentation/Documentation/TalentDocumentation.lua create mode 100644 APIDocumentation/Documentation/TargetingDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TaxiMapDocumentation.lua create mode 100644 APIDocumentation/Documentation/TaxiflightDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TextureSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TextureUtilsDocumentation.lua create mode 100644 APIDocumentation/Documentation/ThreatDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TimeDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TooltipComparisonDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TooltipConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TooltipInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TooltipInfoSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ToyBoxInfoDocumentation.lua create mode 100644 APIDocumentation/Documentation/TrackingDocumentation.lua create mode 100644 APIDocumentation/Documentation/TradeDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TradeInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TradeSkillUIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TradeSkillUITypesDocumentation.lua create mode 100644 APIDocumentation/Documentation/TradeskillDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TraitConfigDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TraitConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/TransmogSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIColorDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIFileAssetSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIMacrosDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIManagerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIModelInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIModelInfoSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UISharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UISystemVisibilityManagerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UITextureAssetSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UITimerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIWidgetManagerDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UIWidgetManagerSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/URLDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UiModelSceneConstantsDocumentation.lua create mode 100644 APIDocumentation/Documentation/UivisualDocumentation.lua create mode 100644 APIDocumentation/Documentation/UncategorizedDocumentation.lua create mode 100644 APIDocumentation/Documentation/UncategorizedeventsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UnitAuraDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UnitConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UnitSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/UserFeedbackDocumentation.lua create mode 100644 APIDocumentation/Documentation/UtilityDocumentation.lua delete mode 100644 APIDocumentation/Documentation/ValidateNameConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/VectorSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/VehicleConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/VignetteConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/VignetteInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/VoiceChatDocumentation.lua create mode 100644 APIDocumentation/Documentation/VoiceDocumentation.lua delete mode 100644 APIDocumentation/Documentation/VoidStorageInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/WeeklyRewardsSharedDocumentation.lua delete mode 100644 APIDocumentation/Documentation/WoWGuidDocumentation.lua delete mode 100644 APIDocumentation/Documentation/WorldStateInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/WowEntitlementInfoDocumentation.lua delete mode 100644 APIDocumentation/Documentation/WowLabsConstantsDocumentation.lua delete mode 100644 APIDocumentation/Documentation/WowTokenUIDocumentation.lua delete mode 100644 APIDocumentation/Documentation/XMLUtilDocumentation.lua create mode 100644 APIDocumentation/Documentation/ZoneInformationDocumentation.lua diff --git a/APIDocumentation/APIDocumentation.toc b/APIDocumentation/APIDocumentation.toc index 1c3900d..59cbf88 100644 --- a/APIDocumentation/APIDocumentation.toc +++ b/APIDocumentation/APIDocumentation.toc @@ -3,7 +3,7 @@ ## Author: Blizzard Entertainment ## LoadOnDemand: 1 ## DefaultState: Enabled -## Version: 1.0.0 +## Version: 1.0.1 ## Notes: A comprehensive documentation of the Blizzard API, including constants, functions, and events. ## Notes-deDE: Eine umfassende Dokumentation der Blizzard-API, einschließlich Konstanten, Funktionen und Ereignissen. ## Notes-frFR: Une documentation complète de l'API Blizzard, y compris les constantes, les fonctions et les événements. @@ -25,311 +25,105 @@ EventsAPIMixin.lua Blizzard_APIDocumentation.lua ## Documentation files -Documentation\AccountConstantsDocumentation.lua -Documentation\AccountInfoDocumentation.lua -Documentation\AchievementInfoDocumentation.lua -Documentation\ActionBarFrameDocumentation.lua +Documentation\AchievementDocumentation.lua +Documentation\ActionbarDocumentation.lua Documentation\ActionDocumentation.lua -Documentation\AddOnsDocumentation.lua -Documentation\AdventureJournalDocumentation.lua -Documentation\AdventureMapDocumentation.lua -Documentation\AppearanceSourceDocumentation.lua -Documentation\AreaPoiInfoDocumentation.lua -Documentation\AuctionHouseConstants_ClassicDocumentation.lua -Documentation\AuctionHouseDocumentation.lua -Documentation\AuctionHouseEnumsDocumentation.lua -Documentation\AzeriteConstantsDocumentation.lua -Documentation\AzeriteEmpoweredItemDocumentation.lua -Documentation\AzeriteEssenceDocumentation.lua -Documentation\AzeriteItemDocumentation.lua -Documentation\BagConstantsDocumentation.lua -Documentation\BagIndexConstantsDocumentation.lua +Documentation\AddonRelatedDocumentation.lua +Documentation\ArenaDocumentation.lua +Documentation\AuctionDocumentation.lua +Documentation\Awesome_WotLKDocumentation.lua Documentation\BankDocumentation.lua -Documentation\BarberShopDocumentation.lua -Documentation\BaseDocumentation.lua +Documentation\BarbershopDocumentation.lua +Documentation\BattlefieldDocumentation.lua Documentation\BattleNetDocumentation.lua -Documentation\BattlePetConstantsDocumentation.lua -Documentation\BattlePetDocumentation.lua -Documentation\BehavioralMessagingDocumentation.lua -Documentation\BlackMarketInfoDocumentation.lua -Documentation\Blizzard_APIDocumentationGenerated.toc -Documentation\BountySharedDocumentation.lua -Documentation\BrowserDocumentation.lua -Documentation\BuildDocumentation.lua -Documentation\ButtonConstantsDocumentation.lua -Documentation\CalendarConstantsDocumentation.lua +Documentation\BlizzardInternalDocumentation.lua +Documentation\BuffDocumentation.lua Documentation\CalendarDocumentation.lua Documentation\CameraDocumentation.lua -Documentation\CharacterCustomizationSharedDocumentation.lua -Documentation\ChatBubblesDocumentation.lua -Documentation\ChatConstantsDocumentation.lua -Documentation\ChatInfoDocumentation.lua -Documentation\CinematicDocumentation.lua -Documentation\ClassTrialDocumentation.lua -Documentation\ClientDocumentation.lua -Documentation\ClientSceneDocumentation.lua -Documentation\ClubDocumentation.lua -Documentation\ClubSharedDocumentation.lua -Documentation\ColorDocumentation.lua -Documentation\CombatLogDocumentation.lua -Documentation\CommentatorFrameDocumentation.lua -Documentation\CommentatorSharedDocumentation.lua -Documentation\CompactUnitFramesDocumentation.lua -Documentation\ConfigurationWarningsDocumentation.lua -Documentation\ConsoleDocumentation.lua -Documentation\ConsoleScriptCollectionDocumentation.lua +Documentation\ChannelDocumentation.lua +Documentation\ChatDocumentation.lua +Documentation\ClassResourceDocumentation.lua +Documentation\ClientControlAndInformationDocumentation.lua +Documentation\CombatDocumentation.lua +Documentation\CombatlogDocumentation.lua +Documentation\CommentatorDocumentation.lua +Documentation\CompanionDocumentation.lua +Documentation\ComplaintDocumentation.lua Documentation\ContainerDocumentation.lua -Documentation\ContentTrackingTypesDocumentation.lua -Documentation\ContributionCollectorDocumentation.lua -Documentation\CooldownFrameAPIDocumentation.lua -Documentation\CraftInfoDocumentation.lua -Documentation\CreatureInfoDocumentation.lua -Documentation\CurrencyConstantsDocumentation.lua -Documentation\CurrencyConstants_ClassicDocumentation.lua -Documentation\CurrencyInfoDocumentation.lua -Documentation\CursorConstDocumentation.lua +Documentation\CurrencyDocumentation.lua Documentation\CursorDocumentation.lua -Documentation\CVarDocumentation.lua -Documentation\DamageConstantsDocumentation.lua -Documentation\DateAndTimeDocumentation.lua -Documentation\DeathInfoDocumentation.lua -Documentation\DuelInfoDocumentation.lua -Documentation\EditModeManagerDocumentation.lua -Documentation\EditModeManagerSharedDocumentation.lua -Documentation\EncounterInfoDocumentation.lua -Documentation\EncounterJournalConstantsDocumentation.lua +Documentation\CvarDocumentation.lua +Documentation\DebuggingAndProfilingDocumentation.lua +Documentation\DeprecatedDocumentation.lua +Documentation\DuelDocumentation.lua Documentation\EquipmentManagerDocumentation.lua -Documentation\EventUtilsDocumentation.lua -Documentation\ExpansionDocumentation.lua -Documentation\ExpansionLandingPageConstantsDocumentation.lua -Documentation\FogOfWarDocumentation.lua -Documentation\FontDocumentation.lua -Documentation\FrameAPICharacterModelBaseDocumentation.lua -Documentation\FrameAPICinematicModelDocumentation.lua -Documentation\FrameAPICooldownDocumentation.lua -Documentation\FrameAPIDressUpModelDocumentation.lua -Documentation\FrameAPIFogOfWarFrameDocumentation.lua -Documentation\FrameAPIModelSceneFrameDocumentation.lua -Documentation\FrameAPIModelSceneFrameSharedDocumentation.lua -Documentation\FrameAPISimpleCheckoutDocumentation.lua -Documentation\FrameAPITabardModelBaseDocumentation.lua -Documentation\FrameAPITabardModelDocumentation.lua -Documentation\FrameAPIUnitPositionFrameDocumentation.lua -Documentation\FrameScriptDocumentation.lua -Documentation\FriendListDocumentation.lua -Documentation\GamePadConstDocumentation.lua -Documentation\GamePadDocumentation.lua -Documentation\GameRulesDocumentation.lua -Documentation\GarrisonConstantsDocumentation.lua -Documentation\GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua -Documentation\GARRISON_TYPEConstantsDocumentation.lua -Documentation\GlueDocumentation.lua -Documentation\GlyphInfoDocumentation.lua -Documentation\GMTicketInfoDocumentation.lua -Documentation\GossipConstantsDocumentation.lua -Documentation\GossipInfoDocumentation.lua +Documentation\ExperienceXpDocumentation.lua +Documentation\FactionDocumentation.lua +Documentation\GlyphDocumentation.lua +Documentation\GmSurveyDocumentation.lua +Documentation\GmTicketDocumentation.lua Documentation\GuildBankDocumentation.lua -Documentation\GuildInfoDocumentation.lua -Documentation\GuildInfoSharedDocumentation.lua -Documentation\HeirloomInfoDocumentation.lua -Documentation\InputConstantsDocumentation.lua -Documentation\InputDocumentation.lua -Documentation\InstanceEncounterDocumentation.lua -Documentation\ItemConstantsDocumentation.lua -Documentation\ItemConstants_ClassicDocumentation.lua +Documentation\GuildDocumentation.lua +Documentation\HyperlinkDocumentation.lua +Documentation\InGameMoviePlaybackDocumentation.lua +Documentation\InspectDocumentation.lua +Documentation\InstanceDocumentation.lua +Documentation\InventoryDocumentation.lua Documentation\ItemDocumentation.lua -Documentation\ItemLocationSharedDocumentation.lua -Documentation\ItemSharedDocumentation.lua -Documentation\ItemSocketInfoDocumentation.lua Documentation\ItemTextDocumentation.lua -Documentation\ItemUpgradeDocumentation.lua -Documentation\KeyBindingsDocumentation.lua +Documentation\KeybindDocumentation.lua +Documentation\KeyboardDocumentation.lua Documentation\KnowledgeBaseDocumentation.lua -Documentation\LevelConstantsDocumentation.lua -Documentation\LFGConstantsDocumentation.lua -Documentation\LFGInfoDocumentation.lua -Documentation\LFGListInfoDocumentation.lua -Documentation\LoadingScreenDocumentation.lua -Documentation\LocaleDocumentation.lua -Documentation\LocalizationDocumentation.lua -Documentation\LootConstantsDocumentation.lua +Documentation\LimitedPlayTimeDocumentation.lua +Documentation\LocaleSpecificDocumentation.lua +Documentation\LookingForGroupDocumentation.lua Documentation\LootDocumentation.lua -Documentation\LossOfControlDocumentation.lua -Documentation\MailInfoDocumentation.lua -Documentation\MapConstantsDocumentation.lua +Documentation\LuaLibraryDocumentation.lua +Documentation\MacClientDocumentation.lua +Documentation\MacroDocumentation.lua +Documentation\MailDocumentation.lua Documentation\MapDocumentation.lua -Documentation\MapExplorationDocumentation.lua -Documentation\MerchantFrameDocumentation.lua -Documentation\MinimapConstantsDocumentation.lua -Documentation\MinimapDocumentation.lua -Documentation\MinimapFrameAPIDocumentation.lua -Documentation\ModelSceneDocumentation.lua -Documentation\MovieDocumentation.lua -Documentation\NamePlateDocumentation.lua -Documentation\NamePlateManagerDocumentation.lua -Documentation\NewItemsDocumentation.lua -Documentation\OsDocumentation.lua -Documentation\PaperDollInfoDocumentation.lua -Documentation\ParentalControlsDocumentation.lua -Documentation\PartyInfoDocumentation.lua -Documentation\PartyPoseUIDocumentation.lua -Documentation\PerksVendorConstantsDocumentation.lua -Documentation\PetBattleConstantsDocumentation.lua -Documentation\PetInfoDocumentation.lua -Documentation\PetJournalInfoDocumentation.lua -Documentation\PetScalingConstantsDocumentation.lua -Documentation\PingConstantsDocumentation.lua -Documentation\PlatformDocumentation.lua -Documentation\PlayerDocumentation.lua -Documentation\PlayerInfoDocumentation.lua -Documentation\PlayerInfoSharedDocumentation.lua -Documentation\PlayerInteractionManagerConstantsDocumentation.lua -Documentation\PlayerInteractionManagerDocumentation.lua -Documentation\PlayerLocationDocumentation.lua -Documentation\PlayerMentorshipConstantsDocumentation.lua -Documentation\PortraitDocumentation.lua -Documentation\ProfessionConstantsDocumentation.lua -Documentation\PvPFactionConstantsDocumentation.lua -Documentation\PvpInfoConstantsDocumentation.lua -Documentation\PvpInfoDocumentation.lua -Documentation\PVPMgrConstantsDocumentation.lua -Documentation\QuestConstantsDocumentation.lua -Documentation\QuestConstants_ClassicDocumentation.lua -Documentation\QuestInfoSystemDocumentation.lua -Documentation\QuestLineInfoDocumentation.lua -Documentation\QuestLogDocumentation.lua -Documentation\QuestOfferDocumentation.lua -Documentation\QuestRewardsDocumentation.lua -Documentation\QuestSessionConstantsDocumentation.lua -Documentation\QuestSessionDocumentation.lua -Documentation\QuestTaskInfoDocumentation.lua -Documentation\QueueSpecificDocumentation.lua -Documentation\RaidLocksDocumentation.lua -Documentation\RecruitAFriendSharedDocumentation.lua -Documentation\ReportSystemConstantsDocumentation.lua -Documentation\ReportSystemDocumentation.lua -Documentation\ReputationInfoDocumentation.lua -Documentation\RestrictedActionsDocumentation.lua -Documentation\ScreenDocumentation.lua -Documentation\ScriptedAnimationsDocumentation.lua -Documentation\ScriptRegionSharedDocumentation.lua -Documentation\ScriptWarningsDocumentation.lua -Documentation\SeasonsConstantsDocumentation.lua -Documentation\SeasonsDocumentation.lua -Documentation\SecureTransferDocumentation.lua -Documentation\SharedScriptObjectModelLightDocumentation.lua -Documentation\SharedScriptObjectUnitPositionFrameDocumentation.lua -Documentation\SharedTraitsDocumentation.lua -Documentation\SharedTraitsEnumsDocumentation.lua -Documentation\SimpleAnimAlphaAPIDocumentation.lua -Documentation\SimpleAnimAPIDocumentation.lua -Documentation\SimpleAnimatableObjectAPIDocumentation.lua -Documentation\SimpleAnimFlipBookAPIDocumentation.lua -Documentation\SimpleAnimGroupAPIDocumentation.lua -Documentation\SimpleAnimPathAPIDocumentation.lua -Documentation\SimpleAnimRotationAPIDocumentation.lua -Documentation\SimpleAnimScaleAPIDocumentation.lua -Documentation\SimpleAnimScaleLineAPIDocumentation.lua -Documentation\SimpleAnimTextureCoordTranslationAPIDocumentation.lua -Documentation\SimpleAnimTranslationAPIDocumentation.lua -Documentation\SimpleAnimTranslationLineAPIDocumentation.lua -Documentation\SimpleBrowserAPIDocumentation.lua -Documentation\SimpleButtonAPIDocumentation.lua -Documentation\SimpleCheckboxAPIDocumentation.lua -Documentation\SimpleColorSelectAPIDocumentation.lua -Documentation\SimpleControlPointAPIDocumentation.lua -Documentation\SimpleEditBoxAPIDocumentation.lua -Documentation\SimpleFontAPIDocumentation.lua -Documentation\SimpleFontStringAPIDocumentation.lua -Documentation\SimpleFrameAPIDocumentation.lua -Documentation\SimpleFrameScriptObjectAPIDocumentation.lua -Documentation\SimpleHTMLAPIDocumentation.lua -Documentation\SimpleHTMLSharedDocumentation.lua -Documentation\SimpleLineAPIDocumentation.lua -Documentation\SimpleMaskTextureAPIDocumentation.lua -Documentation\SimpleMessageFrameAPIDocumentation.lua -Documentation\SimpleModelAPIDocumentation.lua -Documentation\SimpleModelFFXAPIDocumentation.lua -Documentation\SimpleMovieAPIDocumentation.lua -Documentation\SimpleObjectAPIDocumentation.lua -Documentation\SimpleOffScreenFrameAPIDocumentation.lua -Documentation\SimpleRegionAPIDocumentation.lua -Documentation\SimpleScriptRegionAPIDocumentation.lua -Documentation\SimpleScriptRegionResizingAPIDocumentation.lua -Documentation\SimpleScrollFrameAPIDocumentation.lua -Documentation\SimpleSliderAPIDocumentation.lua -Documentation\SimpleStatusBarAPIDocumentation.lua -Documentation\SimpleTextureAPIDocumentation.lua -Documentation\SimpleTextureBaseAPIDocumentation.lua -Documentation\SkillInfoDocumentation.lua -Documentation\SocialInfoDocumentation.lua -Documentation\SocialQueueDocumentation.lua -Documentation\SocialRestrictionsDocumentation.lua -Documentation\SoftTargetConstantsDocumentation.lua +Documentation\MerchantDocumentation.lua +Documentation\MinigameDocumentation.lua +Documentation\ModifiedClickDocumentation.lua +Documentation\MoneyDocumentation.lua +Documentation\MovementDocumentation.lua +Documentation\MultiCastActionsDocumentation.lua +Documentation\NpcGossipDialogDocumentation.lua +Documentation\ObjectivesTrackingDocumentation.lua +Documentation\PartyDocumentation.lua +Documentation\PetDocumentation.lua +Documentation\PetitionDocumentation.lua +Documentation\PetStableDocumentation.lua +Documentation\PlayerInformationDocumentation.lua +Documentation\PvpDocumentation.lua +Documentation\QuestDocumentation.lua +Documentation\RaidDocumentation.lua +Documentation\RecruitAFriendDocumentation.lua +Documentation\SecureExecutionUtilityDocumentation.lua +Documentation\SkillDocumentation.lua +Documentation\SocialDocumentation.lua +Documentation\SocketingDocumentation.lua Documentation\SoundDocumentation.lua -Documentation\SpecializationInfoDocumentation.lua -Documentation\SpecializationSharedDocumentation.lua -Documentation\SpellActivationOverlayDocumentation.lua -Documentation\SpellBookDocumentation.lua Documentation\SpellDocumentation.lua -Documentation\StableInfoDocumentation.lua -Documentation\StorePublicUIDocumentation.lua -Documentation\StringUtilDocumentation.lua -Documentation\SummonInfoDocumentation.lua -Documentation\SystemDocumentation.lua -Documentation\SystemTimeDocumentation.lua -Documentation\TaxiMapDocumentation.lua -Documentation\TextureSharedDocumentation.lua -Documentation\TextureUtilsDocumentation.lua -Documentation\TimeDocumentation.lua -Documentation\TooltipComparisonDocumentation.lua -Documentation\TooltipConstantsDocumentation.lua -Documentation\TooltipInfoDocumentation.lua -Documentation\TooltipInfoSharedDocumentation.lua -Documentation\ToyBoxInfoDocumentation.lua -Documentation\TradeInfoDocumentation.lua -Documentation\TradeSkillUIDocumentation.lua -Documentation\TradeSkillUITypesDocumentation.lua +Documentation\StanceshapeshiftDocumentation.lua +Documentation\StatInformationDocumentation.lua +Documentation\SummoningDocumentation.lua +Documentation\TalentDocumentation.lua +Documentation\TargetingDocumentation.lua +Documentation\TaxiflightDocumentation.lua +Documentation\ThreatDocumentation.lua +Documentation\TrackingDocumentation.lua +Documentation\TradeDocumentation.lua +Documentation\TradeskillDocumentation.lua Documentation\TrainerDocumentation.lua -Documentation\TraitConfigDocumentation.lua -Documentation\TraitConstantsDocumentation.lua -Documentation\TransmogSharedDocumentation.lua -Documentation\TTSSettingsDocumentation.lua Documentation\TutorialDocumentation.lua -Documentation\UIColorDocumentation.lua -Documentation\UIFileAssetSharedDocumentation.lua -Documentation\UIGenericWidgetDisplayDocumentation.lua -Documentation\UIMacrosDocumentation.lua -Documentation\UIManagerDocumentation.lua -Documentation\UIModelInfoDocumentation.lua -Documentation\UIModelInfoSharedDocumentation.lua -Documentation\UiModelSceneConstantsDocumentation.lua -Documentation\UISharedDocumentation.lua -Documentation\UISystemVisibilityManagerDocumentation.lua -Documentation\UITextureAssetSharedDocumentation.lua -Documentation\UITimerDocumentation.lua -Documentation\UIWidgetManagerDocumentation.lua -Documentation\UIWidgetManagerSharedDocumentation.lua -Documentation\UnitAuraDocumentation.lua -Documentation\UnitConstantsDocumentation.lua +Documentation\UivisualDocumentation.lua +Documentation\UncategorizedDocumentation.lua +Documentation\UncategorizedeventsDocumentation.lua Documentation\UnitDocumentation.lua -Documentation\UnitSexConstantsDocumentation.lua -Documentation\UnitSharedDocumentation.lua -Documentation\URLDocumentation.lua -Documentation\UserFeedbackDocumentation.lua -Documentation\ValidateNameConstantsDocumentation.lua -Documentation\VectorSharedDocumentation.lua -Documentation\VehicleConstantsDocumentation.lua +Documentation\UtilityDocumentation.lua Documentation\VehicleDocumentation.lua Documentation\VideoDocumentation.lua -Documentation\VignetteConstantsDocumentation.lua -Documentation\VignetteInfoDocumentation.lua -Documentation\VoiceChatDocumentation.lua -Documentation\VoidStorageInfoDocumentation.lua -Documentation\WeeklyRewardsSharedDocumentation.lua -Documentation\WorldStateInfoDocumentation.lua -Documentation\WowEntitlementInfoDocumentation.lua -Documentation\WoWGuidDocumentation.lua -Documentation\WowLabsConstantsDocumentation.lua -Documentation\WowTokenUIDocumentation.lua -Documentation\XMLUtilDocumentation.lua +Documentation\VoiceDocumentation.lua +Documentation\ZoneInformationDocumentation.lua diff --git a/APIDocumentation/Documentation/AccountConstantsDocumentation.lua b/APIDocumentation/Documentation/AccountConstantsDocumentation.lua deleted file mode 100644 index 30c2c66..0000000 --- a/APIDocumentation/Documentation/AccountConstantsDocumentation.lua +++ /dev/null @@ -1,115 +0,0 @@ -local AccountConstants = -{ - Tables = - { - { - Name = "AccountData", - Type = "Enumeration", - NumValues = 15, - MinValue = 0, - MaxValue = 14, - 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 = "AccountDataUpdateStatus", - Type = "Enumeration", - NumValues = 4, - MinValue = 0, - MaxValue = 3, - Fields = - { - { Name = "AccountDataUpdateSuccess", Type = "AccountDataUpdateStatus", EnumValue = 0 }, - { Name = "AccountDataUpdateFailed", Type = "AccountDataUpdateStatus", EnumValue = 1 }, - { Name = "AccountDataUpdateCorrupt", Type = "AccountDataUpdateStatus", EnumValue = 2 }, - { Name = "AccountDataUpdateToobig", 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 = "AccountStateFlags", - Type = "Enumeration", - NumValues = 34, - MinValue = 0, - MaxValue = 1073741824, - Fields = - { - { Name = "None", Type = "AccountStateFlags", EnumValue = 0 }, - { Name = "AchievementsLoaded", Type = "AccountStateFlags", EnumValue = 1 }, - { Name = "CriteriaLoaded", Type = "AccountStateFlags", EnumValue = 2 }, - { Name = "MountsLoaded", Type = "AccountStateFlags", EnumValue = 4 }, - { Name = "PetjournalInitialized", Type = "AccountStateFlags", EnumValue = 8 }, - { Name = "CurrencyCapsLoaded", Type = "AccountStateFlags", EnumValue = 16 }, - { Name = "LoadFailed", Type = "AccountStateFlags", EnumValue = 32 }, - { Name = "QuestLogLoaded", Type = "AccountStateFlags", EnumValue = 64 }, - { Name = "InPetCombat", Type = "AccountStateFlags", EnumValue = 128 }, - { Name = "CharactersLoaded", Type = "AccountStateFlags", EnumValue = 256 }, - { Name = "PurchasesLoaded", Type = "AccountStateFlags", EnumValue = 512 }, - { Name = "BpayDistributionObjectsLoaded", Type = "AccountStateFlags", EnumValue = 1024 }, - { Name = "ArchivedPurchasesLoaded", Type = "AccountStateFlags", EnumValue = 2048 }, - { Name = "SettingsLoaded", Type = "AccountStateFlags", EnumValue = 4096 }, - { Name = "BpayAddLicenseObjectsLoaded", Type = "AccountStateFlags", EnumValue = 8192 }, - { Name = "ItemCollectionsLoaded", Type = "AccountStateFlags", EnumValue = 16384 }, - { Name = "AuctionableTokensLoaded", Type = "AccountStateFlags", EnumValue = 32768 }, - { Name = "ConsumableTokensLoaded", Type = "AccountStateFlags", EnumValue = 65536 }, - { Name = "PerkTablesLoaded", Type = "AccountStateFlags", EnumValue = 131072 }, - { Name = "VasTransactionsLoaded", Type = "AccountStateFlags", EnumValue = 262144 }, - { Name = "BpayProductitemObjectsLoaded", Type = "AccountStateFlags", EnumValue = 524288 }, - { Name = "TrialBoostHistoryLoaded", Type = "AccountStateFlags", EnumValue = 1048576 }, - { Name = "QuestCriteriaLoaded", Type = "AccountStateFlags", EnumValue = 2097152 }, - { Name = "BattleNetAccountLoaded", Type = "AccountStateFlags", EnumValue = 4194304 }, - { Name = "AccountCurrenciesLoaded", Type = "AccountStateFlags", EnumValue = 8388608 }, - { Name = "RafBalanceLoaded", Type = "AccountStateFlags", EnumValue = 16777216 }, - { Name = "RafRewardsLoaded", Type = "AccountStateFlags", EnumValue = 33554432 }, - { Name = "DynamicCriteriaLoaded", Type = "AccountStateFlags", EnumValue = 67108864 }, - { Name = "RafActivityLoaded", Type = "AccountStateFlags", EnumValue = 134217728 }, - { Name = "RafFriendMonthsLoaded", Type = "AccountStateFlags", EnumValue = 268435456 }, - { Name = "RevokedRafRewardsLoaded", Type = "AccountStateFlags", EnumValue = 536870912 }, - { Name = "AccountNotificationsLoaded", Type = "AccountStateFlags", EnumValue = 1073741824 }, - { Name = "AccountWowlabsLoaded", Type = "AccountStateFlags", EnumValue = 0 }, - { Name = "AccountUpgradeComplete", Type = "AccountStateFlags", EnumValue = 0 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(AccountConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AccountInfoDocumentation.lua b/APIDocumentation/Documentation/AccountInfoDocumentation.lua deleted file mode 100644 index c0dee9e..0000000 --- a/APIDocumentation/Documentation/AccountInfoDocumentation.lua +++ /dev/null @@ -1,62 +0,0 @@ -local AccountInfo = -{ - Name = "AccountInfo", - Type = "System", - Namespace = "C_AccountInfo", - - Functions = - { - { - Name = "GetIDFromBattleNetAccountGUID", - Type = "Function", - - Arguments = - { - { Name = "battleNetAccountGUID", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "battleNetAccountID", Type = "number", Nilable = false }, - }, - }, - { - Name = "IsGUIDBattleNetAccountType", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "isBNet", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsGUIDRelatedToLocalAccount", - Type = "Function", - - 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/APIDocumentation/Documentation/AchievementDocumentation.lua b/APIDocumentation/Documentation/AchievementDocumentation.lua new file mode 100644 index 0000000..066e8da --- /dev/null +++ b/APIDocumentation/Documentation/AchievementDocumentation.lua @@ -0,0 +1,492 @@ +local Achievement = +{ + Name = "Achievement", + Type = "System", + Namespace = "Achievement", + + Functions = + { + { + Name = "AddTrackedAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CanShowAchievementUI", + Type = "Function", + + Returns = + { + { Name = "canShow", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearAchievementComparisonUnit", + Type = "Function", + + }, + { + Name = "GetAchievementCategory", + Type = "Function", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "categoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAchievementComparisonInfo", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAchievementCriteriaInfo", + Type = "Function", + + Arguments = + { + { Name = "achievementID", Type = "number", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "statisticID", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false }, + { Name = "type", Type = "number", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "requiredQuantity", Type = "number", Nilable = false }, + { Name = "characterName", Type = "string", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + { Name = "assetID", Type = "number", Nilable = false }, + { Name = "quantityString", Type = "string", Nilable = false }, + { Name = "criteriaID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAchievementInfo", + Type = "Function", + + Arguments = + { + { Name = "category", Type = "number", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "id", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "points", Type = "number", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "rewardText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAchievementInfoFromCriteria", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "points", Type = "number", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "rewardText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAchievementLink", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAchievementNumCriteria", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAchievementNumRewards", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAchievementReward", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "points", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCategoryInfo", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "parentID", Type = "number", Nilable = false }, + { Name = "flags", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCategoryList", + Type = "Function", + + Returns = + { + { Name = "categories", Type = "table", Nilable = false }, + }, + }, + { + Name = "GetCategoryNumAchievements", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "numCompleted", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetComparisonAchievementPoints", + Type = "Function", + + Returns = + { + { Name = "points", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetComparisonCategoryNumAchievements", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numCompleted", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetComparisonStatistic", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetLatestCompletedAchievements", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetLatestCompletedComparisonAchievements", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetLatestUpdatedComparisonStats", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetLatestUpdatedStats", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetNextAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nextID", Type = "number", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNumComparisonCompletedAchievements", + Type = "Function", + + Returns = + { + { Name = "total", Type = "number", Nilable = false }, + { Name = "completed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumCompletedAchievements", + Type = "Function", + + Returns = + { + { Name = "total", Type = "number", Nilable = false }, + { Name = "completed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTrackedAchievements", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPreviousAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "previousID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStatistic", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetStatisticsCategoryList", + Type = "Function", + + Returns = + { + { Name = "categories", Type = "table", Nilable = false }, + }, + }, + { + Name = "GetTotalAchievementPoints", + Type = "Function", + + Returns = + { + { Name = "points", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrackedAchievements", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "IsTrackedAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveTrackedAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetAchievementComparisonUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AchievementEarned", + Type = "Event", + LiteralName = "ACHIEVEMENT_EARNED", + }, + { + Name = "ChatMsgAchievement", + Type = "Event", + LiteralName = "CHAT_MSG_ACHIEVEMENT", + }, + { + Name = "ChatMsgGuildAchievement", + Type = "Event", + LiteralName = "CHAT_MSG_GUILD_ACHIEVEMENT", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + }, + }, + { + Name = "InspectAchievementReady", + Type = "Event", + LiteralName = "INSPECT_ACHIEVEMENT_READY", + }, + { + Name = "ReceivedAchievementList", + Type = "Event", + LiteralName = "RECEIVED_ACHIEVEMENT_LIST", + }, + { + Name = "TrackedAchievementUpdate", + Type = "Event", + LiteralName = "TRACKED_ACHIEVEMENT_UPDATE", + Payload = + { + { Name = "achievementId", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Achievement); diff --git a/APIDocumentation/Documentation/AchievementInfoDocumentation.lua b/APIDocumentation/Documentation/AchievementInfoDocumentation.lua deleted file mode 100644 index 0733eda..0000000 --- a/APIDocumentation/Documentation/AchievementInfoDocumentation.lua +++ /dev/null @@ -1,164 +0,0 @@ -local AchievementInfo = -{ - Name = "AchievementInfo", - Type = "System", - Namespace = "C_AchievementInfo", - - Functions = - { - { - Name = "GetRewardItemID", - Type = "Function", - - Arguments = - { - { Name = "achievementID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "rewardItemID", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetSupercedingAchievements", - Type = "Function", - - Arguments = - { - { Name = "achievementID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "supercedingAchievements", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "IsValidAchievement", - Type = "Function", - - Arguments = - { - { Name = "achievementId", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isValidAchievement", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetPortraitTexture", - Type = "Function", - - Arguments = - { - { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AchievementEarned", - Type = "Event", - LiteralName = "ACHIEVEMENT_EARNED", - Payload = - { - { Name = "achievementID", Type = "number", Nilable = false }, - { Name = "alreadyEarned", Type = "bool", Nilable = true }, - }, - }, - { - Name = "AchievementPlayerName", - Type = "Event", - LiteralName = "ACHIEVEMENT_PLAYER_NAME", - Payload = - { - { Name = "achievementID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AchievementSearchUpdated", - Type = "Event", - LiteralName = "ACHIEVEMENT_SEARCH_UPDATED", - }, - { - Name = "CriteriaComplete", - Type = "Event", - LiteralName = "CRITERIA_COMPLETE", - Payload = - { - { Name = "criteriaID", Type = "number", Nilable = false }, - }, - }, - { - Name = "CriteriaEarned", - Type = "Event", - LiteralName = "CRITERIA_EARNED", - Payload = - { - { Name = "achievementID", Type = "number", Nilable = false }, - { Name = "description", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "CriteriaUpdate", - Type = "Event", - LiteralName = "CRITERIA_UPDATE", - }, - { - Name = "InspectAchievementReady", - Type = "Event", - LiteralName = "INSPECT_ACHIEVEMENT_READY", - Payload = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "ReceivedAchievementList", - Type = "Event", - LiteralName = "RECEIVED_ACHIEVEMENT_LIST", - }, - { - Name = "ReceivedAchievementMemberList", - Type = "Event", - LiteralName = "RECEIVED_ACHIEVEMENT_MEMBER_LIST", - Payload = - { - { Name = "achievementID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TrackedAchievementListChanged", - Type = "Event", - LiteralName = "TRACKED_ACHIEVEMENT_LIST_CHANGED", - Payload = - { - { Name = "achievementID", Type = "number", Nilable = true }, - { Name = "added", Type = "bool", Nilable = true }, - }, - }, - { - Name = "TrackedAchievementUpdate", - Type = "Event", - LiteralName = "TRACKED_ACHIEVEMENT_UPDATE", - 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/APIDocumentation/Documentation/ActionBarFrameDocumentation.lua b/APIDocumentation/Documentation/ActionBarFrameDocumentation.lua deleted file mode 100644 index 793889e..0000000 --- a/APIDocumentation/Documentation/ActionBarFrameDocumentation.lua +++ /dev/null @@ -1,267 +0,0 @@ -local ActionBarFrame = -{ - Name = "ActionBar", - Type = "System", - Namespace = "C_ActionBar", - - Functions = - { - { - Name = "FindPetActionButtons", - Type = "Function", - - Arguments = - { - { Name = "petActionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, - }, - }, - { - Name = "FindSpellActionButtons", - Type = "Function", - - Arguments = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, - }, - }, - { - Name = "GetPetActionPetBarIndices", - Type = "Function", - - Arguments = - { - { Name = "petActionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "slots", Type = "table", InnerType = "luaIndex", Nilable = false }, - }, - }, - { - Name = "HasPetActionButtons", - Type = "Function", - - Arguments = - { - { Name = "petActionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasPetActionButtons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HasPetActionPetBarIndices", - Type = "Function", - - Arguments = - { - { Name = "petActionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasPetActionPetBarIndices", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HasSpellActionButtons", - Type = "Function", - - Arguments = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasSpellActionButtons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsAutoCastPetAction", - Type = "Function", - - Arguments = - { - { Name = "slotID", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isAutoCastPetAction", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsEnabledAutoCastPetAction", - Type = "Function", - - Arguments = - { - { Name = "slotID", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isEnabledAutoCastPetAction", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsHarmfulAction", - Type = "Function", - - Arguments = - { - { Name = "actionID", Type = "luaIndex", Nilable = false }, - { Name = "useNeutral", Type = "bool", Nilable = false }, - }, - - Returns = - { - { Name = "isHarmful", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsHelpfulAction", - Type = "Function", - - Arguments = - { - { Name = "actionID", Type = "luaIndex", Nilable = false }, - { Name = "useNeutral", Type = "bool", Nilable = false }, - }, - - Returns = - { - { Name = "isHelpful", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsOnBarOrSpecialBar", - Type = "Function", - - Arguments = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isOnBarOrSpecialBar", Type = "bool", 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", - - Arguments = - { - { Name = "slotID", Type = "luaIndex", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "ActionbarHidegrid", - Type = "Event", - LiteralName = "ACTIONBAR_HIDEGRID", - }, - { - Name = "ActionbarPageChanged", - Type = "Event", - LiteralName = "ACTIONBAR_PAGE_CHANGED", - }, - { - Name = "ActionbarShowBottomleft", - Type = "Event", - LiteralName = "ACTIONBAR_SHOW_BOTTOMLEFT", - }, - { - Name = "ActionbarShowgrid", - Type = "Event", - LiteralName = "ACTIONBAR_SHOWGRID", - }, - { - Name = "ActionbarSlotChanged", - Type = "Event", - LiteralName = "ACTIONBAR_SLOT_CHANGED", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, - { - Name = "ActionbarUpdateCooldown", - Type = "Event", - LiteralName = "ACTIONBAR_UPDATE_COOLDOWN", - }, - { - Name = "ActionbarUpdateState", - Type = "Event", - LiteralName = "ACTIONBAR_UPDATE_STATE", - }, - { - Name = "ActionbarUpdateUsable", - Type = "Event", - LiteralName = "ACTIONBAR_UPDATE_USABLE", - }, - { - Name = "PetBarUpdate", - Type = "Event", - LiteralName = "PET_BAR_UPDATE", - }, - { - Name = "UpdateBonusActionbar", - Type = "Event", - LiteralName = "UPDATE_BONUS_ACTIONBAR", - }, - { - Name = "UpdateMultiCastActionbar", - Type = "Event", - LiteralName = "UPDATE_MULTI_CAST_ACTIONBAR", - }, - { - Name = "UpdateOverrideActionbar", - Type = "Event", - LiteralName = "UPDATE_OVERRIDE_ACTIONBAR", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ActionBarFrame); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ActionDocumentation.lua b/APIDocumentation/Documentation/ActionDocumentation.lua index d120575..2ee28f6 100644 --- a/APIDocumentation/Documentation/ActionDocumentation.lua +++ b/APIDocumentation/Documentation/ActionDocumentation.lua @@ -1,8 +1,397 @@ local Action = { + Name = "Action", + Type = "System", + Namespace = "Action", + + Functions = + { + { + Name = "ActionHasRange", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CastPetAction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + }, + { + Name = "GetActionAutocast", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "autocastAllowed", Type = "bool", Nilable = false }, + { Name = "autocastEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetActionCooldown", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActionCount", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActionInfo", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "subType", Type = "string", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActionText", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActionTexture", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPetActionCooldown", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetActionInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subtext", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "isToken", Type = "bool", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "autoCastAllowed", Type = "bool", Nilable = false }, + { Name = "autoCastEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPetActionSlotUsable", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "usable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPetActionsUsable", + Type = "Function", + + Returns = + { + { Name = "petActionsUsable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hasAction", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsActionInRange", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "inRange", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsAttackAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoRepeatAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isRepeating", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConsumableAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isConsumable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrentAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCurrent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStackableAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isStackable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsableAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "notEnoughMana", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupPetAction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "PlaceAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "TogglePetAutocast", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "UseAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "button", Type = "string", Nilable = true }, + }, + + }, + }, + + Events = + { + { + Name = "AddonActionBlocked", + Type = "Event", + LiteralName = "ADDON_ACTION_BLOCKED", + }, + { + Name = "AddonActionForbidden", + Type = "Event", + LiteralName = "ADDON_ACTION_FORBIDDEN", + Payload = + { + { Name = "culprit", Type = "string", Nilable = false }, + }, + }, + { + Name = "MacroActionBlocked", + Type = "Event", + LiteralName = "MACRO_ACTION_BLOCKED", + }, + { + Name = "MacroActionForbidden", + Type = "Event", + LiteralName = "MACRO_ACTION_FORBIDDEN", + }, + }, + Tables = { }, }; -APIDocumentation:AddDocumentationTable(Action); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Action); diff --git a/APIDocumentation/Documentation/ActionbarDocumentation.lua b/APIDocumentation/Documentation/ActionbarDocumentation.lua new file mode 100644 index 0000000..1507120 --- /dev/null +++ b/APIDocumentation/Documentation/ActionbarDocumentation.lua @@ -0,0 +1,147 @@ +local Actionbar = +{ + Name = "ActionBar", + Type = "System", + Namespace = "ActionBar", + + Functions = + { + { + Name = "ChangeActionBarPage", + Type = "Function", + + Arguments = + { + { Name = "page", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetActionBarPage", + Type = "Function", + + Returns = + { + { Name = "page", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActionBarToggles", + Type = "Function", + + Returns = + { + { Name = "showBar1", Type = "bool", Nilable = false }, + { Name = "showBar2", Type = "bool", Nilable = false }, + { Name = "showBar3", Type = "bool", Nilable = false }, + { Name = "showBar4", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBonusBarOffset", + Type = "Function", + + Returns = + { + { Name = "offset", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPossessInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsPossessBarVisible", + Type = "Function", + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetActionBarToggles", + Type = "Function", + + Arguments = + { + { Name = "bar1", Type = "1nil", Nilable = false }, + { Name = "bar2", Type = "1nil", Nilable = false }, + { Name = "bar3", Type = "1nil", Nilable = false }, + { Name = "bar4", Type = "1nil", Nilable = false }, + { Name = "alwaysShow", Type = "1nil", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "ActionbarHidegrid", + Type = "Event", + LiteralName = "ACTIONBAR_HIDEGRID", + }, + { + Name = "ActionbarPageChanged", + Type = "Event", + LiteralName = "ACTIONBAR_PAGE_CHANGED", + }, + { + Name = "ActionbarShowgrid", + Type = "Event", + LiteralName = "ACTIONBAR_SHOWGRID", + }, + { + Name = "ActionbarSlotChanged", + Type = "Event", + LiteralName = "ACTIONBAR_SLOT_CHANGED", + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "ActionbarUpdateCooldown", + Type = "Event", + LiteralName = "ACTIONBAR_UPDATE_COOLDOWN", + }, + { + Name = "ActionbarUpdateState", + Type = "Event", + LiteralName = "ACTIONBAR_UPDATE_STATE", + }, + { + Name = "ActionbarUpdateUsable", + Type = "Event", + LiteralName = "ACTIONBAR_UPDATE_USABLE", + }, + { + Name = "UpdateBonusActionbar", + Type = "Event", + LiteralName = "UPDATE_BONUS_ACTIONBAR", + }, + { + Name = "UpdateMultiCastActionbar", + Type = "Event", + LiteralName = "UPDATE_MULTI_CAST_ACTIONBAR", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Actionbar); diff --git a/APIDocumentation/Documentation/AddOnsDocumentation.lua b/APIDocumentation/Documentation/AddOnsDocumentation.lua deleted file mode 100644 index d0c099a..0000000 --- a/APIDocumentation/Documentation/AddOnsDocumentation.lua +++ /dev/null @@ -1,63 +0,0 @@ -local AddOns = -{ - Name = "AddOns", - Type = "System", - Namespace = "C_AddOns", - - Functions = - { - { - Name = "GetAddOnMetadata", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "uiAddon", Nilable = false }, - { Name = "variable", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "value", Type = "cstring", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AddonLoaded", - Type = "Event", - LiteralName = "ADDON_LOADED", - Payload = - { - { Name = "addOnName", Type = "cstring", Nilable = false }, - { Name = "containsBindings", Type = "bool", Nilable = false }, - }, - }, - { - Name = "AddonsUnloading", - Type = "Event", - LiteralName = "ADDONS_UNLOADING", - Payload = - { - { Name = "closingClient", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SavedVariablesTooLarge", - Type = "Event", - LiteralName = "SAVED_VARIABLES_TOO_LARGE", - Payload = - { - { Name = "addOnName", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(AddOns); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AddonRelatedDocumentation.lua b/APIDocumentation/Documentation/AddonRelatedDocumentation.lua new file mode 100644 index 0000000..84bb903 --- /dev/null +++ b/APIDocumentation/Documentation/AddonRelatedDocumentation.lua @@ -0,0 +1,207 @@ +local AddonRelated = +{ + Name = "Addon-related", + Type = "System", + Namespace = "Addon-related", + + Functions = + { + { + Name = "DisableAddOn", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "DisableAllAddOns", + Type = "Function", + + }, + { + Name = "EnableAddOn", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "EnableAllAddOns", + Type = "Function", + + }, + { + Name = "GetAddOnDependencies", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetAddOnInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "notes", Type = "string", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "loadable", Type = "bool", Nilable = false }, + { Name = "reason", Type = "string", Nilable = false }, + { Name = "security", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAddOnMetadata", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "variable", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "data", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumAddOns", + Type = "Function", + + Returns = + { + { Name = "numAddons", Type = "number", Nilable = false }, + }, + }, + { + Name = "InterfaceOptionsFrame_OpenToCategory", + Type = "Function", + + Arguments = + { + { Name = "panelName", Type = "string", Nilable = true }, + { Name = "panel", Type = "table", Nilable = true }, + }, + + }, + { + Name = "InterfaceOptions_AddCategory", + Type = "Function", + + Arguments = + { + { Name = "panel", Type = "table", Nilable = false }, + }, + + }, + { + Name = "IsAddOnLoadOnDemand", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "isLod", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAddOnLoaded", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "loaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LoadAddOn", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "loaded", Type = "number", Nilable = false }, + { Name = "reason", Type = "string", Nilable = false }, + }, + }, + { + Name = "ResetDisabledAddOns", + Type = "Function", + + }, + { + Name = "SendAddonMessage", + Type = "Function", + + Arguments = + { + { Name = "prefix", Type = "string", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + { Name = "type", Type = "string", Nilable = true }, + { Name = "target", Type = "string", Nilable = true }, + }, + + }, + }, + + Events = + { + { + Name = "AddonLoaded", + Type = "Event", + LiteralName = "ADDON_LOADED", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(AddonRelated); diff --git a/APIDocumentation/Documentation/AdventureJournalDocumentation.lua b/APIDocumentation/Documentation/AdventureJournalDocumentation.lua deleted file mode 100644 index 823126d..0000000 --- a/APIDocumentation/Documentation/AdventureJournalDocumentation.lua +++ /dev/null @@ -1,96 +0,0 @@ -local AdventureJournal = -{ - Name = "AdventureJournal", - Type = "System", - Namespace = "C_AdventureJournal", - - Functions = - { - }, - - Events = - { - { - Name = "AjDungeonAction", - Type = "Event", - LiteralName = "AJ_DUNGEON_ACTION", - Payload = - { - { Name = "lfgDungeonID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AjOpen", - Type = "Event", - LiteralName = "AJ_OPEN", - }, - { - Name = "AjPveLfgAction", - Type = "Event", - LiteralName = "AJ_PVE_LFG_ACTION", - }, - { - Name = "AjPvpAction", - Type = "Event", - LiteralName = "AJ_PVP_ACTION", - Payload = - { - { Name = "battleMasterListID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AjPvpLfgAction", - Type = "Event", - LiteralName = "AJ_PVP_LFG_ACTION", - }, - { - Name = "AjPvpRbgAction", - Type = "Event", - LiteralName = "AJ_PVP_RBG_ACTION", - }, - { - Name = "AjPvpSkirmishAction", - Type = "Event", - LiteralName = "AJ_PVP_SKIRMISH_ACTION", - }, - { - Name = "AjQuestLogOpen", - Type = "Event", - LiteralName = "AJ_QUEST_LOG_OPEN", - Payload = - { - { Name = "questID", Type = "number", Nilable = false }, - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AjRaidAction", - Type = "Event", - LiteralName = "AJ_RAID_ACTION", - Payload = - { - { Name = "lfgDungeonID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AjRefreshDisplay", - Type = "Event", - LiteralName = "AJ_REFRESH_DISPLAY", - Payload = - { - { Name = "newAdventureNotice", Type = "bool", Nilable = false }, - }, - }, - { - Name = "AjRewardDataReceived", - Type = "Event", - LiteralName = "AJ_REWARD_DATA_RECEIVED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(AdventureJournal); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AdventureMapDocumentation.lua b/APIDocumentation/Documentation/AdventureMapDocumentation.lua deleted file mode 100644 index 3135eab..0000000 --- a/APIDocumentation/Documentation/AdventureMapDocumentation.lua +++ /dev/null @@ -1,53 +0,0 @@ -local AdventureMap = -{ - Name = "AdventureMap", - Type = "System", - Namespace = "C_AdventureMap", - - Functions = - { - }, - - Events = - { - { - Name = "AdventureMapClose", - Type = "Event", - LiteralName = "ADVENTURE_MAP_CLOSE", - }, - { - Name = "AdventureMapOpen", - Type = "Event", - LiteralName = "ADVENTURE_MAP_OPEN", - Payload = - { - { Name = "followerTypeID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AdventureMapQuestUpdate", - Type = "Event", - LiteralName = "ADVENTURE_MAP_QUEST_UPDATE", - Payload = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AdventureMapUpdateInsets", - Type = "Event", - LiteralName = "ADVENTURE_MAP_UPDATE_INSETS", - }, - { - Name = "AdventureMapUpdatePois", - Type = "Event", - LiteralName = "ADVENTURE_MAP_UPDATE_POIS", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(AdventureMap); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AppearanceSourceDocumentation.lua b/APIDocumentation/Documentation/AppearanceSourceDocumentation.lua deleted file mode 100644 index cc1bf6d..0000000 --- a/APIDocumentation/Documentation/AppearanceSourceDocumentation.lua +++ /dev/null @@ -1,30 +0,0 @@ -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 = "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/APIDocumentation/Documentation/AreaPoiInfoDocumentation.lua b/APIDocumentation/Documentation/AreaPoiInfoDocumentation.lua deleted file mode 100644 index ebb7ea9..0000000 --- a/APIDocumentation/Documentation/AreaPoiInfoDocumentation.lua +++ /dev/null @@ -1,103 +0,0 @@ -local AreaPoiInfo = -{ - Name = "AreaPoiInfo", - Type = "System", - Namespace = "C_AreaPoiInfo", - - Functions = - { - { - Name = "GetAreaPOIForMap", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "areaPoiIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetAreaPOIInfo", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - { Name = "areaPoiID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "poiInfo", Type = "AreaPOIInfo", Nilable = false }, - }, - }, - { - Name = "GetAreaPOITimeLeft", - Type = "Function", - Documentation = { "Returns the number of minutes until the POI expires." }, - - Arguments = - { - { Name = "areaPoiID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "minutesLeft", Type = "number", Nilable = false }, - }, - }, - { - Name = "IsAreaPOITimed", - Type = "Function", - 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 }, - }, - }, - }, - - Events = - { - { - Name = "AreaPoisUpdated", - Type = "Event", - LiteralName = "AREA_POIS_UPDATED", - }, - }, - - 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 = "textureIndex", Type = "number", Nilable = true }, - { Name = "widgetSetID", Type = "number", Nilable = true }, - { Name = "atlasName", Type = "string", 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 = "addPaddingAboveWidgets", Type = "bool", Nilable = true }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(AreaPoiInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ArenaDocumentation.lua b/APIDocumentation/Documentation/ArenaDocumentation.lua new file mode 100644 index 0000000..c293d0b --- /dev/null +++ b/APIDocumentation/Documentation/ArenaDocumentation.lua @@ -0,0 +1,348 @@ +local Arena = +{ + Name = "Arena", + Type = "System", + Namespace = "Arena", + + Functions = + { + { + Name = "AcceptArenaTeam", + Type = "Function", + + }, + { + Name = "ArenaTeamDisband", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ArenaTeamInviteByName", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ArenaTeamLeave", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ArenaTeamRoster", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ArenaTeamSetLeaderByName", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ArenaTeamUninviteByName", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ArenaTeam_GetTeamSizeID", + Type = "Function", + + Arguments = + { + { Name = "teamSize", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "teamID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CloseArenaTeamRoster", + Type = "Function", + + }, + { + Name = "DeclineArenaTeam", + Type = "Function", + + }, + { + Name = "GetArenaTeam", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "teamName", Type = "string", Nilable = false }, + { Name = "teamSize", Type = "number", Nilable = false }, + { Name = "teamRating", Type = "number", Nilable = false }, + { Name = "teamPlayed", Type = "number", Nilable = false }, + { Name = "teamWins", Type = "number", Nilable = false }, + { Name = "seasonTeamPlayed", Type = "number", Nilable = false }, + { Name = "seasonTeamWins", Type = "number", Nilable = false }, + { Name = "playerPlayed", Type = "number", Nilable = false }, + { Name = "seasonPlayerPlayed", Type = "number", Nilable = false }, + { Name = "teamRank", Type = "number", Nilable = false }, + { Name = "playerRating", Type = "number", Nilable = false }, + { Name = "bg_red", Type = "number", Nilable = false }, + { Name = "bg_green", Type = "number", Nilable = false }, + { Name = "bg_blue", Type = "number", Nilable = false }, + { Name = "emblem", Type = "number", Nilable = false }, + { Name = "emblem_red", Type = "number", Nilable = false }, + { Name = "emblem_green", Type = "number", Nilable = false }, + { Name = "emblem_blue", Type = "number", Nilable = false }, + { Name = "border", Type = "number", Nilable = false }, + { Name = "border_red", Type = "number", Nilable = false }, + { Name = "border_green", Type = "number", Nilable = false }, + { Name = "border_blue", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArenaTeamGdfInfo", + Type = "Function", + + }, + { + Name = "GetArenaTeamRosterInfo", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "online", Type = "bool", Nilable = false }, + { Name = "played", Type = "number", Nilable = false }, + { Name = "win", Type = "number", Nilable = false }, + { Name = "seasonPlayed", Type = "number", Nilable = false }, + { Name = "seasonWin", Type = "number", Nilable = false }, + { Name = "rating", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetArenaTeamRosterSelection", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetArenaTeamRosterShowOffline", + Type = "Function", + + Returns = + { + { Name = "showOffline", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCurrentArenaSeason", + Type = "Function", + + Returns = + { + { Name = "season", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxArenaCurrency", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumArenaOpponents", + Type = "Function", + + Returns = + { + { Name = "numOpponents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumArenaTeamMembers", + Type = "Function", + + Arguments = + { + { Name = "teamindex", Type = "luaIndex", Nilable = false }, + { Name = "showOffline", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPreviousArenaSeason", + Type = "Function", + + Returns = + { + { Name = "season", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsActiveBattlefieldArena", + Type = "Function", + + Returns = + { + { Name = "isArena", Type = "bool", Nilable = false }, + { Name = "isRegistered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsArenaTeamCaptain", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCaptain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInArenaTeam", + Type = "Function", + + Returns = + { + { Name = "isInTeam", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetArenaTeamRosterSelection", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetArenaTeamRosterShowOffline", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SortArenaTeamRoster", + Type = "Function", + + Arguments = + { + { Name = "sortType", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "ArenaOpponentUpdate", + Type = "Event", + LiteralName = "ARENA_OPPONENT_UPDATE", + }, + { + Name = "ArenaSeasonWorldState", + Type = "Event", + LiteralName = "ARENA_SEASON_WORLD_STATE", + }, + { + Name = "ArenaTeamInviteRequest", + Type = "Event", + LiteralName = "ARENA_TEAM_INVITE_REQUEST", + Payload = + { + { Name = "source", Type = "string", Nilable = false }, + { Name = "team", Type = "string", Nilable = false }, + }, + }, + { + Name = "ArenaTeamRosterUpdate", + Type = "Event", + LiteralName = "ARENA_TEAM_ROSTER_UPDATE", + Payload = + { + { Name = "unknown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ArenaTeamUpdate", + Type = "Event", + LiteralName = "ARENA_TEAM_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Arena); diff --git a/APIDocumentation/Documentation/AuctionDocumentation.lua b/APIDocumentation/Documentation/AuctionDocumentation.lua new file mode 100644 index 0000000..620fcd6 --- /dev/null +++ b/APIDocumentation/Documentation/AuctionDocumentation.lua @@ -0,0 +1,459 @@ +local Auction = +{ + Name = "Auction", + Type = "System", + Namespace = "Auction", + + Functions = + { + { + Name = "CalculateAuctionDeposit", + Type = "Function", + + Arguments = + { + { Name = "runTime", Type = "time_t", Nilable = false }, + }, + + Returns = + { + { Name = "deposit", Type = "number", Nilable = false }, + }, + }, + { + Name = "CanCancelAuction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canCancel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSendAuctionQuery", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "canQuery", Type = "bool", Nilable = false }, + { Name = "canMassQuery", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelAuction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canCancel", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClickAuctionSellItemButton", + Type = "Function", + + }, + { + Name = "CloseAuctionHouse", + Type = "Function", + + }, + { + Name = "GetAuctionHouseDepositRate", + Type = "Function", + + Returns = + { + { Name = "rate", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAuctionInvTypes", + Type = "Function", + + Arguments = + { + { Name = "classIndex", Type = "luaIndex", Nilable = false }, + { Name = "subClassIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "token", Type = "string", Nilable = false }, + { Name = "display", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetAuctionItemClasses", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetAuctionItemInfo", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "canUse", Type = "1nil", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "minBid", Type = "number", Nilable = false }, + { Name = "minIncrement", Type = "number", Nilable = false }, + { Name = "buyoutPrice", Type = "number", Nilable = false }, + { Name = "bidAmount", Type = "number", Nilable = false }, + { Name = "highestBidder", Type = "1nil", Nilable = false }, + { Name = "owner", Type = "string", Nilable = false }, + { Name = "sold", Type = "1nil", Nilable = false }, + }, + }, + { + Name = "GetAuctionItemLink", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetAuctionItemSubClasses", + Type = "Function", + + Arguments = + { + { Name = "classIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetAuctionItemTimeLeft", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "duration", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetAuctionSellItemInfo", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "canUse", Type = "1nil", Nilable = false }, + { Name = "price", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAuctionSort", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "criterion", Type = "string", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBidderAuctionItems", + Type = "Function", + + }, + { + Name = "GetInboxInvoiceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "invoiceType", Type = "string", Nilable = false }, + { Name = "itemName", Type = "string", Nilable = false }, + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "bid", Type = "number", Nilable = false }, + { Name = "buyout", Type = "number", Nilable = false }, + { Name = "deposit", Type = "number", Nilable = false }, + { Name = "consignment", Type = "number", Nilable = false }, + { Name = "moneyDelay", Type = "number", Nilable = false }, + { Name = "etaHour", Type = "number", Nilable = false }, + { Name = "etaMin", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumAuctionItems", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "numBatchAuctions", Type = "number", Nilable = false }, + { Name = "totalAuctions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOwnerAuctionItems", + Type = "Function", + + }, + { + Name = "GetSelectedAuctionItem", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "IsAuctionSortReversed", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "sort", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isReversed", Type = "bool", Nilable = false }, + { Name = "isSorted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlaceAuctionBid", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "bid", Type = "number", Nilable = false }, + }, + + }, + { + Name = "QueryAuctionItems", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "invTypeIndex", Type = "luaIndex", Nilable = false }, + { Name = "classIndex", Type = "luaIndex", Nilable = false }, + { Name = "subClassIndex", Type = "luaIndex", Nilable = false }, + { Name = "page", Type = "number", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "minQuality", Type = "itemQuality", Nilable = false }, + { Name = "getAll", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "SetSelectedAuctionItem", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SortAuctionApplySort", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SortAuctionClearSort", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SortAuctionItems", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "sort", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SortAuctionSetSort", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "sort", Type = "number", Nilable = false }, + { Name = "reversed", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "StartAuction", + Type = "Function", + + Arguments = + { + { Name = "minBid", Type = "number", Nilable = false }, + { Name = "buyoutPrice", Type = "number", Nilable = false }, + { Name = "runTime", Type = "time_t", Nilable = false }, + { Name = "stackSize", Type = "number", Nilable = false }, + { Name = "numStacks", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "AuctionBidderListUpdate", + Type = "Event", + LiteralName = "AUCTION_BIDDER_LIST_UPDATE", + }, + { + Name = "AuctionHouseClosed", + Type = "Event", + LiteralName = "AUCTION_HOUSE_CLOSED", + }, + { + Name = "AuctionHouseDisabled", + Type = "Event", + LiteralName = "AUCTION_HOUSE_DISABLED", + }, + { + Name = "AuctionHouseShow", + Type = "Event", + LiteralName = "AUCTION_HOUSE_SHOW", + }, + { + Name = "AuctionItemListUpdate", + Type = "Event", + LiteralName = "AUCTION_ITEM_LIST_UPDATE", + }, + { + Name = "AuctionMultisellFailure", + Type = "Event", + LiteralName = "AUCTION_MULTISELL_FAILURE", + }, + { + Name = "AuctionMultisellStart", + Type = "Event", + LiteralName = "AUCTION_MULTISELL_START", + Payload = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionMultisellUpdate", + Type = "Event", + LiteralName = "AUCTION_MULTISELL_UPDATE", + Payload = + { + { Name = "createdAmount", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "AuctionOwnedListUpdate", + Type = "Event", + LiteralName = "AUCTION_OWNED_LIST_UPDATE", + }, + { + Name = "NewAuctionUpdate", + Type = "Event", + LiteralName = "NEW_AUCTION_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Auction); diff --git a/APIDocumentation/Documentation/AuctionHouseConstants_ClassicDocumentation.lua b/APIDocumentation/Documentation/AuctionHouseConstants_ClassicDocumentation.lua deleted file mode 100644 index 56a1c8b..0000000 --- a/APIDocumentation/Documentation/AuctionHouseConstants_ClassicDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local AuctionHouseConstants_Classic = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(AuctionHouseConstants_Classic); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AuctionHouseDocumentation.lua b/APIDocumentation/Documentation/AuctionHouseDocumentation.lua deleted file mode 100644 index 3bef3cf..0000000 --- a/APIDocumentation/Documentation/AuctionHouseDocumentation.lua +++ /dev/null @@ -1,105 +0,0 @@ -local AuctionHouse = -{ - Name = "AuctionHouse", - Type = "System", - Namespace = "C_AuctionHouse", - - Functions = - { - }, - - Events = - { - { - Name = "AuctionBidderListUpdate", - Type = "Event", - LiteralName = "AUCTION_BIDDER_LIST_UPDATE", - }, - { - Name = "AuctionHouseClosed", - Type = "Event", - LiteralName = "AUCTION_HOUSE_CLOSED", - }, - { - Name = "AuctionHouseDisabled", - Type = "Event", - LiteralName = "AUCTION_HOUSE_DISABLED", - }, - { - Name = "AuctionHousePostError", - Type = "Event", - LiteralName = "AUCTION_HOUSE_POST_ERROR", - }, - { - Name = "AuctionHousePostWarning", - Type = "Event", - LiteralName = "AUCTION_HOUSE_POST_WARNING", - }, - { - Name = "AuctionHouseScriptDeprecated", - Type = "Event", - LiteralName = "AUCTION_HOUSE_SCRIPT_DEPRECATED", - }, - { - Name = "AuctionHouseShow", - Type = "Event", - LiteralName = "AUCTION_HOUSE_SHOW", - }, - { - Name = "AuctionItemListUpdate", - Type = "Event", - LiteralName = "AUCTION_ITEM_LIST_UPDATE", - }, - { - Name = "AuctionMultisellFailure", - Type = "Event", - LiteralName = "AUCTION_MULTISELL_FAILURE", - }, - { - Name = "AuctionMultisellStart", - Type = "Event", - LiteralName = "AUCTION_MULTISELL_START", - Payload = - { - { Name = "numRepetitions", Type = "number", Nilable = false }, - }, - }, - { - Name = "AuctionMultisellUpdate", - Type = "Event", - LiteralName = "AUCTION_MULTISELL_UPDATE", - Payload = - { - { Name = "createdCount", Type = "number", Nilable = false }, - { Name = "totalToCreate", Type = "number", Nilable = false }, - }, - }, - { - Name = "AuctionOwnedListUpdate", - Type = "Event", - LiteralName = "AUCTION_OWNED_LIST_UPDATE", - }, - { - Name = "NewAuctionUpdate", - Type = "Event", - LiteralName = "NEW_AUCTION_UPDATE", - }, - }, - - Tables = - { - { - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(AuctionHouse); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AuctionHouseEnumsDocumentation.lua b/APIDocumentation/Documentation/AuctionHouseEnumsDocumentation.lua deleted file mode 100644 index bc08943..0000000 --- a/APIDocumentation/Documentation/AuctionHouseEnumsDocumentation.lua +++ /dev/null @@ -1,137 +0,0 @@ -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 = 26, - MinValue = 0, - MaxValue = 25, - 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 = "AuctionHouseFilter", - Type = "Enumeration", - NumValues = 13, - MinValue = 0, - MaxValue = 12, - Fields = - { - { Name = "None", Type = "AuctionHouseFilter", EnumValue = 0 }, - { Name = "UncollectedOnly", Type = "AuctionHouseFilter", EnumValue = 1 }, - { Name = "UsableOnly", Type = "AuctionHouseFilter", EnumValue = 2 }, - { Name = "UpgradesOnly", Type = "AuctionHouseFilter", EnumValue = 3 }, - { Name = "ExactMatch", Type = "AuctionHouseFilter", EnumValue = 4 }, - { Name = "PoorQuality", Type = "AuctionHouseFilter", EnumValue = 5 }, - { Name = "CommonQuality", Type = "AuctionHouseFilter", EnumValue = 6 }, - { Name = "UncommonQuality", Type = "AuctionHouseFilter", EnumValue = 7 }, - { Name = "RareQuality", Type = "AuctionHouseFilter", EnumValue = 8 }, - { Name = "EpicQuality", Type = "AuctionHouseFilter", EnumValue = 9 }, - { Name = "LegendaryQuality", Type = "AuctionHouseFilter", EnumValue = 10 }, - { Name = "ArtifactQuality", Type = "AuctionHouseFilter", EnumValue = 11 }, - { Name = "LegendaryCraftedItemOnly", Type = "AuctionHouseFilter", EnumValue = 12 }, - }, - }, - { - 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/APIDocumentation/Documentation/Awesome_WotLKDocumentation.lua b/APIDocumentation/Documentation/Awesome_WotLKDocumentation.lua new file mode 100644 index 0000000..d027dfa --- /dev/null +++ b/APIDocumentation/Documentation/Awesome_WotLKDocumentation.lua @@ -0,0 +1,444 @@ +local Awesome_WotLK = +{ + Name = "Awesome WotLK", + Type = "System", + Namespace = "Awesome WotLK", + + Functions = + { + { + Name = "C_NamePlate.GetNamePlateForUnit", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "namePlate", Type = "frame", Nilable = false }, + }, + }, + { + Name = "C_NamePlate.GetNamePlates", + Type = "Function", + + Returns = + { + { Name = "namePlateList", Type = "table", Nilable = false }, + }, + }, + { + Name = "C_NamePlate.GetNamePlateByGUID", + Type = "Function", + + Arguments = + { + { Name = "GUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "namePlateList", Type = "frame", Nilable = false }, + }, + }, + { + Name = "C_NamePlate.GetNamePlateTokenByGUID", + Type = "Function", + + Arguments = + { + { Name = "GUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "C_VoiceChat.GetTtsVoices", + Type = "Function", + + Returns = + { + { Name = "voiceList", Type = "table", Nilable = false }, + }, + }, + { + Name = "C_VoiceChat.GetRemoteTtsVoices", + Type = "Function", + + Returns = + { + { Name = "voiceList", Type = "table", Nilable = false }, + }, + }, + { + Name = "C_VoiceChat.SpeakText", + Type = "Function", + + Arguments = + { + { Name = "voiceID", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "destination", Type = "number", Nilable = true }, + { Name = "rate", Type = "number", Nilable = true }, + { Name = "volume", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "utteranceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "C_VoiceChat.StopSpeakingText", + Type = "Function", + + }, + { + Name = "C_TTSSettings.GetSpeechRate", + Type = "Function", + + Returns = + { + { Name = "rate", Type = "number", Nilable = false }, + }, + }, + { + Name = "C_TTSSettings.GetSpeechVolume", + Type = "Function", + + Returns = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "C_TTSSettings.GetSpeechVoiceID", + Type = "Function", + + Returns = + { + { Name = "voiceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "C_TTSSettings.GetVoiceOptionName", + Type = "Function", + + Returns = + { + { Name = "voiceName", Type = "string", Nilable = false }, + }, + }, + { + Name = "C_TTSSettings.SetDefaultSettings", + Type = "Function", + + }, + { + Name = "C_TTSSettings.SetSpeechRate", + Type = "Function", + + Arguments = + { + { Name = "rate", Type = "number", Nilable = false }, + }, + + }, + { + Name = "C_TTSSettings.SetSpeechVolume", + Type = "Function", + + Arguments = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + + }, + { + Name = "C_TTSSettings.SetVoiceOption", + Type = "Function", + + Arguments = + { + { Name = "voiceID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "C_TTSSettings.SetVoiceOptionByName", + Type = "Function", + + Arguments = + { + { Name = "voiceName", Type = "string", Nilable = false }, + }, + + }, + { + Name = "C_TTSSettings.RefreshVoices", + Type = "Function", + + }, + { + Name = "UnitIsControlled", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isControlled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDisarmed", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isDisarmed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsSilenced", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitOccupations", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "npcFlags", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitOwner", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "ownerName", Type = "string", Nilable = false }, + { Name = "ownerGuid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "UnitTokenFromGUID", + Type = "Function", + + Arguments = + { + { Name = "GUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "UnitToken", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemTransmog", + Type = "Function", + + Arguments = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemId", Type = "number", Nilable = false }, + { Name = "enchantId", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBaseCooldown", + Type = "Function", + + Arguments = + { + { Name = "spellId", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "cdMs", Type = "number", Nilable = false }, + { Name = "gcdMs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemInfoInstant", + Type = "Function", + + Arguments = + { + { Name = "itemId/itemName/itemHyperlink", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemType", Type = "string", Nilable = false }, + { Name = "itemSubType", Type = "string", Nilable = false }, + { Name = "itemEquipLoc", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + { Name = "subclassID", Type = "number", Nilable = false }, + }, + }, + { + Name = "FlashWindow", + Type = "Function", + + }, + { + Name = "IsWindowFocused", + Type = "Function", + + }, + { + Name = "FocusWindow", + Type = "Function", + + }, + { + Name = "CopyToClipboard", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "NamePlateCreated", + Type = "Event", + LiteralName = "NAME_PLATE_CREATED", + Payload = + { + { Name = "namePlateBase", Type = "frame", Nilable = false }, + }, + }, + { + Name = "NamePlateUnitAdded", + Type = "Event", + LiteralName = "NAME_PLATE_UNIT_ADDED", + Payload = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "NamePlateUnitRemoved", + Type = "Event", + LiteralName = "NAME_PLATE_UNIT_REMOVED", + Payload = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "NamePlateOwnerChanged", + Type = "Event", + LiteralName = "NAME_PLATE_OWNER_CHANGED", + Payload = + { + { Name = "unitId", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsPlaybackStarted", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_STARTED", + Payload = + { + { Name = "numConsumers", Type = "number", Nilable = false }, + { Name = "utteranceID", Type = "number", Nilable = false }, + { Name = "durationMS", Type = "time_t", Nilable = false }, + { Name = "destination", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsPlaybackFinished", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_FINISHED", + Payload = + { + { Name = "numConsumers", Type = "number", Nilable = false }, + { Name = "utteranceID", Type = "number", Nilable = false }, + { Name = "destination", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsPlaybackFailed", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_PLAYBACK_FAILED", + Payload = + { + { Name = "status", Type = "string", Nilable = false }, + { Name = "utteranceID", Type = "number", Nilable = false }, + { Name = "destination", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsSpeakTextUpdate", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE", + Payload = + { + { Name = "status", Type = "string", Nilable = false }, + { Name = "utteranceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChatTtsVoicesUpdate", + Type = "Event", + LiteralName = "VOICE_CHAT_TTS_VOICES_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Awesome_WotLK); diff --git a/APIDocumentation/Documentation/AzeriteConstantsDocumentation.lua b/APIDocumentation/Documentation/AzeriteConstantsDocumentation.lua deleted file mode 100644 index b427160..0000000 --- a/APIDocumentation/Documentation/AzeriteConstantsDocumentation.lua +++ /dev/null @@ -1,22 +0,0 @@ -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/APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua b/APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua deleted file mode 100644 index afd96f4..0000000 --- a/APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua +++ /dev/null @@ -1,327 +0,0 @@ -local AzeriteEmpoweredItem = -{ - Name = "AzeriteEmpoweredItem", - Type = "System", - Namespace = "C_AzeriteEmpoweredItem", - - Functions = - { - { - Name = "CanSelectPower", - Type = "Function", - - 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", - - Arguments = - { - { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - }, - { - Name = "GetAllTierInfo", - Type = "Function", - - Arguments = - { - { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "tierInfo", Type = "table", InnerType = "AzeriteEmpoweredItemTierInfo", Nilable = false }, - }, - }, - { - Name = "GetAllTierInfoByItemID", - Type = "Function", - - 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", - - Arguments = - { - { Name = "powerID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "powerInfo", Type = "AzeriteEmpoweredItemPowerInfo", Nilable = false }, - }, - }, - { - Name = "GetPowerText", - Type = "Function", - - 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", - - Arguments = - { - { Name = "powerID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "specInfo", Type = "table", InnerType = "AzeriteSpecInfo", Nilable = false }, - }, - }, - { - Name = "HasAnyUnselectedPowers", - Type = "Function", - - Arguments = - { - { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "hasAnyUnselectedPowers", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HasBeenViewed", - Type = "Function", - - Arguments = - { - { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "hasBeenViewed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsAzeriteEmpoweredItem", - Type = "Function", - - Arguments = - { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "isAzeriteEmpoweredItem", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsAzeriteEmpoweredItemByID", - Type = "Function", - - Arguments = - { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, - }, - - Returns = - { - { Name = "isAzeriteEmpoweredItem", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsAzeritePreviewSourceDisplayable", - Type = "Function", - - 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", - - Arguments = - { - { Name = "powerID", Type = "number", Nilable = false }, - { Name = "specID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isPowerAvailableForSpec", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsPowerSelected", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "azeriteEmpoweredItemLocation", Type = "AzeriteEmpoweredItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AzeriteEmpoweredItemEquippedStatusChanged", - Type = "Event", - LiteralName = "AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED", - Payload = - { - { Name = "isHeartEquipped", Type = "bool", Nilable = false }, - }, - }, - { - Name = "AzeriteEmpoweredItemSelectionUpdated", - Type = "Event", - LiteralName = "AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED", - 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/APIDocumentation/Documentation/AzeriteEssenceDocumentation.lua b/APIDocumentation/Documentation/AzeriteEssenceDocumentation.lua deleted file mode 100644 index 2931baf..0000000 --- a/APIDocumentation/Documentation/AzeriteEssenceDocumentation.lua +++ /dev/null @@ -1,326 +0,0 @@ -local AzeriteEssence = -{ - Name = "AzeriteEssence", - Type = "System", - Namespace = "C_AzeriteEssence", - - Functions = - { - { - Name = "ActivateEssence", - Type = "Function", - - Arguments = - { - { Name = "essenceID", Type = "number", Nilable = false }, - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - }, - { - Name = "CanActivateEssence", - Type = "Function", - - Arguments = - { - { Name = "essenceID", Type = "number", Nilable = false }, - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "canActivate", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CanDeactivateEssence", - Type = "Function", - - 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", - - Arguments = - { - { Name = "essenceID", Type = "number", Nilable = false }, - { Name = "rank", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "link", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetEssenceInfo", - Type = "Function", - - Arguments = - { - { Name = "essenceID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "AzeriteEssenceInfo", Nilable = false }, - }, - }, - { - Name = "GetEssences", - Type = "Function", - - Returns = - { - { Name = "essences", Type = "table", InnerType = "AzeriteEssenceInfo", Nilable = false }, - }, - }, - { - Name = "GetMilestoneEssence", - Type = "Function", - - Arguments = - { - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "essenceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetMilestoneInfo", - Type = "Function", - - Arguments = - { - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "AzeriteMilestoneInfo", Nilable = false }, - }, - }, - { - Name = "GetMilestoneSpell", - Type = "Function", - - Arguments = - { - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetMilestones", - Type = "Function", - - 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", - - Arguments = - { - { Name = "essenceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnlockMilestone", - Type = "Function", - - Arguments = - { - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AzeriteEssenceActivated", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_ACTIVATED", - Payload = - { - { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false }, - { Name = "essenceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AzeriteEssenceActivationFailed", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_ACTIVATION_FAILED", - Payload = - { - { Name = "slot", Type = "AzeriteEssenceSlot", Nilable = false }, - { Name = "essenceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AzeriteEssenceChanged", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_CHANGED", - Payload = - { - { Name = "essenceID", Type = "number", Nilable = false }, - { Name = "newRank", Type = "number", Nilable = false }, - }, - }, - { - Name = "AzeriteEssenceForgeClose", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_FORGE_CLOSE", - }, - { - Name = "AzeriteEssenceForgeOpen", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_FORGE_OPEN", - }, - { - Name = "AzeriteEssenceMilestoneUnlocked", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_MILESTONE_UNLOCKED", - Payload = - { - { Name = "milestoneID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AzeriteEssenceUpdate", - Type = "Event", - LiteralName = "AZERITE_ESSENCE_UPDATE", - }, - { - Name = "PendingAzeriteEssenceChanged", - Type = "Event", - LiteralName = "PENDING_AZERITE_ESSENCE_CHANGED", - 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/APIDocumentation/Documentation/AzeriteItemDocumentation.lua b/APIDocumentation/Documentation/AzeriteItemDocumentation.lua deleted file mode 100644 index 165b628..0000000 --- a/APIDocumentation/Documentation/AzeriteItemDocumentation.lua +++ /dev/null @@ -1,183 +0,0 @@ -local AzeriteItem = -{ - Name = "AzeriteItem", - Type = "System", - Namespace = "C_AzeriteItem", - - Functions = - { - { - Name = "FindActiveAzeriteItem", - Type = "Function", - - Returns = - { - { Name = "activeAzeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - }, - { - Name = "GetAzeriteItemXPInfo", - Type = "Function", - - 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", - - Arguments = - { - { Name = "azeriteItemLocation", Type = "AzeriteItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "powerLevel", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetUnlimitedPowerLevel", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, - }, - - Returns = - { - { Name = "isAzeriteItem", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsAzeriteItemEnabled", - Type = "Function", - - 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", - Payload = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "AzeriteItemExperienceChanged", - Type = "Event", - LiteralName = "AZERITE_ITEM_EXPERIENCE_CHANGED", - 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", - 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/APIDocumentation/Documentation/BagConstantsDocumentation.lua b/APIDocumentation/Documentation/BagConstantsDocumentation.lua deleted file mode 100644 index d8e429a..0000000 --- a/APIDocumentation/Documentation/BagConstantsDocumentation.lua +++ /dev/null @@ -1,26 +0,0 @@ -local BagConstants = -{ - Tables = - { - { - Name = "BagSlotFlags", - Type = "Enumeration", - NumValues = 8, - MinValue = 1, - MaxValue = 63, - Fields = - { - { Name = "DisableAutoSort", Type = "BagSlotFlags", EnumValue = 1 }, - { Name = "PriorityEquipment", Type = "BagSlotFlags", EnumValue = 2 }, - { Name = "PriorityConsumables", Type = "BagSlotFlags", EnumValue = 4 }, - { Name = "PriorityTradeGoods", Type = "BagSlotFlags", EnumValue = 8 }, - { Name = "PriorityJunk", Type = "BagSlotFlags", EnumValue = 16 }, - { Name = "PriorityQuestItems", Type = "BagSlotFlags", EnumValue = 32 }, - { Name = "BagSlotValidFlagsAll", Type = "BagSlotFlags", EnumValue = 63 }, - { Name = "BagSlotPriorityFlagsAll", Type = "BagSlotFlags", EnumValue = 62 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(BagConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BagIndexConstantsDocumentation.lua b/APIDocumentation/Documentation/BagIndexConstantsDocumentation.lua deleted file mode 100644 index ec2805d..0000000 --- a/APIDocumentation/Documentation/BagIndexConstantsDocumentation.lua +++ /dev/null @@ -1,46 +0,0 @@ -local BagIndexConstants = -{ - Name = "BagIndexConstants", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - { - Name = "BagIndex", - Type = "Enumeration", - NumValues = 17, - MinValue = -4, - MaxValue = 12, - Fields = - { - { Name = "Bankbag", Type = "BagIndex", EnumValue = -4 }, - { Name = "Reagentbank", Type = "BagIndex", EnumValue = -3 }, - { Name = "Keyring", Type = "BagIndex", EnumValue = -2 }, - { Name = "Bank", 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 = "BankBag_1", Type = "BagIndex", EnumValue = 6 }, - { Name = "BankBag_2", Type = "BagIndex", EnumValue = 7 }, - { Name = "BankBag_3", Type = "BagIndex", EnumValue = 8 }, - { Name = "BankBag_4", Type = "BagIndex", EnumValue = 9 }, - { Name = "BankBag_5", Type = "BagIndex", EnumValue = 10 }, - { Name = "BankBag_6", Type = "BagIndex", EnumValue = 11 }, - { Name = "BankBag_7", Type = "BagIndex", EnumValue = 12 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(BagIndexConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BankDocumentation.lua b/APIDocumentation/Documentation/BankDocumentation.lua index fd98451..26b491d 100644 --- a/APIDocumentation/Documentation/BankDocumentation.lua +++ b/APIDocumentation/Documentation/BankDocumentation.lua @@ -2,23 +2,76 @@ local Bank = { Name = "Bank", Type = "System", - Namespace = "C_Bank", + Namespace = "Bank", Functions = { + { + Name = "BankButtonIDToInvSlotID", + Type = "Function", + + Arguments = + { + { Name = "buttonID", Type = "number", Nilable = false }, + { Name = "isBag", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "inventoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CloseBankFrame", + Type = "Function", + + }, + { + Name = "EquipmentManager_UnpackLocation", + Type = "Function", + + Arguments = + { + { Name = "location", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "player", Type = "bool", Nilable = false }, + { Name = "bank", Type = "bool", Nilable = false }, + { Name = "bags", Type = "bool", Nilable = false }, + { Name = "location or slot", Type = "number", Nilable = false }, + { Name = "bag", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBankSlotCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBankSlots", + Type = "Function", + + Returns = + { + { Name = "numSlots", Type = "number", Nilable = false }, + { Name = "isFull", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PurchaseSlot", + Type = "Function", + + }, }, Events = { - { - Name = "BankBagSlotFlagsUpdated", - Type = "Event", - LiteralName = "BANK_BAG_SLOT_FLAGS_UPDATED", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, { Name = "BankframeClosed", Type = "Event", @@ -40,7 +93,7 @@ local Bank = LiteralName = "PLAYERBANKSLOTS_CHANGED", Payload = { - { Name = "slot", Type = "number", Nilable = false }, + { Name = "slotID", Type = "number", Nilable = false }, }, }, }, @@ -50,4 +103,4 @@ local Bank = }, }; -APIDocumentation:AddDocumentationTable(Bank); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Bank); diff --git a/APIDocumentation/Documentation/BarberShopDocumentation.lua b/APIDocumentation/Documentation/BarberShopDocumentation.lua deleted file mode 100644 index 6ea8633..0000000 --- a/APIDocumentation/Documentation/BarberShopDocumentation.lua +++ /dev/null @@ -1,339 +0,0 @@ -local BarberShop = -{ - Name = "BarberShop", - Type = "System", - Namespace = "C_BarberShop", - - Functions = - { - { - Name = "ApplyCustomizationChoices", - Type = "Function", - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "Cancel", - Type = "Function", - }, - { - Name = "ClearPreviewChoices", - Type = "Function", - - Arguments = - { - { Name = "clearSavedChoices", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "CycleCharCustomization", - Type = "Function", - - Arguments = - { - { Name = "type", Type = "CharCustomizationType", Nilable = false }, - { Name = "forward", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetAvailableCustomizations", - Type = "Function", - - Returns = - { - { Name = "categories", Type = "table", InnerType = "CharCustomizationCategory", Nilable = false }, - }, - }, - { - Name = "GetBarbersChoiceCost", - Type = "Function", - - Returns = - { - { Name = "cost", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCurrentCameraZoom", - Type = "Function", - - Returns = - { - { Name = "zoomLevel", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCurrentCharacterData", - Type = "Function", - - Returns = - { - { Name = "characterData", Type = "PlayerInfoCharacterData", Nilable = false }, - }, - }, - { - Name = "GetCurrentCost", - Type = "Function", - - Returns = - { - { Name = "cost", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCustomizationTypeInfo", - Type = "Function", - - Arguments = - { - { Name = "type", Type = "CharCustomizationType", Nilable = false }, - }, - - Returns = - { - { Name = "customizationName", Type = "cstring", Nilable = false }, - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "isCurrent", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetViewingChrModel", - Type = "Function", - - Returns = - { - { Name = "chrModelID", Type = "number", Nilable = true }, - }, - }, - { - Name = "HasAnyChanges", - Type = "Function", - - Returns = - { - { Name = "hasChanges", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsValidCustomizationType", - Type = "Function", - - Arguments = - { - { Name = "type", Type = "CharCustomizationType", Nilable = false }, - }, - - Returns = - { - { Name = "isValid", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsViewingAlteredForm", - Type = "Function", - - Returns = - { - { Name = "isViewingAlteredForm", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsViewingNativeSex", - Type = "Function", - - Returns = - { - { Name = "isNativeSex", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsViewingVisibleSex", - Type = "Function", - - Arguments = - { - { Name = "sex", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isVisibleSex", Type = "bool", Nilable = false }, - }, - }, - { - Name = "PreviewCustomizationChoice", - Type = "Function", - - 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", - - Arguments = - { - { Name = "diffDegrees", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraDistanceOffset", - Type = "Function", - - Arguments = - { - { Name = "offset", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraZoomLevel", - Type = "Function", - - Arguments = - { - { Name = "zoomLevel", Type = "number", Nilable = false }, - { Name = "keepCustomZoom", Type = "bool", Nilable = true }, - }, - }, - { - Name = "SetCustomizationChoice", - Type = "Function", - - Arguments = - { - { Name = "optionID", Type = "number", Nilable = false }, - { Name = "choiceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetModelDressState", - Type = "Function", - - Arguments = - { - { Name = "dressedState", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetSelectedSex", - Type = "Function", - - Arguments = - { - { Name = "sex", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetViewingAlteredForm", - Type = "Function", - - Arguments = - { - { Name = "isViewingAlteredForm", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetViewingChrModel", - Type = "Function", - - Arguments = - { - { Name = "chrModelID", Type = "number", Nilable = true }, - }, - }, - { - Name = "SetViewingShapeshiftForm", - Type = "Function", - - Arguments = - { - { Name = "shapeshiftFormID", Type = "number", Nilable = true }, - }, - }, - { - Name = "ZoomCamera", - Type = "Function", - - Arguments = - { - { Name = "zoomAmount", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "BarberShopAppearanceApplied", - Type = "Event", - LiteralName = "BARBER_SHOP_APPEARANCE_APPLIED", - }, - { - Name = "BarberShopCameraValuesUpdated", - Type = "Event", - LiteralName = "BARBER_SHOP_CAMERA_VALUES_UPDATED", - }, - { - Name = "BarberShopClose", - Type = "Event", - LiteralName = "BARBER_SHOP_CLOSE", - }, - { - Name = "BarberShopCostUpdate", - Type = "Event", - LiteralName = "BARBER_SHOP_COST_UPDATE", - }, - { - Name = "BarberShopForceCustomizationsUpdate", - Type = "Event", - LiteralName = "BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE", - }, - { - Name = "BarberShopOpen", - Type = "Event", - LiteralName = "BARBER_SHOP_OPEN", - }, - { - Name = "BarberShopResult", - Type = "Event", - LiteralName = "BARBER_SHOP_RESULT", - Payload = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ConfirmBarbersChoice", - Type = "Event", - LiteralName = "CONFIRM_BARBERS_CHOICE", - Payload = - { - { Name = "cost", Type = "number", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(BarberShop); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BarbershopDocumentation.lua b/APIDocumentation/Documentation/BarbershopDocumentation.lua new file mode 100644 index 0000000..b5b620f --- /dev/null +++ b/APIDocumentation/Documentation/BarbershopDocumentation.lua @@ -0,0 +1,119 @@ +local Barbershop = +{ + Name = "Barbershop", + Type = "System", + Namespace = "Barbershop", + + Functions = + { + { + Name = "ApplyBarberShopStyle", + Type = "Function", + + }, + { + Name = "BarberShopReset", + Type = "Function", + + }, + { + Name = "CanAlterSkin", + Type = "Function", + + Returns = + { + { Name = "canAlter", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelBarberShop", + Type = "Function", + + }, + { + Name = "GetBarberShopStyleInfo", + Type = "Function", + + Arguments = + { + { Name = "styleIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "unused", Type = "string", Nilable = false }, + { Name = "cost", Type = "number", Nilable = false }, + { Name = "isCurrent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBarberShopTotalCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFacialHairCustomization", + Type = "Function", + + Returns = + { + { Name = "token", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetHairCustomization", + Type = "Function", + + Returns = + { + { Name = "token", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetNextBarberShopStyle", + Type = "Function", + + Arguments = + { + { Name = "styleIndex", Type = "luaIndex", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = true }, + }, + + }, + }, + + Events = + { + { + Name = "BarberShopAppearanceApplied", + Type = "Event", + LiteralName = "BARBER_SHOP_APPEARANCE_APPLIED", + }, + { + Name = "BarberShopClose", + Type = "Event", + LiteralName = "BARBER_SHOP_CLOSE", + }, + { + Name = "BarberShopOpen", + Type = "Event", + LiteralName = "BARBER_SHOP_OPEN", + }, + { + Name = "BarberShopSuccess", + Type = "Event", + LiteralName = "BARBER_SHOP_SUCCESS", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Barbershop); diff --git a/APIDocumentation/Documentation/BaseDocumentation.lua b/APIDocumentation/Documentation/BaseDocumentation.lua deleted file mode 100644 index fced442..0000000 --- a/APIDocumentation/Documentation/BaseDocumentation.lua +++ /dev/null @@ -1,15 +0,0 @@ -local Base = -{ - Tables = - { - { - Name = "ScriptObject", - Type = "Structure", - Fields = - { - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(Base); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BattleNetDocumentation.lua b/APIDocumentation/Documentation/BattleNetDocumentation.lua index de76e96..c762834 100644 --- a/APIDocumentation/Documentation/BattleNetDocumentation.lua +++ b/APIDocumentation/Documentation/BattleNetDocumentation.lua @@ -1,72 +1,13 @@ local BattleNet = { - Name = "BattleNet", + Name = "Battle.net", Type = "System", - Namespace = "C_BattleNet", + Namespace = "Battle.net", Functions = { { - Name = "GetAccountInfoByGUID", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true }, - }, - }, - { - Name = "GetAccountInfoByID", - Type = "Function", - - Arguments = - { - { Name = "id", Type = "number", Nilable = false }, - { Name = "wowAccountGUID", Type = "WOWGUID", Nilable = true }, - }, - - Returns = - { - { Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true }, - }, - }, - { - Name = "GetFriendAccountInfo", - Type = "Function", - - Arguments = - { - { Name = "friendIndex", Type = "luaIndex", Nilable = false }, - { Name = "wowAccountGUID", Type = "WOWGUID", Nilable = true }, - }, - - Returns = - { - { Name = "accountInfo", Type = "BNetAccountInfo", Nilable = true }, - }, - }, - { - Name = "GetFriendGameAccountInfo", - Type = "Function", - - Arguments = - { - { Name = "friendIndex", Type = "luaIndex", Nilable = false }, - { Name = "accountIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, - }, - }, - { - Name = "GetFriendNumGameAccounts", + Name = "BNGetFriendInfo", Type = "Function", Arguments = @@ -76,97 +17,316 @@ local BattleNet = Returns = { - { Name = "numGameAccounts", Type = "number", Nilable = false }, + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "givenName", Type = "string", Nilable = false }, + { Name = "surname", Type = "string", Nilable = false }, + { Name = "toonName", Type = "string", Nilable = false }, + { Name = "toonID", Type = "number", Nilable = false }, + { Name = "client", Type = "string", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "lastOnline", Type = "number", Nilable = false }, + { Name = "isAFK", Type = "bool", Nilable = false }, + { Name = "isDND", Type = "bool", Nilable = false }, + { Name = "messageText", Type = "string", Nilable = false }, + { Name = "noteText", Type = "string", Nilable = false }, + { Name = "isFriend", Type = "bool", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, }, }, { - Name = "GetGameAccountInfoByGUID", + Name = "BNGetFriendInfoByID", Type = "Function", Arguments = { - { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "presenceID", Type = "number", Nilable = false }, }, Returns = { - { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "givenName", Type = "string", Nilable = false }, + { Name = "surname", Type = "string", Nilable = false }, + { Name = "toonName", Type = "string", Nilable = false }, + { Name = "toonID", Type = "number", Nilable = false }, + { Name = "client", Type = "string", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "lastOnline", Type = "number", Nilable = false }, + { Name = "isAFK", Type = "bool", Nilable = false }, + { Name = "isDND", Type = "bool", Nilable = false }, + { Name = "messageText", Type = "string", Nilable = false }, + { Name = "noteText", Type = "string", Nilable = false }, + { Name = "isFriend", Type = "bool", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, }, }, { - Name = "GetGameAccountInfoByID", + Name = "BNGetFriendToonInfo", Type = "Function", Arguments = { - { Name = "id", Type = "number", Nilable = false }, + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + { Name = "toonIndex", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + { Name = "unknown", Type = "bool", Nilable = false }, + { Name = "toonName", Type = "string", Nilable = false }, + { Name = "client", Type = "string", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = false }, + { Name = "faction", Type = "number", Nilable = false }, + { Name = "race", Type = "string", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "zoneName", Type = "string", Nilable = false }, + { Name = "level", Type = "string", Nilable = false }, + { Name = "gameText", Type = "string", Nilable = false }, + { Name = "broadcastText", Type = "string", Nilable = false }, + { Name = "broadcastTime", Type = "string", Nilable = false }, }, }, + { + Name = "BNGetInfo", + Type = "Function", + + Returns = + { + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "broadcastText", Type = "string", Nilable = false }, + { Name = "bnetAFK", Type = "bool", Nilable = false }, + { Name = "bnetDND", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNGetMatureLanguageFilter", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNGetNumFriendToons", + Type = "Function", + + Arguments = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numToons", Type = "number", Nilable = false }, + }, + }, + { + Name = "BNGetNumFriends", + Type = "Function", + + Returns = + { + { Name = "totalBNet", Type = "number", Nilable = false }, + { Name = "numBNetOnline", Type = "number", Nilable = false }, + }, + }, + { + Name = "BNGetSelectedFriend", + Type = "Function", + + Returns = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "BNGetToonInfo", + Type = "Function", + + Arguments = + { + { Name = "presenceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "unknown", Type = "bool", Nilable = false }, + { Name = "toonName", Type = "string", Nilable = false }, + { Name = "client", Type = "string", Nilable = false }, + { Name = "realmName", Type = "string", Nilable = false }, + { Name = "realmID", Type = "number", Nilable = false }, + { Name = "faction", Type = "number", Nilable = false }, + { Name = "race", Type = "string", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "zoneName", Type = "string", Nilable = false }, + { Name = "level", Type = "string", Nilable = false }, + { Name = "gameText", Type = "string", Nilable = false }, + { Name = "broadcastText", Type = "string", Nilable = false }, + { Name = "broadcastTime", Type = "string", Nilable = false }, + }, + }, + { + Name = "BNSetCustomMessage", + Type = "Function", + + Arguments = + { + { Name = "broadcastText", Type = "string", Nilable = false }, + }, + + }, + { + Name = "BNSetFriendNote", + Type = "Function", + + Arguments = + { + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + }, + + }, + { + Name = "BNSetMatureLanguageFilter", + Type = "Function", + + Arguments = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + + }, }, Events = { + { + Name = "BnBlockListUpdated", + Type = "Event", + LiteralName = "BN_BLOCK_LIST_UPDATED", + }, + { + Name = "BnConnected", + Type = "Event", + LiteralName = "BN_CONNECTED", + }, + { + Name = "BnCustomMessageChanged", + Type = "Event", + LiteralName = "BN_CUSTOM_MESSAGE_CHANGED", + }, + { + Name = "BnCustomMessageLoaded", + Type = "Event", + LiteralName = "BN_CUSTOM_MESSAGE_LOADED", + }, + { + Name = "BnDisconnected", + Type = "Event", + LiteralName = "BN_DISCONNECTED", + }, + { + Name = "BnFriendAccountOffline", + Type = "Event", + LiteralName = "BN_FRIEND_ACCOUNT_OFFLINE", + Payload = + { + { Name = "presenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BnFriendAccountOnline", + Type = "Event", + LiteralName = "BN_FRIEND_ACCOUNT_ONLINE", + Payload = + { + { Name = "presenceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "BnFriendInfoChanged", + Type = "Event", + LiteralName = "BN_FRIEND_INFO_CHANGED", + }, + { + Name = "BnFriendInviteAdded", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_ADDED", + }, + { + Name = "BnFriendInviteListInitialized", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_LIST_INITIALIZED", + }, + { + Name = "BnFriendInviteRemoved", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_REMOVED", + }, + { + Name = "BnFriendInviteSendResult", + Type = "Event", + LiteralName = "BN_FRIEND_INVITE_SEND_RESULT", + }, + { + Name = "BnFriendListSizeChanged", + Type = "Event", + LiteralName = "BN_FRIEND_LIST_SIZE_CHANGED", + }, + { + Name = "BnFriendToonOffline", + Type = "Event", + LiteralName = "BN_FRIEND_TOON_OFFLINE", + }, + { + Name = "BnFriendToonOnline", + Type = "Event", + LiteralName = "BN_FRIEND_TOON_ONLINE", + }, + { + Name = "BnMatureLanguageFilter", + Type = "Event", + LiteralName = "BN_MATURE_LANGUAGE_FILTER", + }, + { + Name = "BnNewPresence", + Type = "Event", + LiteralName = "BN_NEW_PRESENCE", + Payload = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "BnSelfOffline", + Type = "Event", + LiteralName = "BN_SELF_OFFLINE", + }, + { + Name = "BnSelfOnline", + Type = "Event", + LiteralName = "BN_SELF_ONLINE", + }, + { + Name = "BnSystemMessage", + Type = "Event", + LiteralName = "BN_SYSTEM_MESSAGE", + }, + { + Name = "BnToonNameUpdated", + Type = "Event", + LiteralName = "BN_TOON_NAME_UPDATED", + }, }, 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 = "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 = "isWowMobile", Type = "bool", Nilable = false }, - { Name = "canSummon", Type = "bool", Nilable = false }, - { Name = "hasFocus", Type = "bool", Nilable = false }, - { Name = "regionID", Type = "number", Nilable = false }, - { Name = "isInCurrentRegion", Type = "bool", Nilable = false }, - }, - }, }, }; -APIDocumentation:AddDocumentationTable(BattleNet); \ No newline at end of file +APIDocumentation:AddDocumentationTable(BattleNet); diff --git a/APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua b/APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua deleted file mode 100644 index 61b2809..0000000 --- a/APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua +++ /dev/null @@ -1,396 +0,0 @@ -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 = 11, - MinValue = 0, - MaxValue = 10, - 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 = "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 = 7, - MinValue = 0, - MaxValue = 6, - 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 = "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/APIDocumentation/Documentation/BattlePetDocumentation.lua b/APIDocumentation/Documentation/BattlePetDocumentation.lua deleted file mode 100644 index 7d12d2b..0000000 --- a/APIDocumentation/Documentation/BattlePetDocumentation.lua +++ /dev/null @@ -1,233 +0,0 @@ -local BattlePet = -{ - Name = "BattlePet", - Type = "System", - Namespace = "C_BattlePet", - - Functions = - { - }, - - Events = - { - { - Name = "PetBattleAbilityChanged", - Type = "Event", - LiteralName = "PET_BATTLE_ABILITY_CHANGED", - 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", - }, - { - Name = "PetBattleAuraApplied", - Type = "Event", - LiteralName = "PET_BATTLE_AURA_APPLIED", - 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", - 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", - 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", - Payload = - { - { Name = "owner", Type = "number", Nilable = false }, - { Name = "petIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetBattleClose", - Type = "Event", - LiteralName = "PET_BATTLE_CLOSE", - }, - { - Name = "PetBattleFinalRound", - Type = "Event", - LiteralName = "PET_BATTLE_FINAL_ROUND", - Payload = - { - { Name = "owner", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetBattleHealthChanged", - Type = "Event", - LiteralName = "PET_BATTLE_HEALTH_CHANGED", - 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", - 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", - 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", - }, - { - Name = "PetBattleOpeningStart", - Type = "Event", - LiteralName = "PET_BATTLE_OPENING_START", - }, - { - Name = "PetBattleOver", - Type = "Event", - LiteralName = "PET_BATTLE_OVER", - }, - { - Name = "PetBattleOverrideAbility", - Type = "Event", - LiteralName = "PET_BATTLE_OVERRIDE_ABILITY", - Payload = - { - { Name = "abilityIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetBattlePetChanged", - Type = "Event", - LiteralName = "PET_BATTLE_PET_CHANGED", - Payload = - { - { Name = "owner", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetBattlePetRoundPlaybackComplete", - Type = "Event", - LiteralName = "PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE", - Payload = - { - { Name = "roundNumber", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetBattlePetRoundResults", - Type = "Event", - LiteralName = "PET_BATTLE_PET_ROUND_RESULTS", - Payload = - { - { Name = "roundNumber", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetBattlePetTypeChanged", - Type = "Event", - LiteralName = "PET_BATTLE_PET_TYPE_CHANGED", - 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", - }, - { - Name = "PetBattlePvpDuelRequested", - Type = "Event", - LiteralName = "PET_BATTLE_PVP_DUEL_REQUESTED", - Payload = - { - { Name = "fullName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "PetBattleQueueProposalAccepted", - Type = "Event", - LiteralName = "PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED", - }, - { - Name = "PetBattleQueueProposalDeclined", - Type = "Event", - LiteralName = "PET_BATTLE_QUEUE_PROPOSAL_DECLINED", - }, - { - Name = "PetBattleQueueProposeMatch", - Type = "Event", - LiteralName = "PET_BATTLE_QUEUE_PROPOSE_MATCH", - }, - { - Name = "PetBattleQueueStatus", - Type = "Event", - LiteralName = "PET_BATTLE_QUEUE_STATUS", - }, - { - Name = "PetBattleXpChanged", - Type = "Event", - LiteralName = "PET_BATTLE_XP_CHANGED", - 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/APIDocumentation/Documentation/BattlefieldDocumentation.lua b/APIDocumentation/Documentation/BattlefieldDocumentation.lua new file mode 100644 index 0000000..41166fa --- /dev/null +++ b/APIDocumentation/Documentation/BattlefieldDocumentation.lua @@ -0,0 +1,619 @@ +local Battlefield = +{ + Name = "Battlefield", + Type = "System", + Namespace = "Battlefield", + + Functions = + { + { + Name = "AcceptAreaSpiritHeal", + Type = "Function", + + }, + { + Name = "AcceptBattlefieldPort", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "accept", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "CanJoinBattlefieldAsGroup", + Type = "Function", + + Returns = + { + { Name = "canGroupJoin", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CancelAreaSpiritHeal", + Type = "Function", + + }, + { + Name = "CloseBattlefield", + Type = "Function", + + }, + { + Name = "GetAreaSpiritHealerTime", + Type = "Function", + + Returns = + { + { Name = "timeleft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldArenaFaction", + Type = "Function", + + }, + { + Name = "GetBattlefieldEstimatedWaitTime", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "waitTime", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldFlagPosition", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "flagX", Type = "number", Nilable = false }, + { Name = "flagY", Type = "number", Nilable = false }, + { Name = "flagToken", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldInstanceExpiration", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldInstanceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "instanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldInstanceRunTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldMapIconScale", + Type = "Function", + + Returns = + { + { Name = "scale", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldPortExpiration", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "expiration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldPosition", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "unitX", Type = "UnitToken", Nilable = false }, + { Name = "unitY", Type = "UnitToken", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldScore", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", 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 = "race", Type = "string", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "classToken", Type = "string", Nilable = false }, + { Name = "damageDone", Type = "number", Nilable = false }, + { Name = "healingDone", Type = "number", Nilable = false }, + { Name = "bgRating", Type = "number", Nilable = false }, + { Name = "ratingChange", Type = "number", Nilable = false }, + { Name = "preMatchMMR", Type = "number", Nilable = false }, + { Name = "mmrChange", Type = "number", Nilable = false }, + { Name = "talentSpec", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldStatData", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "statIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "columnData", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldStatInfo", + Type = "Function", + + Arguments = + { + { Name = "statIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldStatus", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "string", Nilable = false }, + { Name = "mapName", Type = "string", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + { Name = "bracketMin", Type = "number", Nilable = false }, + { Name = "bracketMax", Type = "number", Nilable = false }, + { Name = "teamSize", Type = "number", Nilable = false }, + { Name = "registeredMatch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldTeamInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "teamName", Type = "string", Nilable = false }, + { Name = "teamRating", Type = "number", Nilable = false }, + { Name = "newTeamRating", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldTimeWaited", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "timeInQueue", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldVehicleInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "vehicleX", Type = "number", Nilable = false }, + { Name = "vehicleY", Type = "number", Nilable = false }, + { Name = "unitName", Type = "string", Nilable = false }, + { Name = "isPossessed", Type = "bool", Nilable = false }, + { Name = "vehicleType", Type = "string", Nilable = false }, + { Name = "orientation", Type = "number", Nilable = false }, + { Name = "isPlayer", Type = "bool", Nilable = false }, + { Name = "isAlive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBattlefieldWinner", + Type = "Function", + + Returns = + { + { Name = "winner", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBattlegroundInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "canEnter", Type = "bool", Nilable = false }, + { Name = "isHoliday", Type = "bool", Nilable = false }, + { Name = "minlevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlefieldFlagPositions", + Type = "Function", + + Returns = + { + { Name = "numFlags", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlefieldPositions", + Type = "Function", + + Returns = + { + { Name = "numTeamMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlefieldScores", + Type = "Function", + + Returns = + { + { Name = "numScores", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlefieldStats", + Type = "Function", + + Returns = + { + { Name = "numStats", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlefieldVehicles", + Type = "Function", + + Returns = + { + { Name = "numVehicles", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlefields", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "numBattlefields", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBattlegroundTypes", + Type = "Function", + + Returns = + { + { Name = "numBattlegrounds", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRealNumPartyMembers", + Type = "Function", + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRealNumRaidMembers", + Type = "Function", + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedBattlefield", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "IsActiveBattlefieldArena", + Type = "Function", + + Returns = + { + { Name = "isArena", Type = "bool", Nilable = false }, + { Name = "isRegistered", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRealPartyLeader", + Type = "Function", + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRealRaidLeader", + Type = "Function", + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "JoinBattlefield", + Type = "Function", + + Returns = + { + { Name = "canGroupJoin", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveBattlefield", + Type = "Function", + + }, + { + Name = "PlayerIsPVPInactive", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "isInactive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReportPlayerIsPVPAFK", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + }, + { + Name = "RequestBattlefieldPositions", + Type = "Function", + + }, + { + Name = "RequestBattlefieldScoreData", + Type = "Function", + + }, + { + Name = "RequestBattlegroundInstanceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetBattlefieldScoreFaction", + Type = "Function", + + Arguments = + { + { Name = "faction", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetSelectedBattlefield", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ShowMiniWorldMapArrowFrame", + Type = "Function", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SortBattlefieldScoreData", + Type = "Function", + + Arguments = + { + { Name = "sortType", Type = "string", Nilable = false }, + }, + + }, + { + Name = "UnitInBattleground", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "raidNum", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BattlefieldsClosed", + Type = "Event", + LiteralName = "BATTLEFIELDS_CLOSED", + }, + { + Name = "BattlefieldsShow", + Type = "Event", + LiteralName = "BATTLEFIELDS_SHOW", + }, + { + Name = "BattlefieldMgrEjected", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_EJECTED", + }, + { + Name = "BattlefieldMgrEjectPending", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_EJECT_PENDING", + }, + { + Name = "BattlefieldMgrEntered", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_ENTERED", + }, + { + Name = "BattlefieldMgrEntryInvite", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_ENTRY_INVITE", + }, + { + Name = "BattlefieldMgrQueueInvite", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_QUEUE_INVITE", + }, + { + Name = "BattlefieldMgrQueueRequestResponse", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_QUEUE_REQUEST_RESPONSE", + }, + { + Name = "BattlefieldMgrStateChange", + Type = "Event", + LiteralName = "BATTLEFIELD_MGR_STATE_CHANGE", + }, + { + Name = "UpdateBattlefieldScore", + Type = "Event", + LiteralName = "UPDATE_BATTLEFIELD_SCORE", + }, + { + Name = "UpdateBattlefieldStatus", + Type = "Event", + LiteralName = "UPDATE_BATTLEFIELD_STATUS", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Battlefield); diff --git a/APIDocumentation/Documentation/BehavioralMessagingDocumentation.lua b/APIDocumentation/Documentation/BehavioralMessagingDocumentation.lua deleted file mode 100644 index b0c3f39..0000000 --- a/APIDocumentation/Documentation/BehavioralMessagingDocumentation.lua +++ /dev/null @@ -1,41 +0,0 @@ -local BehavioralMessaging = -{ - Name = "BehavioralMessaging", - Type = "System", - Namespace = "C_BehavioralMessaging", - - Functions = - { - { - Name = "SendNotificationReceipt", - Type = "Function", - - 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", - 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/APIDocumentation/Documentation/BlackMarketInfoDocumentation.lua b/APIDocumentation/Documentation/BlackMarketInfoDocumentation.lua deleted file mode 100644 index e84d21d..0000000 --- a/APIDocumentation/Documentation/BlackMarketInfoDocumentation.lua +++ /dev/null @@ -1,70 +0,0 @@ -local BlackMarketInfo = -{ - Name = "BlackMarketInfo", - Type = "System", - Namespace = "C_BlackMarketInfo", - - Functions = - { - }, - - Events = - { - { - Name = "BlackMarketBidResult", - Type = "Event", - LiteralName = "BLACK_MARKET_BID_RESULT", - Payload = - { - { Name = "marketID", Type = "number", Nilable = false }, - { Name = "resultCode", Type = "number", Nilable = false }, - }, - }, - { - Name = "BlackMarketClose", - Type = "Event", - LiteralName = "BLACK_MARKET_CLOSE", - }, - { - Name = "BlackMarketItemUpdate", - Type = "Event", - LiteralName = "BLACK_MARKET_ITEM_UPDATE", - }, - { - Name = "BlackMarketOpen", - Type = "Event", - LiteralName = "BLACK_MARKET_OPEN", - }, - { - Name = "BlackMarketOutbid", - Type = "Event", - LiteralName = "BLACK_MARKET_OUTBID", - Payload = - { - { Name = "marketID", Type = "number", Nilable = false }, - { Name = "itemID", Type = "number", Nilable = false }, - }, - }, - { - Name = "BlackMarketUnavailable", - Type = "Event", - LiteralName = "BLACK_MARKET_UNAVAILABLE", - }, - { - Name = "BlackMarketWon", - Type = "Event", - LiteralName = "BLACK_MARKET_WON", - 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/APIDocumentation/Documentation/BlizzardInternalDocumentation.lua b/APIDocumentation/Documentation/BlizzardInternalDocumentation.lua new file mode 100644 index 0000000..f966184 --- /dev/null +++ b/APIDocumentation/Documentation/BlizzardInternalDocumentation.lua @@ -0,0 +1,240 @@ +local BlizzardInternal = +{ + Name = "Blizzard Internal", + Type = "System", + Namespace = "Blizzard Internal", + + Functions = + { + { + Name = "AppendToFile", + Type = "Function", + + }, + { + Name = "CreateMiniWorldMapArrowFrame", + Type = "Function", + + }, + { + Name = "CreateWorldMapArrowFrame", + Type = "Function", + + }, + { + Name = "DeleteFile", + Type = "Function", + + }, + { + Name = "DetectWowMouse", + Type = "Function", + + }, + { + Name = "GMRequestPlayerInfo", + Type = "Function", + + }, + { + Name = "GetDebugStats", + Type = "Function", + + }, + { + Name = "GetDebugZoneMap", + Type = "Function", + + }, + { + Name = "GetGMStatus", + Type = "Function", + + }, + { + Name = "GetMapDebugObjectInfo", + Type = "Function", + + }, + { + Name = "GetNumMapDebugObjects", + Type = "Function", + + }, + { + Name = "HasDebugZoneMap", + Type = "Function", + + }, + { + Name = "IsDebugBuild", + Type = "Function", + + }, + { + Name = "PlayDance", + Type = "Function", + + }, + { + Name = "PositionMiniWorldMapArrowFrame", + Type = "Function", + + }, + { + Name = "PositionWorldMapArrowFrame", + Type = "Function", + + }, + { + Name = "ReadFile", + Type = "Function", + + }, + { + Name = "ResetPerformanceValues", + Type = "Function", + + }, + { + Name = "SetChannelWatch", + Type = "Function", + + }, + { + Name = "SetConsoleKey", + Type = "Function", + + }, + { + Name = "SetLayoutMode", + Type = "Function", + + }, + { + Name = "ShowWorldMapArrowFrame", + Type = "Function", + + }, + { + Name = "TargetDirectionEnemy", + Type = "Function", + + }, + { + Name = "TargetDirectionFinished", + Type = "Function", + + }, + { + Name = "TargetDirectionFriend", + Type = "Function", + + }, + { + Name = "TeleportToDebugObject", + Type = "Function", + + }, + { + Name = "ToggleCollision", + Type = "Function", + + }, + { + Name = "ToggleCollisionDisplay", + Type = "Function", + + }, + { + Name = "TogglePerformanceDisplay", + Type = "Function", + + }, + { + Name = "TogglePerformancePause", + Type = "Function", + + }, + { + Name = "TogglePerformanceValues", + Type = "Function", + + }, + { + Name = "TogglePlayerBounds", + Type = "Function", + + }, + { + Name = "TogglePortals", + Type = "Function", + + }, + { + Name = "ToggleTris", + Type = "Function", + + }, + { + Name = "UpdateWorldMapArrowFrames", + Type = "Function", + + }, + { + Name = "debugbreak", + Type = "Function", + + }, + { + Name = "debugdump", + Type = "Function", + + }, + { + Name = "debuginfo", + Type = "Function", + + }, + { + Name = "debugload", + Type = "Function", + + }, + { + Name = "debugprint", + Type = "Function", + + }, + { + Name = "debugtimestamp", + Type = "Function", + + }, + { + Name = "newproxy", + Type = "Function", + + Arguments = + { + { Name = "boolean", Type = "bool", Nilable = true }, + { Name = "userdata", Type = "userdata", Nilable = true }, + }, + + Returns = + { + { Name = "userdata", Type = "userdata", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(BlizzardInternal); diff --git a/APIDocumentation/Documentation/Blizzard_APIDocumentationGenerated.toc b/APIDocumentation/Documentation/Blizzard_APIDocumentationGenerated.toc deleted file mode 100644 index 48c5593..0000000 --- a/APIDocumentation/Documentation/Blizzard_APIDocumentationGenerated.toc +++ /dev/null @@ -1,278 +0,0 @@ -## Title: Blizzard API Documentation Generated -## Author: Blizzard Entertainment -## LoadOnDemand: 1 -## AllowLoad: Both -## Dependencies: Blizzard_APIDocumentation - -# Start documentation files here -AccountInfoDocumentation.lua -AchievementInfoDocumentation.lua -ActionBarFrameDocumentation.lua -AddOnsDocumentation.lua -AdventureJournalDocumentation.lua -AdventureMapDocumentation.lua -AreaPoiInfoDocumentation.lua -AuctionHouseDocumentation.lua -AzeriteEmpoweredItemDocumentation.lua -AzeriteEssenceDocumentation.lua -AzeriteItemDocumentation.lua -BagIndexConstantsDocumentation.lua -BankDocumentation.lua -BarberShopDocumentation.lua -BattleNetDocumentation.lua -BattlePetDocumentation.lua -BehavioralMessagingDocumentation.lua -BlackMarketInfoDocumentation.lua -BrowserDocumentation.lua -CalendarDocumentation.lua -CameraDocumentation.lua -ChatBubblesDocumentation.lua -ChatInfoDocumentation.lua -CinematicDocumentation.lua -ClassTrialDocumentation.lua -ClientSceneDocumentation.lua -CombatLogDocumentation.lua -CompactUnitFramesDocumentation.lua -ConfigurationWarningsDocumentation.lua -ConsoleDocumentation.lua -ConsoleScriptCollectionDocumentation.lua -ContainerDocumentation.lua -ContributionCollectorDocumentation.lua -CreatureInfoDocumentation.lua -CurrencyInfoDocumentation.lua -CursorDocumentation.lua -DeathInfoDocumentation.lua -DuelInfoDocumentation.lua -EditModeManagerDocumentation.lua -EncounterInfoDocumentation.lua -EquipmentManagerDocumentation.lua -EventUtilsDocumentation.lua -ExpansionDocumentation.lua -FogOfWarDocumentation.lua -FrameAPICooldownDocumentation.lua -FrameAPIFogOfWarFrameDocumentation.lua -GMTicketInfoDocumentation.lua -GamePadDocumentation.lua -GameRulesDocumentation.lua -GlyphInfoDocumentation.lua -GossipInfoDocumentation.lua -GuildBankDocumentation.lua -GuildInfoDocumentation.lua -HeirloomInfoDocumentation.lua -InstanceEncounterDocumentation.lua -ItemDocumentation.lua -ItemSocketInfoDocumentation.lua -ItemTextDocumentation.lua -ItemUpgradeDocumentation.lua -KeyBindingsDocumentation.lua -KnowledgeBaseDocumentation.lua -LFGInfoDocumentation.lua -LFGListInfoDocumentation.lua -LoadingScreenDocumentation.lua -LootDocumentation.lua -LossOfControlDocumentation.lua -MapExplorationDocumentation.lua -MerchantFrameDocumentation.lua -MinimapDocumentation.lua -MinimapFrameAPIDocumentation.lua -NamePlateManagerDocumentation.lua -NewItemsDocumentation.lua -PaperDollInfoDocumentation.lua -PartyInfoDocumentation.lua -PartyPoseUIDocumentation.lua -PetInfoDocumentation.lua -PetJournalInfoDocumentation.lua -PlatformDocumentation.lua -PlayerInfoDocumentation.lua -PlayerInteractionManagerDocumentation.lua -PlayerLocationDocumentation.lua -PvpInfoDocumentation.lua -QuestInfoSystemDocumentation.lua -QuestLineInfoDocumentation.lua -QuestLogDocumentation.lua -QuestOfferDocumentation.lua -QuestSessionDocumentation.lua -QuestTaskInfoDocumentation.lua -RaidLocksDocumentation.lua -ReportSystemDocumentation.lua -ReputationInfoDocumentation.lua -RestrictedActionsDocumentation.lua -ScriptWarningsDocumentation.lua -SecureTransferDocumentation.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 -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 -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 -SocialQueueDocumentation.lua -SoundDocumentation.lua -SpecializationInfoDocumentation.lua -SpellDocumentation.lua -SpellActivationOverlayDocumentation.lua -SpellBookDocumentation.lua -StableInfoDocumentation.lua -StorePublicUIDocumentation.lua -StringUtilDocumentation.lua -SummonInfoDocumentation.lua -TTSSettingsDocumentation.lua -TaxiMapDocumentation.lua -TextureUtilsDocumentation.lua -TooltipComparisonDocumentation.lua -TooltipInfoDocumentation.lua -ToyBoxInfoDocumentation.lua -TradeInfoDocumentation.lua -TrainerDocumentation.lua -TraitConfigDocumentation.lua -TutorialDocumentation.lua -UIColorDocumentation.lua -UIGenericWidgetDisplayDocumentation.lua -UIMacrosDocumentation.lua -UIManagerDocumentation.lua -UIModelInfoDocumentation.lua -UISystemVisibilityManagerDocumentation.lua -UITimerDocumentation.lua -UIWidgetManagerDocumentation.lua -UnitDocumentation.lua -UserFeedbackDocumentation.lua -VehicleDocumentation.lua -VideoDocumentation.lua -VignetteInfoDocumentation.lua -VoiceChatDocumentation.lua -VoidStorageInfoDocumentation.lua -WorldStateInfoDocumentation.lua -WowEntitlementInfoDocumentation.lua -WowTokenUIDocumentation.lua -XMLUtilDocumentation.lua -CVarDocumentation.lua -ClubDocumentation.lua -CommentatorFrameDocumentation.lua -CraftInfoDocumentation.lua -DateAndTimeDocumentation.lua -FriendListDocumentation.lua -MailInfoDocumentation.lua -MapDocumentation.lua -ScriptedAnimationsDocumentation.lua -SeasonsDocumentation.lua -SocialRestrictionsDocumentation.lua -SystemDocumentation.lua -TradeSkillUIDocumentation.lua -UnitAuraDocumentation.lua -AccountConstantsDocumentation.lua -ActionDocumentation.lua -AppearanceSourceDocumentation.lua -AuctionHouseEnumsDocumentation.lua -AzeriteConstantsDocumentation.lua -BagConstantsDocumentation.lua -BaseDocumentation.lua -BattlePetConstantsDocumentation.lua -BountySharedDocumentation.lua -ButtonConstantsDocumentation.lua -CalendarConstantsDocumentation.lua -CharacterCustomizationSharedDocumentation.lua -ChatConstantsDocumentation.lua -ClubSharedDocumentation.lua -ColorDocumentation.lua -CurrencyConstantsDocumentation.lua -CursorConstDocumentation.lua -DamageConstantsDocumentation.lua -EditModeManagerSharedDocumentation.lua -ExpansionLandingPageConstantsDocumentation.lua -GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua -GARRISON_TYPEConstantsDocumentation.lua -GamePadConstDocumentation.lua -GarrisonConstantsDocumentation.lua -GossipConstantsDocumentation.lua -GuildInfoSharedDocumentation.lua -InputConstantsDocumentation.lua -ItemConstantsDocumentation.lua -ItemSharedDocumentation.lua -LFGConstantsDocumentation.lua -LevelConstantsDocumentation.lua -LootConstantsDocumentation.lua -MapConstantsDocumentation.lua -MinimapConstantsDocumentation.lua -ModelSceneDocumentation.lua -NamePlateDocumentation.lua -PVPMgrConstantsDocumentation.lua -PerksVendorConstantsDocumentation.lua -PetBattleConstantsDocumentation.lua -PetScalingConstantsDocumentation.lua -PlayerDocumentation.lua -PlayerInfoSharedDocumentation.lua -PlayerInteractionManagerConstantsDocumentation.lua -PlayerMentorshipConstantsDocumentation.lua -ProfessionConstantsDocumentation.lua -PvPFactionConstantsDocumentation.lua -PvpInfoConstantsDocumentation.lua -QuestConstantsDocumentation.lua -QuestRewardsDocumentation.lua -QuestSessionConstantsDocumentation.lua -QueueSpecificDocumentation.lua -RecruitAFriendSharedDocumentation.lua -ReportSystemConstantsDocumentation.lua -ScriptRegionSharedDocumentation.lua -SharedScriptObjectModelLightDocumentation.lua -SharedTraitsEnumsDocumentation.lua -SimpleHTMLSharedDocumentation.lua -SoftTargetConstantsDocumentation.lua -TextureSharedDocumentation.lua -TimeDocumentation.lua -TooltipConstantsDocumentation.lua -TooltipInfoSharedDocumentation.lua -TradeSkillUITypesDocumentation.lua -TraitConstantsDocumentation.lua -TransmogSharedDocumentation.lua -UIFileAssetSharedDocumentation.lua -UISharedDocumentation.lua -UITextureAssetSharedDocumentation.lua -UIWidgetManagerSharedDocumentation.lua -UiModelSceneConstantsDocumentation.lua -UnitSexConstantsDocumentation.lua -UnitSharedDocumentation.lua -ValidateNameConstantsDocumentation.lua -VectorSharedDocumentation.lua -VignetteConstantsDocumentation.lua -WeeklyRewardsSharedDocumentation.lua -WowLabsConstantsDocumentation.lua -AuctionHouseConstants_ClassicDocumentation.lua -CurrencyConstants_ClassicDocumentation.lua -ItemConstants_ClassicDocumentation.lua -QuestConstants_ClassicDocumentation.lua -SeasonsConstantsDocumentation.lua -# End documentation files here diff --git a/APIDocumentation/Documentation/BountySharedDocumentation.lua b/APIDocumentation/Documentation/BountySharedDocumentation.lua deleted file mode 100644 index 40d5f20..0000000 --- a/APIDocumentation/Documentation/BountySharedDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -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/APIDocumentation/Documentation/BrowserDocumentation.lua b/APIDocumentation/Documentation/BrowserDocumentation.lua deleted file mode 100644 index e13b2b2..0000000 --- a/APIDocumentation/Documentation/BrowserDocumentation.lua +++ /dev/null @@ -1,39 +0,0 @@ -local Browser = -{ - Name = "Browser", - Type = "System", - Namespace = "C_Browser", - - Functions = - { - }, - - Events = - { - { - Name = "SimpleBrowserWebError", - Type = "Event", - LiteralName = "SIMPLE_BROWSER_WEB_ERROR", - Payload = - { - { Name = "errorCode", Type = "number", Nilable = false }, - }, - }, - { - Name = "SimpleBrowserWebProxyFailed", - Type = "Event", - LiteralName = "SIMPLE_BROWSER_WEB_PROXY_FAILED", - }, - { - Name = "SimpleCheckoutClosed", - Type = "Event", - LiteralName = "SIMPLE_CHECKOUT_CLOSED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Browser); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BuffDocumentation.lua b/APIDocumentation/Documentation/BuffDocumentation.lua new file mode 100644 index 0000000..6b31d14 --- /dev/null +++ b/APIDocumentation/Documentation/BuffDocumentation.lua @@ -0,0 +1,117 @@ +local Buff = +{ + Name = "Buff", + Type = "System", + Namespace = "Buff", + + Functions = + { + { + Name = "CancelItemTempEnchantment", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CancelShapeshiftForm", + Type = "Function", + + }, + { + Name = "CancelUnitBuff", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "rank", Type = "string", Nilable = true }, + { Name = "filter", Type = "string", Nilable = true }, + }, + + }, + { + Name = "GetWeaponEnchantInfo", + Type = "Function", + + Returns = + { + { Name = "hasMainHandEnchant", Type = "bool", Nilable = false }, + { Name = "mainHandExpiration", Type = "number", Nilable = false }, + { Name = "mainHandCharges", Type = "number", Nilable = false }, + { Name = "hasOffHandEnchant", Type = "bool", Nilable = false }, + { Name = "offHandExpiration", Type = "number", Nilable = false }, + { Name = "offHandCharges", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAura", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "rank", Type = "string", Nilable = true }, + { Name = "filter", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "dispelType", Type = "string", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "expires", Type = "number", Nilable = false }, + { Name = "caster", Type = "string", Nilable = false }, + { Name = "isStealable", Type = "1nil", Nilable = false }, + { Name = "shouldConsolidate", Type = "bool", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitDebuff", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "rank", Type = "string", Nilable = true }, + { Name = "filter", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "dispelType", Type = "string", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "expires", Type = "number", Nilable = false }, + { Name = "caster", Type = "string", Nilable = false }, + { Name = "isStealable", Type = "1nil", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Buff); diff --git a/APIDocumentation/Documentation/BuildDocumentation.lua b/APIDocumentation/Documentation/BuildDocumentation.lua deleted file mode 100644 index dd0ee87..0000000 --- a/APIDocumentation/Documentation/BuildDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Build = -{ - Name = "Build", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Build); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ButtonConstantsDocumentation.lua b/APIDocumentation/Documentation/ButtonConstantsDocumentation.lua deleted file mode 100644 index 5092d50..0000000 --- a/APIDocumentation/Documentation/ButtonConstantsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local ButtonConstants = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ButtonConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CVarDocumentation.lua b/APIDocumentation/Documentation/CVarDocumentation.lua deleted file mode 100644 index 2c932c0..0000000 --- a/APIDocumentation/Documentation/CVarDocumentation.lua +++ /dev/null @@ -1,124 +0,0 @@ -local CVar = -{ - Name = "CVarScripts", - Type = "System", - Namespace = "C_CVar", - - Functions = - { - { - Name = "GetCVar", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "value", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetCVarBitfield", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "value", Type = "bool", Nilable = true }, - }, - }, - { - Name = "GetCVarBool", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "value", Type = "bool", Nilable = true }, - }, - }, - { - Name = "GetCVarDefault", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "defaultValue", Type = "string", Nilable = true }, - }, - }, - { - Name = "RegisterCVar", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "value", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "ResetTestCVars", - Type = "Function", - }, - { - Name = "SetCVar", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "value", Type = "cstring", Nilable = true }, - { Name = "scriptCVar", Type = "cstring", Nilable = true }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetCVarBitfield", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "index", Type = "luaIndex", Nilable = false }, - { Name = "value", Type = "bool", Nilable = false }, - { Name = "scriptCVar", Type = "cstring", Nilable = true }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(CVar); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CalendarConstantsDocumentation.lua b/APIDocumentation/Documentation/CalendarConstantsDocumentation.lua deleted file mode 100644 index a2a78a1..0000000 --- a/APIDocumentation/Documentation/CalendarConstantsDocumentation.lua +++ /dev/null @@ -1,337 +0,0 @@ -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 = "RaidReset", 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 = 4, - MinValue = 1, - MaxValue = 8, - Fields = - { - { 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 = "RaidReset", 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(CalendarConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CalendarDocumentation.lua b/APIDocumentation/Documentation/CalendarDocumentation.lua index 109847d..16db98e 100644 --- a/APIDocumentation/Documentation/CalendarDocumentation.lua +++ b/APIDocumentation/Documentation/CalendarDocumentation.lua @@ -2,70 +2,68 @@ local Calendar = { Name = "Calendar", Type = "System", - Namespace = "C_Calendar", + Namespace = "Calendar", Functions = { { - Name = "AddEvent", + Name = "CalendarAddEvent", Type = "Function", + }, { - Name = "AreNamesReady", + Name = "CalendarCanAddEvent", Type = "Function", Returns = { - { Name = "ready", Type = "bool", Nilable = false }, + { Name = "canAdd", Type = "bool", Nilable = false }, }, }, { - Name = "CanAddEvent", + Name = "CalendarCanSendInvite", Type = "Function", Returns = { - { Name = "canAddEvent", Type = "bool", Nilable = false }, + { Name = "canInvite", Type = "bool", Nilable = false }, }, }, { - Name = "CanSendInvite", + Name = "CalendarCloseEvent", Type = "Function", - Returns = - { - { Name = "canSendInvite", Type = "bool", Nilable = false }, - }, }, { - Name = "CloseEvent", + Name = "CalendarContextDeselectEvent", Type = "Function", + }, { - Name = "ContextMenuEventCanComplain", + Name = "CalendarContextEventCanComplain", Type = "Function", Arguments = { - { Name = "offsetMonths", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "canComplain", Type = "bool", Nilable = false }, + { Name = "canReport", Type = "bool", Nilable = false }, }, }, { - Name = "ContextMenuEventCanEdit", + Name = "CalendarContextEventCanEdit", Type = "Function", Arguments = { - { Name = "offsetMonths", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = @@ -74,119 +72,230 @@ local Calendar = }, }, { - Name = "ContextMenuEventCanRemove", + Name = "CalendarContextEventClipboard", + Type = "Function", + + Returns = + { + { Name = "canPaste", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarContextEventComplain", Type = "Function", Arguments = { - { Name = "offsetMonths", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", 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", + Name = "CalendarContextEventCopy", Type = "Function", Arguments = { - { Name = "offsetMonths", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, - }, - { - Name = "ContextMenuEventRemove", - Type = "Function", - }, - { - Name = "ContextMenuEventSignUp", - Type = "Function", - }, - { - Name = "ContextMenuGetEventIndex", - Type = "Function", - 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", + Name = "CalendarContextEventGetCalendarType", Type = "Function", Arguments = { - { Name = "offsetMonths", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "calendarType", Type = "string", Nilable = false }, }, }, { - Name = "CreateCommunitySignUpEvent", + Name = "CalendarContextEventPaste", Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + }, + }, { - Name = "CreateGuildAnnouncementEvent", + Name = "CalendarContextEventRemove", Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, { - Name = "CreateGuildSignUpEvent", + Name = "CalendarContextEventSignUp", Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, { - Name = "CreatePlayerEvent", + Name = "CalendarContextGetEventIndex", Type = "Function", + + Returns = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, }, { - Name = "EventAvailable", + Name = "CalendarContextInviteAvailable", Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, { - Name = "EventCanEdit", + Name = "CalendarContextInviteDecline", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CalendarContextInviteIsPending", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "pendingInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarContextInviteModeratorStatus", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "modStatus", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarContextInviteRemove", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CalendarContextInviteStatus", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inviteStatus", Type = "string", Nilable = false }, + }, + }, + { + Name = "CalendarContextInviteType", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inviteType", Type = "string", Nilable = false }, + }, + }, + { + Name = "CalendarContextSelectEvent", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CalendarDefaultGuildFilter", + Type = "Function", + + Returns = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarEventAvailable", + Type = "Function", + + }, + { + Name = "CalendarEventCanEdit", Type = "Function", Returns = @@ -195,74 +304,95 @@ local Calendar = }, }, { - Name = "EventClearAutoApprove", - Type = "Function", - }, - { - Name = "EventClearLocked", - Type = "Function", - }, - { - Name = "EventClearModerator", + Name = "CalendarEventCanModerate", Type = "Function", Arguments = { - { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, - }, - { - Name = "EventDecline", - Type = "Function", - }, - { - Name = "EventGetCalendarType", - Type = "Function", Returns = { - { Name = "calendarType", Type = "string", Nilable = true }, + { Name = "canModerate", Type = "bool", Nilable = false }, }, }, { - Name = "EventGetClubId", + Name = "CalendarEventClearAutoApprove", Type = "Function", - Returns = - { - { Name = "info", Type = "ClubId", Nilable = true }, - }, }, { - Name = "EventGetInvite", + Name = "CalendarEventClearLocked", + Type = "Function", + + }, + { + Name = "CalendarEventClearModerator", Type = "Function", Arguments = { - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + }, + { + Name = "CalendarEventDecline", + Type = "Function", + + }, + { + Name = "CalendarEventGetCalendarType", + Type = "Function", + Returns = { - { Name = "info", Type = "CalendarEventInviteInfo", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, }, }, { - Name = "EventGetInviteResponseTime", + Name = "CalendarEventGetInvite", Type = "Function", Arguments = { - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "time", Type = "CalendarTime", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "className", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "string", Nilable = false }, + { Name = "inviteStatus", Type = "number", Nilable = false }, + { Name = "modStatus", Type = "number", Nilable = false }, + { Name = "inviteIsMine", Type = "bool", Nilable = false }, + { Name = "inviteType", Type = "number", Nilable = false }, }, }, { - Name = "EventGetInviteSortCriterion", + Name = "CalendarEventGetInviteResponseTime", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarEventGetInviteSortCriterion", Type = "Function", Returns = @@ -272,181 +402,164 @@ local Calendar = }, }, { - Name = "EventGetSelectedInvite", + Name = "CalendarEventGetNumInvites", Type = "Function", Returns = { - { Name = "inviteIndex", Type = "luaIndex", Nilable = true }, + { Name = "numInvites", Type = "number", Nilable = false }, }, }, { - Name = "EventGetStatusOptions", - Type = "Function", - - Arguments = - { - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "options", Type = "table", InnerType = "CalendarEventStatusOption", Nilable = false }, - }, - }, - { - Name = "EventGetTextures", - Type = "Function", - - Arguments = - { - { Name = "eventType", Type = "CalendarEventType", Nilable = false }, - }, - - Returns = - { - { Name = "textures", Type = "table", InnerType = "CalendarEventTextureInfo", Nilable = false }, - }, - }, - { - Name = "EventGetTypes", + Name = "CalendarEventGetRepeatOptions", Type = "Function", Returns = { - { Name = "types", Type = "table", InnerType = "string", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, }, }, { - Name = "EventGetTypesDisplayOrdered", + Name = "CalendarEventGetSelectedInvite", Type = "Function", Returns = { - { Name = "infos", Type = "table", InnerType = "CalendarEventTypeDisplayInfo", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, }, { - Name = "EventHasPendingInvite", + Name = "CalendarEventGetStatusOptions", Type = "Function", Returns = { - { Name = "hasPendingInvite", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, }, }, { - Name = "EventHaveSettingsChanged", + Name = "CalendarEventGetTextures", + Type = "Function", + + Arguments = + { + { Name = "eventType", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "expansion", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarEventGetTypes", Type = "Function", Returns = { - { Name = "haveSettingsChanged", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, }, }, { - Name = "EventInvite", + Name = "CalendarEventHasPendingInvite", + Type = "Function", + + Returns = + { + { Name = "pendingInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarEventHaveSettingsChanged", + Type = "Function", + + Returns = + { + { Name = "settingsChanged", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarEventInvite", Type = "Function", Arguments = { - { Name = "name", Type = "cstring", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "CalendarEventIsModerator", + Type = "Function", + + Returns = + { + { Name = "isModerator", Type = "bool", Nilable = false }, }, }, { - Name = "EventRemoveInvite", + Name = "CalendarEventRemoveInvite", Type = "Function", Arguments = { - { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + }, { - Name = "EventRemoveInviteByGuid", + Name = "CalendarEventSelectInvite", Type = "Function", Arguments = { - { Name = "guid", Type = "WOWGUID", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + }, { - Name = "EventSelectInvite", + Name = "CalendarEventSetAutoApprove", + Type = "Function", + + }, + { + Name = "CalendarEventSetDate", Type = "Function", Arguments = { - { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "EventSetAutoApprove", - Type = "Function", - }, - { - Name = "EventSetClubId", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = true }, - }, - }, - { - Name = "EventSetDate", - Type = "Function", - - Arguments = - { - { Name = "month", Type = "luaIndex", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, { Name = "year", Type = "number", Nilable = false }, }, + }, { - Name = "EventSetDescription", + Name = "CalendarEventSetDescription", + Type = "Function", + + }, + { + Name = "CalendarEventSetLocked", + Type = "Function", + + }, + { + Name = "CalendarEventSetLockoutDate", Type = "Function", Arguments = { - { Name = "description", Type = "cstring", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, }, - }, - { - Name = "EventSetInviteStatus", - Type = "Function", - Arguments = - { - { Name = "eventIndex", Type = "luaIndex", Nilable = false }, - { Name = "status", Type = "CalendarStatus", Nilable = false }, - }, }, { - Name = "EventSetLocked", - Type = "Function", - }, - { - Name = "EventSetModerator", - Type = "Function", - - Arguments = - { - { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "EventSetTextureID", - Type = "Function", - - Arguments = - { - { Name = "textureIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "EventSetTime", + Name = "CalendarEventSetLockoutTime", Type = "Function", Arguments = @@ -454,372 +567,470 @@ local Calendar = { Name = "hour", Type = "number", Nilable = false }, { Name = "minute", Type = "number", Nilable = false }, }, + }, { - Name = "EventSetTitle", + Name = "CalendarEventSetModerator", Type = "Function", Arguments = { - { Name = "title", Type = "cstring", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + }, { - Name = "EventSetType", + Name = "CalendarEventSetRepeatOption", Type = "Function", Arguments = { - { Name = "typeIndex", Type = "CalendarEventType", Nilable = false }, + { Name = "title", Type = "number", Nilable = false }, }, + }, { - Name = "EventSignUp", - Type = "Function", - }, - { - Name = "EventSortInvites", + Name = "CalendarEventSetSize", Type = "Function", Arguments = { - { Name = "criterion", Type = "cstring", Nilable = false }, + { Name = "size", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CalendarEventSetStatus", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "inviteStatus", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CalendarEventSetTextureID", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CalendarEventSetTime", + Type = "Function", + + Arguments = + { + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CalendarEventSetTitle", + Type = "Function", + + Arguments = + { + { Name = "title", Type = "string", Nilable = false }, + }, + + }, + { + Name = "CalendarEventSetType", + Type = "Function", + + Arguments = + { + { Name = "eventType", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CalendarEventSignUp", + Type = "Function", + + }, + { + Name = "CalendarEventSortInvites", + Type = "Function", + + Arguments = + { + { Name = "criterion", Type = "string", Nilable = false }, { Name = "reverse", Type = "bool", Nilable = false }, }, + }, { - Name = "EventTentative", - Type = "Function", - }, - { - Name = "GetClubCalendarEvents", + Name = "CalendarGetAbsMonth", Type = "Function", Arguments = { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "startTime", Type = "CalendarTime", Nilable = false }, - { Name = "endTime", Type = "CalendarTime", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, }, Returns = { - { Name = "events", Type = "table", InnerType = "CalendarDayEvent", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "numDays", Type = "number", Nilable = false }, + { Name = "firstWeekday", Type = "number", Nilable = false }, }, }, { - Name = "GetDayEvent", + Name = "CalendarGetDate", + Type = "Function", + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetDayEvent", Type = "Function", Arguments = { { Name = "monthOffset", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "event", Type = "CalendarDayEvent", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "sequenceType", Type = "string", Nilable = false }, + { Name = "eventType", Type = "number", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "modStatus", Type = "number", Nilable = false }, + { Name = "inviteStatus", Type = "string", Nilable = false }, + { Name = "invitedBy", Type = "string", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, + { Name = "inviteType", Type = "string", Nilable = false }, }, }, { - Name = "GetDefaultGuildFilter", + Name = "CalendarGetEventIndex", Type = "Function", Returns = { - { Name = "info", Type = "CalendarGuildFilterInfo", Nilable = false }, + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, }, { - Name = "GetEventIndex", + Name = "CalendarGetEventInfo", Type = "Function", Returns = { - { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "creator", Type = "string", Nilable = false }, + { Name = "eventType", Type = "number", Nilable = false }, + { Name = "repeatOption", Type = "number", Nilable = false }, + { Name = "maxSize", Type = "number", Nilable = false }, + { Name = "textureIndex", Type = "luaIndex", Nilable = false }, + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + { Name = "lockoutWeekday", Type = "number", Nilable = false }, + { Name = "lockoutMonth", Type = "number", Nilable = false }, + { Name = "lockoutDay", Type = "number", Nilable = false }, + { Name = "lockoutYear", Type = "number", Nilable = false }, + { Name = "lockoutHour", Type = "number", Nilable = false }, + { Name = "lockoutMinute", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + { Name = "autoApprove", Type = "bool", Nilable = false }, + { Name = "pendingInvite", Type = "bool", Nilable = false }, + { Name = "inviteStatus", Type = "number", Nilable = false }, + { Name = "inviteType", Type = "number", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, }, }, { - Name = "GetEventIndexInfo", + Name = "CalendarGetFirstPendingInvite", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CalendarGetHolidayInfo", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "CalendarGetMaxCreateDate", + Type = "Function", + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetMaxDate", + Type = "Function", + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetMinDate", + Type = "Function", + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetMinHistoryDate", + Type = "Function", + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetMonth", Type = "Function", 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 = "month", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "numDays", Type = "number", Nilable = false }, + { Name = "firstWeekday", Type = "number", Nilable = false }, }, }, { - Name = "GetEventInfo", + Name = "CalendarGetMonthNames", Type = "Function", Returns = { - { Name = "info", Type = "CalendarEventInfo", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, }, }, { - Name = "GetFirstPendingInvite", - Type = "Function", - - Arguments = - { - { Name = "offsetMonths", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "firstPendingInvite", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "GetGuildEventInfo", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "CalendarGuildEventInfo", Nilable = false }, - }, - }, - { - Name = "GetGuildEventSelectionInfo", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, - }, - }, - { - Name = "GetHolidayInfo", + Name = "CalendarGetNumDayEvents", Type = "Function", Arguments = { { Name = "monthOffset", Type = "number", Nilable = false }, - { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numEvents", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetNumPendingInvites", + Type = "Function", + + Returns = + { + { Name = "numInvites", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarGetRaidInfo", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "event", Type = "CalendarHolidayInfo", Nilable = false }, + { Name = "title", Type = "number", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "raidID", Type = "number", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, }, }, { - Name = "GetMaxCreateDate", + Name = "CalendarGetWeekdayNames", Type = "Function", Returns = { - { Name = "maxCreateDate", Type = "CalendarTime", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, }, }, { - Name = "GetMinDate", + Name = "CalendarIsActionPending", Type = "Function", Returns = { - { Name = "minDate", Type = "CalendarTime", Nilable = false }, + { Name = "isPending", Type = "bool", Nilable = false }, }, }, { - Name = "GetMonthInfo", + Name = "CalendarMassInviteArenaTeam", Type = "Function", Arguments = { - { Name = "offsetMonths", Type = "number", Nilable = false, Default = 0 }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, - Returns = - { - { Name = "monthInfo", Type = "CalendarMonthInfo", Nilable = false }, - }, }, { - Name = "GetNextClubId", - Type = "Function", - - Returns = - { - { Name = "clubId", Type = "ClubId", Nilable = true }, - }, - }, - { - Name = "GetNumDayEvents", - Type = "Function", - - 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", - - 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", - - 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", + Name = "CalendarMassInviteGuild", Type = "Function", Arguments = { { Name = "minLevel", Type = "number", Nilable = false }, { Name = "maxLevel", Type = "number", Nilable = false }, - { Name = "maxRankOrder", Type = "luaIndex", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CalendarNewEvent", + Type = "Function", + + }, + { + Name = "CalendarNewGuildAnnouncement", + Type = "Function", + + }, + { + Name = "CalendarNewGuildEvent", + Type = "Function", + + }, + { + Name = "CalendarOpenEvent", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CalendarRemoveEvent", + Type = "Function", + + }, + { + Name = "CalendarSetAbsMonth", + Type = "Function", + + Arguments = + { + { Name = "month", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = true }, + }, + + }, + { + Name = "CalendarSetMonth", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CalendarUpdateEvent", + Type = "Function", + + }, + { + Name = "CanEditGuildEvent", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, }, }, { Name = "OpenCalendar", Type = "Function", - }, - { - Name = "OpenEvent", - Type = "Function", - 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", - - Arguments = - { - { Name = "month", Type = "luaIndex", Nilable = false }, - { Name = "year", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMonth", - Type = "Function", - - Arguments = - { - { Name = "offsetMonths", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetNextClubId", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = true }, - }, - }, - { - Name = "UpdateEvent", - Type = "Function", }, }, @@ -829,10 +1040,6 @@ local Calendar = Name = "CalendarActionPending", Type = "Event", LiteralName = "CALENDAR_ACTION_PENDING", - Payload = - { - { Name = "pending", Type = "bool", Nilable = false }, - }, }, { Name = "CalendarCloseEvent", @@ -843,59 +1050,21 @@ local Calendar = Name = "CalendarEventAlarm", Type = "Event", LiteralName = "CALENDAR_EVENT_ALARM", - 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", - Payload = - { - { Name = "isCopy", Type = "bool", Nilable = false }, - }, }, { Name = "CalendarOpenEvent", Type = "Event", LiteralName = "CALENDAR_OPEN_EVENT", - Payload = - { - { Name = "calendarType", Type = "cstring", Nilable = false }, - }, }, { Name = "CalendarUpdateError", Type = "Event", LiteralName = "CALENDAR_UPDATE_ERROR", - Payload = - { - { Name = "errorReason", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "CalendarUpdateErrorWithCount", - Type = "Event", - LiteralName = "CALENDAR_UPDATE_ERROR_WITH_COUNT", - Payload = - { - { Name = "errorReason", Type = "cstring", Nilable = false }, - { Name = "count", Type = "number", Nilable = false }, - }, - }, - { - Name = "CalendarUpdateErrorWithPlayerName", - Type = "Event", - LiteralName = "CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME", - Payload = - { - { Name = "errorReason", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - }, }, { Name = "CalendarUpdateEvent", @@ -907,19 +1076,10 @@ local Calendar = Type = "Event", LiteralName = "CALENDAR_UPDATE_EVENT_LIST", }, - { - Name = "CalendarUpdateGuildEvents", - Type = "Event", - LiteralName = "CALENDAR_UPDATE_GUILD_EVENTS", - }, { Name = "CalendarUpdateInviteList", Type = "Event", LiteralName = "CALENDAR_UPDATE_INVITE_LIST", - Payload = - { - { Name = "hasCompleteList", Type = "bool", Nilable = true }, - }, }, { Name = "CalendarUpdatePendingInvites", @@ -930,183 +1090,7 @@ local Calendar = 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 +APIDocumentation:AddDocumentationTable(Calendar); diff --git a/APIDocumentation/Documentation/CameraDocumentation.lua b/APIDocumentation/Documentation/CameraDocumentation.lua index 68c6b55..de87f3c 100644 --- a/APIDocumentation/Documentation/CameraDocumentation.lua +++ b/APIDocumentation/Documentation/CameraDocumentation.lua @@ -2,21 +2,174 @@ local Camera = { Name = "Camera", Type = "System", - Namespace = "C_CameraDefaults", + Namespace = "Camera", Functions = { { - Name = "GetCameraFOVDefaults", + Name = "CameraOrSelectOrMoveStart", + Type = "Function", + + }, + { + Name = "CameraOrSelectOrMoveStop", + Type = "Function", + + Arguments = + { + { Name = "isSticky", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "CameraZoomIn", + Type = "Function", + + Arguments = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CameraZoomOut", + Type = "Function", + + Arguments = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + + }, + { + Name = "FlipCameraYaw", + Type = "Function", + + Arguments = + { + { Name = "degrees", Type = "number", Nilable = false }, + }, + + }, + { + Name = "IsMouselooking", Type = "Function", Returns = { - { Name = "fieldOfViewDegreesDefault", Type = "number", Nilable = false }, - { Name = "fieldOfViewDegreesPlayerMin", Type = "number", Nilable = false }, - { Name = "fieldOfViewDegreesPlayerMax", Type = "number", Nilable = false }, + { Name = "isLooking", Type = "bool", Nilable = false }, }, }, + { + Name = "MouselookStart", + Type = "Function", + + }, + { + Name = "MouselookStop", + Type = "Function", + + }, + { + Name = "MoveViewDownStart", + Type = "Function", + + }, + { + Name = "MoveViewDownStop", + Type = "Function", + + }, + { + Name = "MoveViewInStart", + Type = "Function", + + }, + { + Name = "MoveViewInStop", + Type = "Function", + + }, + { + Name = "MoveViewLeftStart", + Type = "Function", + + }, + { + Name = "MoveViewLeftStop", + Type = "Function", + + }, + { + Name = "MoveViewOutStart", + Type = "Function", + + }, + { + Name = "MoveViewOutStop", + Type = "Function", + + }, + { + Name = "MoveViewRightStart", + Type = "Function", + + }, + { + Name = "MoveViewRightStop", + Type = "Function", + + }, + { + Name = "MoveViewUpStart", + Type = "Function", + + }, + { + Name = "MoveViewUpStop", + Type = "Function", + + }, + { + Name = "NextView", + Type = "Function", + + }, + { + Name = "PrevView", + Type = "Function", + + }, + { + Name = "ResetView", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SaveView", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetView", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, }, Events = @@ -28,4 +181,4 @@ local Camera = }, }; -APIDocumentation:AddDocumentationTable(Camera); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Camera); diff --git a/APIDocumentation/Documentation/ChannelDocumentation.lua b/APIDocumentation/Documentation/ChannelDocumentation.lua new file mode 100644 index 0000000..b4cf0a0 --- /dev/null +++ b/APIDocumentation/Documentation/ChannelDocumentation.lua @@ -0,0 +1,842 @@ +local Channel = +{ + Name = "Channel", + Type = "System", + Namespace = "Channel", + + Functions = + { + { + Name = "AddChatWindowChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "channel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "zoneChannel", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelBan", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelInvite", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelKick", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelModerator", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelMute", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelSilenceAll", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelSilenceVoice", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelToggleAnnouncements", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelUnSilenceAll", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelUnSilenceVoice", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelUnban", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelUnmoderator", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ChannelUnmute", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelVoiceOff", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = true }, + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "ChannelVoiceOn", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = true }, + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "ClearChannelWatch", + Type = "Function", + + }, + { + Name = "CollapseChannelHeader", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "DeclineInvite", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + }, + + }, + { + Name = "DisplayChannelOwner", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = true }, + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "DisplayChannelVoiceOff", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "DisplayChannelVoiceOn", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "EnumerateServerChannels", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "ExpandChannelHeader", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetActiveVoiceChannel", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetChannelDisplayInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "header", Type = "1nil", Nilable = false }, + { Name = "collapsed", Type = "1nil", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "active", Type = "1nil", Nilable = false }, + { Name = "category", Type = "string", Nilable = false }, + { Name = "voiceEnabled", Type = "1nil", Nilable = false }, + { Name = "voiceActive", Type = "1nil", Nilable = false }, + }, + }, + { + Name = "GetChannelList", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetChannelName", + Type = "Function", + + Arguments = + { + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + { Name = "channelName", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "channel", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetChannelRosterInfo", + Type = "Function", + + Arguments = + { + { Name = "index", 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 = "muted", Type = "bool", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetChatWindowChannels", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "channelId", Type = "number", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetNumChannelMembers", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumDisplayChannels", + Type = "Function", + + Returns = + { + { Name = "channelCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedDisplayChannel", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "IsDisplayChannelModerator", + Type = "Function", + + Returns = + { + { Name = "isModerator", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsDisplayChannelOwner", + Type = "Function", + + Returns = + { + { Name = "isOwner", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSilenced", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "JoinChannelByName", + Type = "Function", + + }, + { + Name = "JoinPermanentChannel", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "password", Type = "string", Nilable = false }, + { Name = "chatFrameIndex", Type = "luaIndex", Nilable = false }, + { Name = "enableVoice", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "zoneChannel", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + }, + }, + { + Name = "JoinTemporaryChannel", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + }, + + }, + { + Name = "LeaveChannelByName", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ListChannelByName", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = true }, + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "ListChannels", + Type = "Function", + + }, + { + Name = "RemoveChatWindowChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetActiveVoiceChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetActiveVoiceChannelBySessionID", + Type = "Function", + + Arguments = + { + { Name = "session", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetChannelOwner", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetChannelPassword", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = false }, + { Name = "password", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetSelectedDisplayChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SilenceMember", + Type = "Function", + + }, + { + Name = "UnSilenceMember", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "BnChatChannelClosed", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_CLOSED", + }, + { + Name = "BnChatChannelCreateFailed", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_CREATE_FAILED", + }, + { + Name = "BnChatChannelCreateSucceeded", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_CREATE_SUCCEEDED", + }, + { + Name = "BnChatChannelInviteFailed", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_INVITE_FAILED", + }, + { + Name = "BnChatChannelInviteSucceeded", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_INVITE_SUCCEEDED", + }, + { + Name = "BnChatChannelJoined", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_JOINED", + }, + { + Name = "BnChatChannelLeft", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_LEFT", + }, + { + Name = "BnChatChannelMemberJoined", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_MEMBER_JOINED", + }, + { + Name = "BnChatChannelMemberLeft", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_MEMBER_LEFT", + }, + { + Name = "BnChatChannelMemberUpdated", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_MEMBER_UPDATED", + }, + { + Name = "BnChatChannelMessageBlocked", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_MESSAGE_BLOCKED", + }, + { + Name = "BnChatChannelMessageUndeliverable", + Type = "Event", + LiteralName = "BN_CHAT_CHANNEL_MESSAGE_UNDELIVERABLE", + }, + { + Name = "ChannelCountUpdate", + Type = "Event", + LiteralName = "CHANNEL_COUNT_UPDATE", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelFlagsUpdated", + Type = "Event", + LiteralName = "CHANNEL_FLAGS_UPDATED", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelInviteRequest", + Type = "Event", + LiteralName = "CHANNEL_INVITE_REQUEST", + Payload = + { + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "inviterName", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChannelPasswordRequest", + Type = "Event", + LiteralName = "CHANNEL_PASSWORD_REQUEST", + Payload = + { + { Name = "channelName", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChannelRosterUpdate", + Type = "Event", + LiteralName = "CHANNEL_ROSTER_UPDATE", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChannelUiUpdate", + Type = "Event", + LiteralName = "CHANNEL_UI_UPDATE", + }, + { + Name = "ChannelVoiceUpdate", + Type = "Event", + LiteralName = "CHANNEL_VOICE_UPDATE", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatMsgChannel", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ChatMsgChannelJoin", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_JOIN", + Payload = + { + { Name = "unkown", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgChannelLeave", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_LEAVE", + Payload = + { + { Name = "unkown", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgChannelList", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_LIST", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgChannelNotice", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_NOTICE", + }, + { + Name = "ChatMsgChannelNoticeUser", + Type = "Event", + LiteralName = "CHAT_MSG_CHANNEL_NOTICE_USER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastChannelStart", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_CHANNEL_START", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "lineID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "spellID", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastChannelStop", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_CHANNEL_STOP", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastChannelUpdate", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_CHANNEL_UPDATE", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "lineID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "spellID", Nilable = false }, + }, + }, + { + Name = "VoiceChannelStatusUpdate", + Type = "Event", + LiteralName = "VOICE_CHANNEL_STATUS_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Channel); diff --git a/APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua b/APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua deleted file mode 100644 index 06f8bb8..0000000 --- a/APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua +++ /dev/null @@ -1,116 +0,0 @@ -local CharacterCustomizationShared = -{ - Tables = - { - { - Name = "CharCustomizationType", - Type = "Enumeration", - NumValues = 12, - MinValue = 0, - MaxValue = 11, - 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 = "Outfit", Type = "CharCustomizationType", EnumValue = 9 }, - { Name = "Facepaint", Type = "CharCustomizationType", EnumValue = 10 }, - { Name = "FacepaintColor", Type = "CharCustomizationType", EnumValue = 11 }, - }, - }, - { - Name = "ChrCustomizationCategoryFlag", - Type = "Enumeration", - NumValues = 1, - MinValue = 1, - MaxValue = 1, - Fields = - { - { Name = "UndressModel", Type = "ChrCustomizationCategoryFlag", EnumValue = 1 }, - }, - }, - { - Name = "ChrCustomizationOptionType", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "SelectionPopout", Type = "ChrCustomizationOptionType", EnumValue = 0 }, - { Name = "Checkbox", Type = "ChrCustomizationOptionType", EnumValue = 1 }, - { Name = "Slider", Type = "ChrCustomizationOptionType", EnumValue = 2 }, - }, - }, - { - Name = "CustomizationScope", - Type = "Enumeration", - NumValues = 2, - MinValue = 0, - MaxValue = 1, - Fields = - { - { Name = "Player", Type = "CustomizationScope", EnumValue = 0 }, - { Name = "DragonCompanion", Type = "CustomizationScope", EnumValue = 1 }, - }, - }, - { - Name = "CharCustomizationCategory", - Type = "Structure", - Fields = - { - { Name = "id", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "name", Type = "string", Nilable = false }, - { Name = "icon", Type = "textureAtlas", Nilable = false }, - { Name = "selectedIcon", Type = "textureAtlas", Nilable = false }, - { Name = "undressModel", 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 = "CharCustomizationChoice", - Type = "Structure", - Fields = - { - { Name = "id", Type = "number", Nilable = false }, - { Name = "name", Type = "string", 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 = "CharCustomizationOption", - Type = "Structure", - Fields = - { - { Name = "id", Type = "number", Nilable = false }, - { Name = "name", Type = "string", 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/APIDocumentation/Documentation/ChatBubblesDocumentation.lua b/APIDocumentation/Documentation/ChatBubblesDocumentation.lua deleted file mode 100644 index 8985871..0000000 --- a/APIDocumentation/Documentation/ChatBubblesDocumentation.lua +++ /dev/null @@ -1,34 +0,0 @@ -local ChatBubbles = -{ - Name = "ChatBubbles", - Type = "System", - Namespace = "C_ChatBubbles", - - Functions = - { - { - Name = "GetAllChatBubbles", - Type = "Function", - - 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/APIDocumentation/Documentation/ChatConstantsDocumentation.lua b/APIDocumentation/Documentation/ChatConstantsDocumentation.lua deleted file mode 100644 index 81bc9f0..0000000 --- a/APIDocumentation/Documentation/ChatConstantsDocumentation.lua +++ /dev/null @@ -1,156 +0,0 @@ -local ChatConstants = -{ - Tables = - { - { - 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 = "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 = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "CanWhisper", Type = "ChatWhisperTargetStatus", EnumValue = 0 }, - { Name = "Offline", Type = "ChatWhisperTargetStatus", EnumValue = 1 }, - { Name = "WrongFaction", Type = "ChatWhisperTargetStatus", EnumValue = 2 }, - }, - }, - { - 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 = "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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(ChatConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ChatDocumentation.lua b/APIDocumentation/Documentation/ChatDocumentation.lua new file mode 100644 index 0000000..9afb0dd --- /dev/null +++ b/APIDocumentation/Documentation/ChatDocumentation.lua @@ -0,0 +1,1054 @@ +local Chat = +{ + Name = "Chat", + Type = "System", + Namespace = "Chat", + + Functions = + { + { + Name = "AddChatWindowChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "channel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "zoneChannel", Type = "number", Nilable = false }, + }, + }, + { + Name = "AddChatWindowMessages", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "messageGroup", Type = "string", Nilable = false }, + }, + + }, + { + Name = "CanComplainChat", + Type = "Function", + + Arguments = + { + { Name = "lineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canComplain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChangeChatColor", + Type = "Function", + + Arguments = + { + { Name = "messageType", Type = "string", Nilable = false }, + { Name = "red", Type = "number", Nilable = false }, + { Name = "green", Type = "number", Nilable = false }, + { Name = "blue", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ChatFrame_AddMessageEventFilter", + Type = "Function", + + Arguments = + { + { Name = "event", Type = "string", Nilable = false }, + { Name = "filter", Type = "function", Nilable = false }, + }, + + }, + { + Name = "ChatFrame_GetMessageEventFilters", + Type = "Function", + + Arguments = + { + { Name = "event", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "filterTable", Type = "table", Nilable = false }, + }, + }, + { + Name = "ChatFrame_RemoveMessageEventFilter", + Type = "Function", + + Arguments = + { + { Name = "event", Type = "string", Nilable = false }, + { Name = "filter", Type = "function", Nilable = false }, + }, + + }, + { + Name = "ComplainChat", + Type = "Function", + + Arguments = + { + { Name = "lineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canComplain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoEmote", + Type = "Function", + + Arguments = + { + { Name = "emote", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "hold", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "GetChatTypeIndex", + Type = "Function", + + Arguments = + { + { Name = "messageGroup", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetChatWindowChannels", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "channelId", Type = "number", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetChatWindowInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "fontSize", Type = "number", Nilable = false }, + { Name = "r", Type = "number", Nilable = false }, + { Name = "g", Type = "number", Nilable = false }, + { Name = "b", Type = "number", Nilable = false }, + { Name = "alpha", Type = "number", Nilable = false }, + { Name = "shown", Type = "number", Nilable = false }, + { Name = "locked", Type = "number", Nilable = false }, + { Name = "docked", Type = "number", Nilable = false }, + { Name = "uninteractable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetChatWindowMessages", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetDefaultLanguage", + Type = "Function", + + Returns = + { + { Name = "language", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetLanguageByIndex", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "language", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumLanguages", + Type = "Function", + + Returns = + { + { Name = "languages", Type = "number", Nilable = false }, + }, + }, + { + Name = "LoggingChat", + Type = "Function", + + Arguments = + { + { Name = "toggle", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "isLogging", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LoggingCombat", + Type = "Function", + + Arguments = + { + { Name = "toggle", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "isLogging", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RandomRoll", + Type = "Function", + + Arguments = + { + { Name = "min", Type = "string", Nilable = false }, + { Name = "max", Type = "string", Nilable = false }, + }, + + }, + { + Name = "RemoveChatWindowChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + }, + + }, + { + Name = "RemoveChatWindowMessages", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "messageGroup", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ResetChatColors", + Type = "Function", + + }, + { + Name = "ResetChatWindows", + Type = "Function", + + }, + { + Name = "SendChatMessage", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "chatType", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channel", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SetChatWindowAlpha", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "alpha", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowColor", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "r", Type = "number", Nilable = false }, + { Name = "g", Type = "number", Nilable = false }, + { Name = "b", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowDocked", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "docked", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowLocked", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowName", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowShown", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "shown", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowSize", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "size", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowUninteractable", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "setUninteractable", Type = "bool", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "BnChatWhisperUndeliverable", + Type = "Event", + LiteralName = "BN_CHAT_WHISPER_UNDELIVERABLE", + }, + { + Name = "ChatMsgAddon", + Type = "Event", + LiteralName = "CHAT_MSG_ADDON", + Payload = + { + { Name = "prefix", Type = "string", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChatMsgAfk", + Type = "Event", + LiteralName = "CHAT_MSG_AFK", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "senderGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ChatMsgBattleground", + Type = "Event", + LiteralName = "CHAT_MSG_BATTLEGROUND", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgBattlegroundLeader", + Type = "Event", + LiteralName = "CHAT_MSG_BATTLEGROUND_LEADER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "author", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChatMsgBgSystemAlliance", + Type = "Event", + LiteralName = "CHAT_MSG_BG_SYSTEM_ALLIANCE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChatMsgBgSystemHorde", + Type = "Event", + LiteralName = "CHAT_MSG_BG_SYSTEM_HORDE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChatMsgBgSystemNeutral", + Type = "Event", + LiteralName = "CHAT_MSG_BG_SYSTEM_NEUTRAL", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "ChatMsgBnConversation", + Type = "Event", + LiteralName = "CHAT_MSG_BN_CONVERSATION", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "presenceID", Type = "presenceID", Nilable = false }, + { Name = "unknown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatMsgBnConversationList", + Type = "Event", + LiteralName = "CHAT_MSG_BN_CONVERSATION_LIST", + }, + { + Name = "ChatMsgBnConversationNotice", + Type = "Event", + LiteralName = "CHAT_MSG_BN_CONVERSATION_NOTICE", + Payload = + { + { Name = "message/status", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "presenceID", Type = "presenceID", Nilable = false }, + { Name = "unknown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatMsgBnInlineToastAlert", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_ALERT", + }, + { + Name = "ChatMsgBnInlineToastBroadcast", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_BROADCAST", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "presenceID", Type = "presenceID", Nilable = false }, + { Name = "unknown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatMsgBnInlineToastBroadcastInform", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ChatMsgBnInlineToastConversation", + Type = "Event", + LiteralName = "CHAT_MSG_BN_INLINE_TOAST_CONVERSATION", + }, + { + Name = "ChatMsgBnWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_BN_WHISPER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "unknown", Type = "string", Nilable = false }, + { Name = "presenceID", Type = "presenceID", Nilable = false }, + { Name = "unknown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ChatMsgBnWhisperInform", + Type = "Event", + LiteralName = "CHAT_MSG_BN_WHISPER_INFORM", + }, + { + Name = "ChatMsgDnd", + Type = "Event", + LiteralName = "CHAT_MSG_DND", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgEmote", + Type = "Event", + LiteralName = "CHAT_MSG_EMOTE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgFiltered", + Type = "Event", + LiteralName = "CHAT_MSG_FILTERED", + }, + { + Name = "ChatMsgIgnored", + Type = "Event", + LiteralName = "CHAT_MSG_IGNORED", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgLoot", + Type = "Event", + LiteralName = "CHAT_MSG_LOOT", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgMonsterEmote", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_EMOTE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgMonsterSay", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_SAY", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgMonsterWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_WHISPER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgMonsterYell", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_YELL", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgOfficer", + Type = "Event", + LiteralName = "CHAT_MSG_OFFICER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgOpening", + Type = "Event", + LiteralName = "CHAT_MSG_OPENING", + }, + { + Name = "ChatMsgPetInfo", + Type = "Event", + LiteralName = "CHAT_MSG_PET_INFO", + }, + { + Name = "ChatMsgRaid", + Type = "Event", + LiteralName = "CHAT_MSG_RAID", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgRaidBossEmote", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_BOSS_EMOTE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgRaidBossWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_BOSS_WHISPER", + }, + { + Name = "ChatMsgRaidLeader", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_LEADER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgRaidWarning", + Type = "Event", + LiteralName = "CHAT_MSG_RAID_WARNING", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgRestricted", + Type = "Event", + LiteralName = "CHAT_MSG_RESTRICTED", + }, + { + Name = "ChatMsgSay", + Type = "Event", + LiteralName = "CHAT_MSG_SAY", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgSystem", + Type = "Event", + LiteralName = "CHAT_MSG_SYSTEM", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgTargeticons", + Type = "Event", + LiteralName = "CHAT_MSG_TARGETICONS", + }, + { + Name = "ChatMsgTextEmote", + Type = "Event", + LiteralName = "CHAT_MSG_TEXT_EMOTE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgWhisper", + Type = "Event", + LiteralName = "CHAT_MSG_WHISPER", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "ChatMsgWhisperInform", + Type = "Event", + LiteralName = "CHAT_MSG_WHISPER_INFORM", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgYell", + Type = "Event", + LiteralName = "CHAT_MSG_YELL", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ExecuteChatLine", + Type = "Event", + LiteralName = "EXECUTE_CHAT_LINE", + }, + { + Name = "UpdateChatColor", + Type = "Event", + LiteralName = "UPDATE_CHAT_COLOR", + Payload = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "red", Type = "number", Nilable = false }, + { Name = "green", Type = "number", Nilable = false }, + { Name = "blue", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateChatColorNameByClass", + Type = "Event", + LiteralName = "UPDATE_CHAT_COLOR_NAME_BY_CLASS", + }, + { + Name = "UpdateChatWindows", + Type = "Event", + LiteralName = "UPDATE_CHAT_WINDOWS", + }, + { + Name = "UpdateFloatingChatWindows", + Type = "Event", + LiteralName = "UPDATE_FLOATING_CHAT_WINDOWS", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Chat); diff --git a/APIDocumentation/Documentation/ChatInfoDocumentation.lua b/APIDocumentation/Documentation/ChatInfoDocumentation.lua deleted file mode 100644 index 277aab1..0000000 --- a/APIDocumentation/Documentation/ChatInfoDocumentation.lua +++ /dev/null @@ -1,2158 +0,0 @@ -local ChatInfo = -{ - Name = "ChatInfo", - Type = "System", - Namespace = "C_ChatInfo", - - Functions = - { - { - Name = "CanReportPlayer", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "canReport", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetChannelInfoFromIdentifier", - Type = "Function", - - Arguments = - { - { Name = "channelIdentifier", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "ChatChannelInfo", Nilable = true }, - }, - }, - { - Name = "GetChannelRosterInfo", - Type = "Function", - - 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 = "GetChannelShortcut", - Type = "Function", - - Arguments = - { - { Name = "channelIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "shortcut", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetChannelShortcutForChannelID", - Type = "Function", - - Arguments = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "shortcut", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetChatLineSenderGUID", - Type = "Function", - - Arguments = - { - { Name = "chatLine", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "GetChatLineSenderName", - Type = "Function", - - Arguments = - { - { Name = "chatLine", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "name", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetChatLineText", - Type = "Function", - - Arguments = - { - { Name = "chatLine", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "text", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetChatTypeName", - Type = "Function", - - Arguments = - { - { Name = "typeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "name", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetNumActiveChannels", - Type = "Function", - - Returns = - { - { Name = "numChannels", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetRegisteredAddonMessagePrefixes", - Type = "Function", - - Returns = - { - { Name = "registeredPrefixes", Type = "table", InnerType = "cstring", Nilable = false }, - }, - }, - { - Name = "IsAddonMessagePrefixRegistered", - Type = "Function", - - Arguments = - { - { Name = "prefix", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "isRegistered", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsChatLineCensored", - Type = "Function", - - Arguments = - { - { Name = "chatLine", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isCensored", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsPartyChannelType", - Type = "Function", - - Arguments = - { - { Name = "channelType", Type = "ChatChannelType", Nilable = false }, - }, - - Returns = - { - { Name = "isPartyChannelType", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsValidChatLine", - Type = "Function", - - Arguments = - { - { Name = "chatLine", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "isValid", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RegisterAddonMessagePrefix", - Type = "Function", - Documentation = { "Registers interest in addon messages with this prefix, cannot be an empty string." }, - - Arguments = - { - { Name = "prefix", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "successfulRequest", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ReportServerLag", - Type = "Function", - }, - { - Name = "SendAddonMessage", - Type = "Function", - 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 = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SendAddonMessageLogged", - Type = "Function", - 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 = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SwapChatChannelsByChannelIndex", - Type = "Function", - - Arguments = - { - { Name = "firstChannelIndex", Type = "luaIndex", Nilable = false }, - { Name = "secondChannelIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "UncensorChatLine", - Type = "Function", - - Arguments = - { - { Name = "chatLine", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AlternativeDefaultLanguageChanged", - Type = "Event", - LiteralName = "ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED", - }, - { - Name = "BnChatMsgAddon", - Type = "Event", - LiteralName = "BN_CHAT_MSG_ADDON", - 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 = "ChannelCountUpdate", - Type = "Event", - LiteralName = "CHANNEL_COUNT_UPDATE", - Payload = - { - { Name = "displayIndex", Type = "number", Nilable = false }, - { Name = "count", Type = "number", Nilable = false }, - }, - }, - { - Name = "ChannelFlagsUpdated", - Type = "Event", - LiteralName = "CHANNEL_FLAGS_UPDATED", - Payload = - { - { Name = "displayIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "ChannelInviteRequest", - Type = "Event", - LiteralName = "CHANNEL_INVITE_REQUEST", - Payload = - { - { Name = "channelID", Type = "cstring", Nilable = false }, - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ChannelLeft", - Type = "Event", - LiteralName = "CHANNEL_LEFT", - Payload = - { - { Name = "chatChannelID", Type = "number", Nilable = false }, - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ChannelPasswordRequest", - Type = "Event", - LiteralName = "CHANNEL_PASSWORD_REQUEST", - Payload = - { - { Name = "channelID", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ChannelRosterUpdate", - Type = "Event", - LiteralName = "CHANNEL_ROSTER_UPDATE", - Payload = - { - { Name = "displayIndex", Type = "number", Nilable = false }, - { Name = "count", Type = "number", Nilable = false }, - }, - }, - { - Name = "ChannelUiUpdate", - Type = "Event", - LiteralName = "CHANNEL_UI_UPDATE", - }, - { - Name = "ChatCombatMsgArenaPointsGain", - Type = "Event", - LiteralName = "CHAT_COMBAT_MSG_ARENA_POINTS_GAIN", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgAchievement", - Type = "Event", - LiteralName = "CHAT_MSG_ACHIEVEMENT", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgAddon", - Type = "Event", - LiteralName = "CHAT_MSG_ADDON", - 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", - 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", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBgSystemAlliance", - Type = "Event", - LiteralName = "CHAT_MSG_BG_SYSTEM_ALLIANCE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBgSystemHorde", - Type = "Event", - LiteralName = "CHAT_MSG_BG_SYSTEM_HORDE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBgSystemNeutral", - Type = "Event", - LiteralName = "CHAT_MSG_BG_SYSTEM_NEUTRAL", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBn", - Type = "Event", - LiteralName = "CHAT_MSG_BN", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnInlineToastAlert", - Type = "Event", - LiteralName = "CHAT_MSG_BN_INLINE_TOAST_ALERT", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnInlineToastBroadcast", - Type = "Event", - LiteralName = "CHAT_MSG_BN_INLINE_TOAST_BROADCAST", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnInlineToastBroadcastInform", - Type = "Event", - LiteralName = "CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnInlineToastConversation", - Type = "Event", - LiteralName = "CHAT_MSG_BN_INLINE_TOAST_CONVERSATION", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnWhisper", - Type = "Event", - LiteralName = "CHAT_MSG_BN_WHISPER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnWhisperInform", - Type = "Event", - LiteralName = "CHAT_MSG_BN_WHISPER_INFORM", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgBnWhisperPlayerOffline", - Type = "Event", - LiteralName = "CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgChannel", - Type = "Event", - LiteralName = "CHAT_MSG_CHANNEL", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgChannelJoin", - Type = "Event", - LiteralName = "CHAT_MSG_CHANNEL_JOIN", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgChannelLeave", - Type = "Event", - LiteralName = "CHAT_MSG_CHANNEL_LEAVE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgChannelList", - Type = "Event", - LiteralName = "CHAT_MSG_CHANNEL_LIST", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgChannelNotice", - Type = "Event", - LiteralName = "CHAT_MSG_CHANNEL_NOTICE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgChannelNoticeUser", - Type = "Event", - LiteralName = "CHAT_MSG_CHANNEL_NOTICE_USER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgCombatFactionChange", - Type = "Event", - LiteralName = "CHAT_MSG_COMBAT_FACTION_CHANGE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgCombatHonorGain", - Type = "Event", - LiteralName = "CHAT_MSG_COMBAT_HONOR_GAIN", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgCombatMiscInfo", - Type = "Event", - LiteralName = "CHAT_MSG_COMBAT_MISC_INFO", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgCombatXpGain", - Type = "Event", - LiteralName = "CHAT_MSG_COMBAT_XP_GAIN", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgCommunitiesChannel", - Type = "Event", - LiteralName = "CHAT_MSG_COMMUNITIES_CHANNEL", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgCurrency", - Type = "Event", - LiteralName = "CHAT_MSG_CURRENCY", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgDnd", - Type = "Event", - LiteralName = "CHAT_MSG_DND", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgEmote", - Type = "Event", - LiteralName = "CHAT_MSG_EMOTE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgFiltered", - Type = "Event", - LiteralName = "CHAT_MSG_FILTERED", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgGuild", - Type = "Event", - LiteralName = "CHAT_MSG_GUILD", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgGuildAchievement", - Type = "Event", - LiteralName = "CHAT_MSG_GUILD_ACHIEVEMENT", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgGuildItemLooted", - Type = "Event", - LiteralName = "CHAT_MSG_GUILD_ITEM_LOOTED", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgIgnored", - Type = "Event", - LiteralName = "CHAT_MSG_IGNORED", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgInstanceChat", - Type = "Event", - LiteralName = "CHAT_MSG_INSTANCE_CHAT", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgInstanceChatLeader", - Type = "Event", - LiteralName = "CHAT_MSG_INSTANCE_CHAT_LEADER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgLoot", - Type = "Event", - LiteralName = "CHAT_MSG_LOOT", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgMoney", - Type = "Event", - LiteralName = "CHAT_MSG_MONEY", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgMonsterEmote", - Type = "Event", - LiteralName = "CHAT_MSG_MONSTER_EMOTE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgMonsterParty", - Type = "Event", - LiteralName = "CHAT_MSG_MONSTER_PARTY", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgMonsterSay", - Type = "Event", - LiteralName = "CHAT_MSG_MONSTER_SAY", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgMonsterWhisper", - Type = "Event", - LiteralName = "CHAT_MSG_MONSTER_WHISPER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgMonsterYell", - Type = "Event", - LiteralName = "CHAT_MSG_MONSTER_YELL", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgOfficer", - Type = "Event", - LiteralName = "CHAT_MSG_OFFICER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgOpening", - Type = "Event", - LiteralName = "CHAT_MSG_OPENING", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgParty", - Type = "Event", - LiteralName = "CHAT_MSG_PARTY", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgPartyLeader", - Type = "Event", - LiteralName = "CHAT_MSG_PARTY_LEADER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgPetBattleCombatLog", - Type = "Event", - LiteralName = "CHAT_MSG_PET_BATTLE_COMBAT_LOG", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgPetBattleInfo", - Type = "Event", - LiteralName = "CHAT_MSG_PET_BATTLE_INFO", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgPetInfo", - Type = "Event", - LiteralName = "CHAT_MSG_PET_INFO", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgRaid", - Type = "Event", - LiteralName = "CHAT_MSG_RAID", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgRaidBossEmote", - Type = "Event", - LiteralName = "CHAT_MSG_RAID_BOSS_EMOTE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgRaidBossWhisper", - Type = "Event", - LiteralName = "CHAT_MSG_RAID_BOSS_WHISPER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgRaidLeader", - Type = "Event", - LiteralName = "CHAT_MSG_RAID_LEADER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgRaidWarning", - Type = "Event", - LiteralName = "CHAT_MSG_RAID_WARNING", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgRestricted", - Type = "Event", - LiteralName = "CHAT_MSG_RESTRICTED", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgSay", - Type = "Event", - LiteralName = "CHAT_MSG_SAY", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgSkill", - Type = "Event", - LiteralName = "CHAT_MSG_SKILL", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgSystem", - Type = "Event", - LiteralName = "CHAT_MSG_SYSTEM", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgTargeticons", - Type = "Event", - LiteralName = "CHAT_MSG_TARGETICONS", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgTextEmote", - Type = "Event", - LiteralName = "CHAT_MSG_TEXT_EMOTE", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgTradeskills", - Type = "Event", - LiteralName = "CHAT_MSG_TRADESKILLS", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgVoiceText", - Type = "Event", - LiteralName = "CHAT_MSG_VOICE_TEXT", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgWhisper", - Type = "Event", - LiteralName = "CHAT_MSG_WHISPER", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgWhisperInform", - Type = "Event", - LiteralName = "CHAT_MSG_WHISPER_INFORM", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatMsgYell", - Type = "Event", - LiteralName = "CHAT_MSG_YELL", - Payload = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "playerName", Type = "cstring", Nilable = false }, - { Name = "languageName", Type = "cstring", Nilable = false }, - { Name = "channelName", Type = "cstring", Nilable = false }, - { Name = "playerName2", Type = "cstring", Nilable = false }, - { Name = "specialFlags", Type = "cstring", Nilable = false }, - { Name = "zoneChannelID", Type = "number", Nilable = false }, - { Name = "channelIndex", Type = "number", Nilable = false }, - { Name = "channelBaseName", Type = "cstring", Nilable = false }, - { Name = "languageID", Type = "number", Nilable = false }, - { Name = "lineID", Type = "number", Nilable = false }, - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "bnSenderID", Type = "number", Nilable = false }, - { Name = "isMobile", Type = "bool", Nilable = false }, - { Name = "isSubtitle", Type = "bool", Nilable = false }, - { Name = "hideSenderInLetterbox", Type = "bool", Nilable = false }, - { Name = "supressRaidIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatServerDisconnected", - Type = "Event", - LiteralName = "CHAT_SERVER_DISCONNECTED", - Payload = - { - { Name = "isInitialMessage", Type = "bool", Nilable = true }, - }, - }, - { - Name = "ChatServerReconnected", - Type = "Event", - LiteralName = "CHAT_SERVER_RECONNECTED", - }, - { - Name = "ClearBossEmotes", - Type = "Event", - LiteralName = "CLEAR_BOSS_EMOTES", - }, - { - Name = "LanguageListChanged", - Type = "Event", - LiteralName = "LANGUAGE_LIST_CHANGED", - }, - { - Name = "NotifyChatSuppressed", - Type = "Event", - LiteralName = "NOTIFY_CHAT_SUPPRESSED", - }, - { - Name = "QuestBossEmote", - Type = "Event", - LiteralName = "QUEST_BOSS_EMOTE", - 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", - 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", - 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", - Payload = - { - { Name = "mapname", Type = "cstring", Nilable = false }, - { Name = "daysLeft", Type = "number", Nilable = false }, - { Name = "hoursLeft", Type = "number", Nilable = false }, - { Name = "minutesLeft", Type = "number", Nilable = false }, - { Name = "locked", Type = "number", Nilable = false }, - }, - }, - { - Name = "UpdateChatColor", - Type = "Event", - LiteralName = "UPDATE_CHAT_COLOR", - 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", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "colorNameByClass", Type = "bool", Nilable = false }, - }, - }, - { - Name = "UpdateChatWindows", - Type = "Event", - LiteralName = "UPDATE_CHAT_WINDOWS", - }, - { - Name = "UpdateFloatingChatWindows", - Type = "Event", - LiteralName = "UPDATE_FLOATING_CHAT_WINDOWS", - }, - }, - - 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" } }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(ChatInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CinematicDocumentation.lua b/APIDocumentation/Documentation/CinematicDocumentation.lua deleted file mode 100644 index 3797733..0000000 --- a/APIDocumentation/Documentation/CinematicDocumentation.lua +++ /dev/null @@ -1,53 +0,0 @@ -local Cinematic = -{ - Name = "Cinematic", - Type = "System", - Namespace = "C_Cinematic", - - Functions = - { - }, - - Events = - { - { - Name = "CinematicStart", - Type = "Event", - LiteralName = "CINEMATIC_START", - Payload = - { - { Name = "canBeCancelled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CinematicStop", - Type = "Event", - LiteralName = "CINEMATIC_STOP", - }, - { - Name = "HideSubtitle", - Type = "Event", - LiteralName = "HIDE_SUBTITLE", - }, - { - Name = "PlayMovie", - Type = "Event", - LiteralName = "PLAY_MOVIE", - Payload = - { - { Name = "movieID", Type = "number", Nilable = false }, - }, - }, - { - Name = "StopMovie", - Type = "Event", - LiteralName = "STOP_MOVIE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Cinematic); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ClassResourceDocumentation.lua b/APIDocumentation/Documentation/ClassResourceDocumentation.lua new file mode 100644 index 0000000..d3928ac --- /dev/null +++ b/APIDocumentation/Documentation/ClassResourceDocumentation.lua @@ -0,0 +1,116 @@ +local ClassResource = +{ + Name = "Class Resource", + Type = "System", + Namespace = "Class Resource", + + Functions = + { + { + Name = "DestroyTotem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetRuneCooldown", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "runeReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRuneCount", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneType", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "runeType", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotemInfo", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "haveTotem", Type = "bool", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTotemTimeLeft", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "TargetTotem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ClassResource); diff --git a/APIDocumentation/Documentation/ClassTrialDocumentation.lua b/APIDocumentation/Documentation/ClassTrialDocumentation.lua deleted file mode 100644 index 1b3cf36..0000000 --- a/APIDocumentation/Documentation/ClassTrialDocumentation.lua +++ /dev/null @@ -1,30 +0,0 @@ -local ClassTrial = -{ - Name = "ClassTrial", - Type = "System", - Namespace = "C_ClassTrial", - - Functions = - { - }, - - Events = - { - { - Name = "ClassTrialTimerStart", - Type = "Event", - LiteralName = "CLASS_TRIAL_TIMER_START", - }, - { - Name = "ClassTrialUpgradeComplete", - Type = "Event", - LiteralName = "CLASS_TRIAL_UPGRADE_COMPLETE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ClassTrial); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ClientControlAndInformationDocumentation.lua b/APIDocumentation/Documentation/ClientControlAndInformationDocumentation.lua new file mode 100644 index 0000000..00b7e5a --- /dev/null +++ b/APIDocumentation/Documentation/ClientControlAndInformationDocumentation.lua @@ -0,0 +1,183 @@ +local ClientControlAndInformation = +{ + Name = "Client Control and Information", + Type = "System", + Namespace = "Client Control and Information", + + Functions = + { + { + Name = "CancelLogout", + Type = "Function", + + }, + { + Name = "DownloadSettings", + Type = "Function", + + }, + { + Name = "ForceLogout", + Type = "Function", + + }, + { + Name = "ForceQuit", + Type = "Function", + + }, + { + Name = "GetAccountExpansionLevel", + Type = "Function", + + Returns = + { + { Name = "expansionLevel", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBuildInfo", + Type = "Function", + + Returns = + { + { Name = "version", Type = "string", Nilable = false }, + { Name = "internalVersion", Type = "string", Nilable = false }, + { Name = "date", Type = "string", Nilable = false }, + { Name = "uiVersion", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExistingLocales", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetExpansionLevel", + Type = "Function", + + }, + { + Name = "GetGameTime", + Type = "Function", + + Returns = + { + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLocale", + Type = "Function", + + Returns = + { + { Name = "locale", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNetStats", + Type = "Function", + + Returns = + { + { Name = "bandwidthIn", Type = "number", Nilable = false }, + { Name = "bandwidthOut", Type = "number", Nilable = false }, + { Name = "latencyHome", Type = "number", Nilable = false }, + { Name = "latencyWorld", Type = "number", 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 = "IsWindowsClient", + Type = "Function", + + Returns = + { + { Name = "isWindows", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Logout", + Type = "Function", + + }, + { + Name = "NotWhileDeadError", + Type = "Function", + + }, + { + Name = "Quit", + Type = "Function", + + }, + { + Name = "ReloadUI", + Type = "Function", + + }, + { + Name = "Screenshot", + Type = "Function", + + }, + { + Name = "SetEuropeanNumbers", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetUIVisibility", + Type = "Function", + + Arguments = + { + { Name = "visible", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "UploadSettings", + Type = "Function", + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ClientControlAndInformation); diff --git a/APIDocumentation/Documentation/ClientDocumentation.lua b/APIDocumentation/Documentation/ClientDocumentation.lua deleted file mode 100644 index 566de27..0000000 --- a/APIDocumentation/Documentation/ClientDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Client = -{ - Name = "Client", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Client); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ClientSceneDocumentation.lua b/APIDocumentation/Documentation/ClientSceneDocumentation.lua deleted file mode 100644 index 178573e..0000000 --- a/APIDocumentation/Documentation/ClientSceneDocumentation.lua +++ /dev/null @@ -1,46 +0,0 @@ -local ClientScene = -{ - Name = "ClientScene", - Type = "System", - Namespace = "C_ClientScene", - - Functions = - { - }, - - Events = - { - { - Name = "ClientSceneClosed", - Type = "Event", - LiteralName = "CLIENT_SCENE_CLOSED", - }, - { - Name = "ClientSceneOpened", - Type = "Event", - LiteralName = "CLIENT_SCENE_OPENED", - 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/APIDocumentation/Documentation/ClubDocumentation.lua b/APIDocumentation/Documentation/ClubDocumentation.lua deleted file mode 100644 index 86e3fbd..0000000 --- a/APIDocumentation/Documentation/ClubDocumentation.lua +++ /dev/null @@ -1,1634 +0,0 @@ -local Club = -{ - Name = "Club", - Type = "System", - Namespace = "C_Club", - - Functions = - { - { - Name = "AcceptInvitation", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "AddClubStreamChatChannel", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "AdvanceStreamViewMarker", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "AssignMemberRole", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - { Name = "roleId", Type = "ClubRoleIdentifier", Nilable = false }, - }, - }, - { - Name = "CanResolvePlayerLocationFromClubMessageData", - Type = "Function", - - 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", - }, - { - Name = "ClearClubPresenceSubscription", - Type = "Function", - }, - { - Name = "CompareBattleNetDisplayName", - Type = "Function", - - 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", - - 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", - 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", - 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 = "DeclineInvitation", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "DestroyClub", - Type = "Function", - Documentation = { "Check the canDestroy privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "DestroyMessage", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - { Name = "messageId", Type = "ClubMessageIdentifier", Nilable = false }, - }, - }, - { - Name = "DestroyStream", - Type = "Function", - Documentation = { "Check canDestroyStream privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "DestroyTicket", - Type = "Function", - Documentation = { "Check canDestroyTicket privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "ticketId", Type = "string", Nilable = false }, - }, - }, - { - Name = "EditClub", - Type = "Function", - 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", - - 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", - 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", - }, - { - Name = "FocusCommunityStreams", - Type = "Function", - }, - { - Name = "FocusStream", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - - Returns = - { - { Name = "focused", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetAssignableRoles", - Type = "Function", - - 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", - 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 = "GetClubInfo", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "ClubInfo", Nilable = true }, - }, - }, - { - Name = "GetClubMembers", - Type = "Function", - - 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", - 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", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - - Returns = - { - { Name = "settings", Type = "table", InnerType = "ClubStreamNotificationSetting", Nilable = false }, - }, - }, - { - Name = "GetCommunityNameResultText", - Type = "Function", - - Arguments = - { - { Name = "result", Type = "ValidateNameResult", Nilable = false }, - }, - - Returns = - { - { Name = "errorCode", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "GetInfoFromLastCommunityChatLine", - Type = "Function", - - 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", - 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", - 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", - 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", - Documentation = { "These are the clubs the active player has been invited to." }, - - Returns = - { - { Name = "invitations", Type = "table", InnerType = "ClubSelfInvitationInfo", Nilable = false }, - }, - }, - { - Name = "GetMemberInfo", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "ClubMemberInfo", Nilable = true }, - }, - }, - { - Name = "GetMemberInfoForSelf", - Type = "Function", - 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", - 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", - 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", - 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", - 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", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - - Returns = - { - { Name = "streamInfo", Type = "ClubStreamInfo", Nilable = true }, - }, - }, - { - Name = "GetStreamViewMarker", - Type = "Function", - - 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", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - - Returns = - { - { Name = "streams", Type = "table", InnerType = "ClubStreamInfo", Nilable = false }, - }, - }, - { - Name = "GetSubscribedClubs", - Type = "Function", - - Returns = - { - { Name = "clubs", Type = "table", InnerType = "ClubInfo", Nilable = false }, - }, - }, - { - Name = "GetTickets", - Type = "Function", - 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", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - - Returns = - { - { Name = "accountMuted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsBeginningOfStream", - Type = "Function", - 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", - - Returns = - { - { Name = "clubsEnabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsRestricted", - Type = "Function", - - Returns = - { - { Name = "restrictionReason", Type = "ClubRestrictionReason", Nilable = false }, - }, - }, - { - Name = "IsSubscribedToStream", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - - Returns = - { - { Name = "subscribed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "KickMember", - Type = "Function", - Documentation = { "Check kickableRoleIds privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "LeaveClub", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "RedeemTicket", - Type = "Function", - - Arguments = - { - { Name = "ticketId", Type = "string", Nilable = false }, - }, - }, - { - Name = "RequestInvitationsForClub", - Type = "Function", - Documentation = { "Request invitations for this club from server. Check canGetInvitation privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "RequestMoreMessagesBefore", - Type = "Function", - 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", - - Arguments = - { - { Name = "ticketId", Type = "string", Nilable = false }, - }, - }, - { - Name = "RequestTickets", - Type = "Function", - Documentation = { "Request tickets from server. Check canGetTicket privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "RevokeInvitation", - Type = "Function", - Documentation = { "Check canRevokeOwnInvitation or canRevokeOtherInvitation" }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "SendBattleTagFriendRequest", - Type = "Function", - - Arguments = - { - { Name = "guildClubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "SendInvitation", - Type = "Function", - Documentation = { "Check the canSendInvitation privilege." }, - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "SendMessage", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - { Name = "message", Type = "string", Nilable = false }, - }, - }, - { - Name = "SetAutoAdvanceStreamViewMarker", - Type = "Function", - 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", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - { Name = "avatarId", Type = "number", Nilable = false }, - { Name = "clubType", Type = "ClubType", Nilable = false }, - }, - }, - { - Name = "SetClubMemberNote", - Type = "Function", - 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", - 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", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "settings", Type = "table", InnerType = "ClubStreamNotificationSetting", Nilable = false }, - }, - }, - { - Name = "SetCommunityID", - Type = "Function", - - Arguments = - { - { Name = "communityID", Type = "BigUInteger", Nilable = false }, - }, - }, - { - Name = "SetFavorite", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "isFavorite", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetSocialQueueingEnabled", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ShouldAllowClubType", - Type = "Function", - - Arguments = - { - { Name = "clubType", Type = "ClubType", Nilable = false }, - }, - - Returns = - { - { Name = "clubTypeIsAllowed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "UnfocusAllStreams", - Type = "Function", - - Arguments = - { - { Name = "unsubscribe", Type = "bool", Nilable = false }, - }, - }, - { - Name = "UnfocusStream", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "ValidateText", - Type = "Function", - - 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", - Payload = - { - { Name = "clubType", Type = "ClubType", Nilable = false }, - }, - }, - { - Name = "ClubAdded", - Type = "Event", - LiteralName = "CLUB_ADDED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "ClubError", - Type = "Event", - LiteralName = "CLUB_ERROR", - 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", - Payload = - { - { Name = "invitation", Type = "ClubSelfInvitationInfo", Nilable = false }, - }, - }, - { - Name = "ClubInvitationRemovedForSelf", - Type = "Event", - LiteralName = "CLUB_INVITATION_REMOVED_FOR_SELF", - Payload = - { - { Name = "invitationId", Type = "ClubInvitationId", Nilable = false }, - }, - }, - { - Name = "ClubInvitationsReceivedForClub", - Type = "Event", - LiteralName = "CLUB_INVITATIONS_RECEIVED_FOR_CLUB", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "ClubMemberAdded", - Type = "Event", - LiteralName = "CLUB_MEMBER_ADDED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "ClubMemberPresenceUpdated", - Type = "Event", - LiteralName = "CLUB_MEMBER_PRESENCE_UPDATED", - 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", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "ClubMemberRoleUpdated", - Type = "Event", - LiteralName = "CLUB_MEMBER_ROLE_UPDATED", - 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", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "memberId", Type = "number", Nilable = false }, - }, - }, - { - Name = "ClubMessageAdded", - Type = "Event", - LiteralName = "CLUB_MESSAGE_ADDED", - 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", - 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", - 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", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "ClubRemovedMessage", - Type = "Event", - LiteralName = "CLUB_REMOVED_MESSAGE", - Payload = - { - { Name = "clubName", Type = "string", Nilable = false }, - { Name = "clubRemovedReason", Type = "ClubRemovedReason", Nilable = false }, - }, - }, - { - Name = "ClubSelfMemberRoleUpdated", - Type = "Event", - LiteralName = "CLUB_SELF_MEMBER_ROLE_UPDATED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "roleId", Type = "number", Nilable = false }, - }, - }, - { - Name = "ClubStreamAdded", - Type = "Event", - LiteralName = "CLUB_STREAM_ADDED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "ClubStreamRemoved", - Type = "Event", - LiteralName = "CLUB_STREAM_REMOVED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "ClubStreamSubscribed", - Type = "Event", - LiteralName = "CLUB_STREAM_SUBSCRIBED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "ClubStreamUnsubscribed", - Type = "Event", - LiteralName = "CLUB_STREAM_UNSUBSCRIBED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "ClubStreamUpdated", - Type = "Event", - LiteralName = "CLUB_STREAM_UPDATED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "ClubStreamsLoaded", - Type = "Event", - LiteralName = "CLUB_STREAMS_LOADED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "ClubTicketCreated", - Type = "Event", - LiteralName = "CLUB_TICKET_CREATED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "ticketInfo", Type = "ClubTicketInfo", Nilable = false }, - }, - }, - { - Name = "ClubTicketReceived", - Type = "Event", - LiteralName = "CLUB_TICKET_RECEIVED", - Payload = - { - { Name = "error", Type = "ClubErrorType", Nilable = false }, - { Name = "ticket", Type = "string", Nilable = false }, - { Name = "info", Type = "ClubInfo", Nilable = true }, - }, - }, - { - Name = "ClubTicketsReceived", - Type = "Event", - LiteralName = "CLUB_TICKETS_RECEIVED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "ClubUpdated", - Type = "Event", - LiteralName = "CLUB_UPDATED", - Payload = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - }, - }, - { - Name = "InitialClubsLoaded", - Type = "Event", - LiteralName = "INITIAL_CLUBS_LOADED", - }, - { - Name = "StreamViewMarkerUpdated", - Type = "Event", - LiteralName = "STREAM_VIEW_MARKER_UPDATED", - 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 = "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 }, - }, - }, - { - 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 }, - { 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 }, - { Name = "avatarId", Type = "number", Nilable = false }, - { Name = "memberCount", Type = "number", Nilable = true }, - { Name = "favoriteTimeStamp", Type = "BigUInteger", Nilable = true }, - { Name = "joinTime", Type = "BigUInteger", Nilable = true }, - { Name = "socialQueueingEnabled", 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 }, - { 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 = "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 }, - { 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/APIDocumentation/Documentation/ClubSharedDocumentation.lua b/APIDocumentation/Documentation/ClubSharedDocumentation.lua deleted file mode 100644 index 75a2987..0000000 --- a/APIDocumentation/Documentation/ClubSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local ClubShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ClubShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ColorDocumentation.lua b/APIDocumentation/Documentation/ColorDocumentation.lua deleted file mode 100644 index 85a87d5..0000000 --- a/APIDocumentation/Documentation/ColorDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local Color = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Color); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CombatDocumentation.lua b/APIDocumentation/Documentation/CombatDocumentation.lua new file mode 100644 index 0000000..9ea2556 --- /dev/null +++ b/APIDocumentation/Documentation/CombatDocumentation.lua @@ -0,0 +1,146 @@ +local Combat = +{ + Name = "Combat", + Type = "System", + Namespace = "Combat", + + Functions = + { + { + Name = "StartAttack", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "StopAttack", + Type = "Function", + + }, + { + Name = "UnitAffectingCombat", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inCombat", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ChatMsgCombatHonorGain", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_HONOR_GAIN", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgCombatMiscInfo", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_MISC_INFO", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgCombatXpGain", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_XP_GAIN", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "CombatRatingUpdate", + Type = "Event", + LiteralName = "COMBAT_RATING_UPDATE", + }, + { + Name = "CombatTextUpdate", + Type = "Event", + LiteralName = "COMBAT_TEXT_UPDATE", + Payload = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "desc1", Type = "varies", Nilable = false }, + { Name = "desc2", Type = "varies", Nilable = false }, + }, + }, + { + Name = "PlayerEnterCombat", + Type = "Event", + LiteralName = "PLAYER_ENTER_COMBAT", + }, + { + Name = "PlayerLeaveCombat", + Type = "Event", + LiteralName = "PLAYER_LEAVE_COMBAT", + }, + { + Name = "UnitCombat", + Type = "Event", + LiteralName = "UNIT_COMBAT", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "action", Type = "string", Nilable = false }, + { Name = "descriptor", Type = "string", Nilable = false }, + { Name = "damage", Type = "number", Nilable = false }, + { Name = "damageType", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Combat); diff --git a/APIDocumentation/Documentation/CombatLogDocumentation.lua b/APIDocumentation/Documentation/CombatLogDocumentation.lua deleted file mode 100644 index 10a726e..0000000 --- a/APIDocumentation/Documentation/CombatLogDocumentation.lua +++ /dev/null @@ -1,39 +0,0 @@ -local CombatLog = -{ - Name = "CombatLog", - Type = "System", - Namespace = "C_CombatLog", - - Functions = - { - }, - - Events = - { - { - Name = "CombatLogEvent", - Type = "Event", - LiteralName = "COMBAT_LOG_EVENT", - }, - { - Name = "CombatLogEventUnfiltered", - Type = "Event", - LiteralName = "COMBAT_LOG_EVENT_UNFILTERED", - }, - { - Name = "CombatTextUpdate", - Type = "Event", - LiteralName = "COMBAT_TEXT_UPDATE", - Payload = - { - { Name = "combatTextType", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(CombatLog); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CombatlogDocumentation.lua b/APIDocumentation/Documentation/CombatlogDocumentation.lua new file mode 100644 index 0000000..42ffd03 --- /dev/null +++ b/APIDocumentation/Documentation/CombatlogDocumentation.lua @@ -0,0 +1,174 @@ +local Combatlog = +{ + Name = "CombatLog", + Type = "System", + Namespace = "CombatLog", + + Functions = + { + { + Name = "CombatLogAddFilter", + Type = "Function", + + Arguments = + { + { Name = "events", Type = "string", Nilable = true }, + { Name = "srcGUID", Type = "WOWGUID", Nilable = true }, + { Name = "srcMask", Type = "number", Nilable = true }, + { Name = "destGUID", Type = "WOWGUID", Nilable = true }, + { Name = "destMask", Type = "number", Nilable = true }, + }, + + }, + { + Name = "CombatLogAdvanceEntry", + Type = "Function", + + Arguments = + { + { Name = "count", Type = "number", Nilable = false }, + { Name = "ignoreFilter", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "hasEntry", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CombatLogClearEntries", + Type = "Function", + + }, + { + Name = "CombatLogGetCurrentEntry", + Type = "Function", + + Arguments = + { + { Name = "ignoreFilter", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "timestamp", Type = "time_t", Nilable = false }, + { Name = "event", Type = "string", Nilable = false }, + { Name = "srcGUID", Type = "WOWGUID", Nilable = false }, + { Name = "srcName", Type = "string", Nilable = false }, + { Name = "srcFlags", Type = "number", Nilable = false }, + { Name = "destGUID", Type = "WOWGUID", Nilable = false }, + { Name = "destName", Type = "string", Nilable = false }, + { Name = "destFlags", Type = "number", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "CombatLogGetNumEntries", + Type = "Function", + + Arguments = + { + { Name = "ignoreFilter", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "CombatLogGetRetentionTime", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "CombatLogResetFilter", + Type = "Function", + + }, + { + Name = "CombatLogSetCurrentEntry", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "ignoreFilter", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "CombatLogSetRetentionTime", + Type = "Function", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CombatLog_Object_IsA", + Type = "Function", + + Arguments = + { + { Name = "unitFlags", Type = "UnitToken", Nilable = false }, + { Name = "mask", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isMatch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LoggingCombat", + Type = "Function", + + Arguments = + { + { Name = "toggle", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "isLogging", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitGUID", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "CombatLogEvent", + Type = "Event", + LiteralName = "COMBAT_LOG_EVENT", + }, + { + Name = "CombatLogEventUnfiltered", + Type = "Event", + LiteralName = "COMBAT_LOG_EVENT_UNFILTERED", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Combatlog); diff --git a/APIDocumentation/Documentation/CommentatorDocumentation.lua b/APIDocumentation/Documentation/CommentatorDocumentation.lua new file mode 100644 index 0000000..6b83fe9 --- /dev/null +++ b/APIDocumentation/Documentation/CommentatorDocumentation.lua @@ -0,0 +1,220 @@ +local Commentator = +{ + Name = "Commentator", + Type = "System", + Namespace = "Commentator", + + Functions = + { + { + Name = "CommentatorAddPlayer", + Type = "Function", + + }, + { + Name = "CommentatorEnterInstance", + Type = "Function", + + }, + { + Name = "CommentatorExitInstance", + Type = "Function", + + }, + { + Name = "CommentatorFollowPlayer", + Type = "Function", + + }, + { + Name = "CommentatorGetCamera", + Type = "Function", + + }, + { + Name = "CommentatorGetCurrentMapID", + Type = "Function", + + }, + { + Name = "CommentatorGetInstanceInfo", + Type = "Function", + + }, + { + Name = "CommentatorGetMapInfo", + Type = "Function", + + }, + { + Name = "CommentatorGetMode", + Type = "Function", + + }, + { + Name = "CommentatorGetNumMaps", + Type = "Function", + + }, + { + Name = "CommentatorGetNumPlayers", + Type = "Function", + + }, + { + Name = "CommentatorGetPlayerInfo", + Type = "Function", + + }, + { + Name = "CommentatorGetSkirmishMode", + Type = "Function", + + }, + { + Name = "CommentatorGetSkirmishQueueCount", + Type = "Function", + + }, + { + Name = "CommentatorGetSkirmishQueuePlayerInfo", + Type = "Function", + + }, + { + Name = "CommentatorLookatPlayer", + Type = "Function", + + }, + { + Name = "CommentatorRemovePlayer", + Type = "Function", + + }, + { + Name = "CommentatorRequestSkirmishMode", + Type = "Function", + + }, + { + Name = "CommentatorRequestSkirmishQueueData", + Type = "Function", + + }, + { + Name = "CommentatorSetBattlemaster", + Type = "Function", + + }, + { + Name = "CommentatorSetCamera", + Type = "Function", + + }, + { + Name = "CommentatorSetCameraCollision", + Type = "Function", + + }, + { + Name = "CommentatorSetMapAndInstanceIndex", + Type = "Function", + + }, + { + Name = "CommentatorSetMode", + Type = "Function", + + }, + { + Name = "CommentatorSetMoveSpeed", + Type = "Function", + + }, + { + Name = "CommentatorSetPlayerIndex", + Type = "Function", + + }, + { + Name = "CommentatorSetSkirmishMatchmakingMode", + Type = "Function", + + }, + { + Name = "CommentatorSetTargetHeightOffset", + Type = "Function", + + }, + { + Name = "CommentatorStartInstance", + Type = "Function", + + }, + { + Name = "CommentatorStartSkirmishMatch", + Type = "Function", + + }, + { + Name = "CommentatorToggleMode", + Type = "Function", + + }, + { + Name = "CommentatorUpdateMapInfo", + Type = "Function", + + }, + { + Name = "CommentatorUpdatePlayerInfo", + Type = "Function", + + }, + { + Name = "CommentatorZoomIn", + Type = "Function", + + }, + { + Name = "CommentatorZoomOut", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "CommentatorEnterWorld", + Type = "Event", + LiteralName = "COMMENTATOR_ENTER_WORLD", + }, + { + Name = "CommentatorMapUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_MAP_UPDATE", + }, + { + Name = "CommentatorPlayerUpdate", + Type = "Event", + LiteralName = "COMMENTATOR_PLAYER_UPDATE", + }, + { + Name = "CommentatorSkirmishModeRequest", + Type = "Event", + LiteralName = "COMMENTATOR_SKIRMISH_MODE_REQUEST", + }, + { + Name = "CommentatorSkirmishQueueRequest", + Type = "Event", + LiteralName = "COMMENTATOR_SKIRMISH_QUEUE_REQUEST", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Commentator); diff --git a/APIDocumentation/Documentation/CommentatorFrameDocumentation.lua b/APIDocumentation/Documentation/CommentatorFrameDocumentation.lua deleted file mode 100644 index ac38947..0000000 --- a/APIDocumentation/Documentation/CommentatorFrameDocumentation.lua +++ /dev/null @@ -1,1569 +0,0 @@ -local CommentatorFrame = -{ - Name = "CommentatorFrame", - Type = "System", - Namespace = "C_Commentator", - - Functions = - { - { - Name = "AddPlayerOverrideName", - Type = "Function", - - Arguments = - { - { Name = "playerName", Type = "string", Nilable = false }, - { Name = "overrideName", Type = "string", Nilable = false }, - }, - }, - { - Name = "AddTrackedDefensiveAuras", - Type = "Function", - - Arguments = - { - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "AddTrackedOffensiveAuras", - Type = "Function", - - Arguments = - { - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "AreTeamsSwapped", - Type = "Function", - - Returns = - { - { Name = "teamsAreSwapped", Type = "bool", Nilable = false }, - }, - }, - { - Name = "AssignPlayerToTeam", - Type = "Function", - - Arguments = - { - { Name = "playerName", Type = "string", Nilable = false }, - { Name = "teamName", Type = "string", Nilable = false }, - }, - }, - { - Name = "AssignPlayersToTeam", - Type = "Function", - - Arguments = - { - { Name = "playerName", Type = "table", InnerType = "string", Nilable = false }, - { Name = "teamName", Type = "string", Nilable = false }, - }, - }, - { - Name = "AssignPlayersToTeamInCurrentInstance", - Type = "Function", - - 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", - }, - { - Name = "ClearFollowTarget", - Type = "Function", - }, - { - Name = "ClearLookAtTarget", - Type = "Function", - - Arguments = - { - { Name = "lookAtIndex", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "EnterInstance", - Type = "Function", - }, - { - Name = "ExitInstance", - Type = "Function", - }, - { - Name = "FindSpectatedUnit", - Type = "Function", - - 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", - - Arguments = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "teamName", Type = "string", Nilable = true }, - }, - }, - { - Name = "FindTeamNameInDirectory", - Type = "Function", - - Arguments = - { - { Name = "playerNames", Type = "table", InnerType = "string", Nilable = false }, - }, - - Returns = - { - { Name = "teamName", Type = "string", Nilable = true }, - }, - }, - { - Name = "FlushCommentatorHistory", - Type = "Function", - }, - { - Name = "FollowPlayer", - Type = "Function", - - Arguments = - { - { Name = "factionIndex", Type = "luaIndex", Nilable = false }, - { Name = "playerIndex", Type = "luaIndex", Nilable = false }, - { Name = "forceInstantTransition", Type = "bool", Nilable = true }, - }, - }, - { - Name = "FollowUnit", - Type = "Function", - - Arguments = - { - { Name = "token", Type = "string", Nilable = false }, - }, - }, - { - Name = "ForceFollowTransition", - Type = "Function", - }, - { - Name = "GetAdditionalCameraWeight", - Type = "Function", - - Returns = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - { Name = "playerIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "GetAdditionalCameraWeightByToken", - Type = "Function", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "weight", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetAllPlayerOverrideNames", - Type = "Function", - - Returns = - { - { Name = "nameEntries", Type = "table", InnerType = "NameOverrideEntry", Nilable = false }, - }, - }, - { - Name = "GetCamera", - Type = "Function", - - 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", - - Returns = - { - { Name = "xPos", Type = "number", Nilable = false }, - { Name = "yPos", Type = "number", Nilable = false }, - { Name = "zPos", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCommentatorHistory", - Type = "Function", - - Returns = - { - { Name = "history", Type = "CommentatorHistory", Nilable = false }, - }, - }, - { - Name = "GetCurrentMapID", - Type = "Function", - - 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", - - Arguments = - { - { Name = "trackedSpellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "indirectSpellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetInstanceInfo", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "factionIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "numPlayers", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetOrCreateSeries", - Type = "Function", - - Arguments = - { - { Name = "teamName1", Type = "string", Nilable = false }, - { Name = "teamName2", Type = "string", Nilable = false }, - }, - - Returns = - { - { Name = "data", Type = "CommentatorSeries", Nilable = false }, - }, - }, - { - Name = "GetPlayerAuraInfo", - Type = "Function", - - 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", - - 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", - - 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", - - 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", - - 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", - - 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", - - Arguments = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - { Name = "playerIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "CommentatorPlayerData", Nilable = true }, - }, - }, - { - Name = "GetPlayerFlagInfo", - Type = "Function", - - Arguments = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - { Name = "playerIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "hasFlag", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetPlayerFlagInfoByUnit", - Type = "Function", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "hasFlag", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetPlayerOverrideName", - Type = "Function", - - Arguments = - { - { Name = "originalName", Type = "string", Nilable = false }, - }, - - Returns = - { - { Name = "overrideName", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetPlayerSpellCharges", - Type = "Function", - - 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", - - 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", - - 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", - - Arguments = - { - { Name = "mapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "pos", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, - }, - }, - { - Name = "GetTeamColor", - Type = "Function", - - Arguments = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, - }, - }, - { - Name = "GetTeamColorByUnit", - Type = "Function", - - 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", - - Arguments = - { - { Name = "indirectSpellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "trackedSpellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetTrackedSpells", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "data", Type = "CommentatorUnitData", Nilable = false }, - }, - }, - { - Name = "GetWargameInfo", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isDefensiveTrigger", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsTrackedOffensiveAura", - Type = "Function", - - Arguments = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isOffensiveTrigger", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsTrackedSpell", - Type = "Function", - - 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", - - 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", - - 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", - - Arguments = - { - { Name = "originalPlayerName", Type = "string", Nilable = false }, - }, - }, - { - Name = "RequestPlayerCooldownInfo", - Type = "Function", - - Arguments = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - { Name = "playerIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "ResetFoVTarget", - Type = "Function", - }, - { - Name = "ResetSeriesScores", - Type = "Function", - - Arguments = - { - { Name = "teamName1", Type = "string", Nilable = false }, - { Name = "teamName2", Type = "string", Nilable = false }, - }, - }, - { - Name = "ResetSettings", - Type = "Function", - }, - { - Name = "ResetTrackedAuras", - Type = "Function", - }, - { - Name = "SetAdditionalCameraWeight", - Type = "Function", - - Arguments = - { - { Name = "teamIndex", Type = "luaIndex", Nilable = false }, - { Name = "playerIndex", Type = "luaIndex", Nilable = false }, - { Name = "weight", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetAdditionalCameraWeightByToken", - Type = "Function", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - { Name = "weight", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetBlocklistedAuras", - Type = "Function", - - Arguments = - { - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "SetBlocklistedCooldowns", - Type = "Function", - - Arguments = - { - { Name = "classID", Type = "number", Nilable = false }, - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "SetCamera", - Type = "Function", - - 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", - - Arguments = - { - { Name = "collide", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetCameraPosition", - Type = "Function", - - 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", - - Arguments = - { - { Name = "enableCheats", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetCommentatorHistory", - Type = "Function", - - Arguments = - { - { Name = "history", Type = "CommentatorHistory", Nilable = false }, - }, - }, - { - Name = "SetDistanceBeforeForcedHorizontalConvergence", - Type = "Function", - - Arguments = - { - { Name = "distance", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetDurationToForceHorizontalConvergence", - Type = "Function", - - Arguments = - { - { Name = "ms", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetExcludeDistance", - Type = "Function", - - Arguments = - { - { Name = "excludeDistance", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFollowCameraSpeeds", - Type = "Function", - - Arguments = - { - { Name = "elasticSpeed", Type = "number", Nilable = false }, - { Name = "minSpeed", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetHardlockWeight", - Type = "Function", - - Arguments = - { - { Name = "weight", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetHorizontalAngleThresholdToSmooth", - Type = "Function", - - Arguments = - { - { Name = "angle", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLookAtLerpAmount", - Type = "Function", - - Arguments = - { - { Name = "amount", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMapAndInstanceIndex", - Type = "Function", - - Arguments = - { - { Name = "mapIndex", Type = "luaIndex", Nilable = false }, - { Name = "instanceIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SetMouseDisabled", - Type = "Function", - - Arguments = - { - { Name = "disabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetMoveSpeed", - Type = "Function", - - Arguments = - { - { Name = "newSpeed", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMsToHoldForHorizontalMovement", - Type = "Function", - - Arguments = - { - { Name = "ms", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMsToHoldForVerticalMovement", - Type = "Function", - - Arguments = - { - { Name = "ms", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMsToSmoothHorizontalChange", - Type = "Function", - - Arguments = - { - { Name = "ms", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMsToSmoothVerticalChange", - Type = "Function", - - Arguments = - { - { Name = "ms", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetPositionLerpAmount", - Type = "Function", - - Arguments = - { - { Name = "amount", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetRequestedDebuffCooldowns", - Type = "Function", - - Arguments = - { - { Name = "classID", Type = "number", Nilable = false }, - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "SetRequestedDefensiveCooldowns", - Type = "Function", - - Arguments = - { - { Name = "classID", Type = "number", Nilable = false }, - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "SetRequestedOffensiveCooldowns", - Type = "Function", - - Arguments = - { - { Name = "classID", Type = "number", Nilable = false }, - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "SetSeriesScore", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "locked", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetSmoothFollowTransitioning", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetSoftlockWeight", - Type = "Function", - - Arguments = - { - { Name = "weight", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpeedFactor", - Type = "Function", - - Arguments = - { - { Name = "factor", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetTargetHeightOffset", - Type = "Function", - - Arguments = - { - { Name = "offset", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetUseSmartCamera", - Type = "Function", - - Arguments = - { - { Name = "useSmartCamera", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SnapCameraLookAtPoint", - Type = "Function", - }, - { - Name = "StartWargame", - Type = "Function", - - 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", - - Arguments = - { - { Name = "targetPlayer", Type = "string", Nilable = true }, - }, - }, - { - Name = "UpdatePlayerInfo", - Type = "Function", - }, - { - Name = "ZoomIn", - Type = "Function", - }, - { - Name = "ZoomOut", - Type = "Function", - }, - }, - - Events = - { - { - Name = "CommentatorEnterWorld", - Type = "Event", - LiteralName = "COMMENTATOR_ENTER_WORLD", - }, - { - Name = "CommentatorHistoryFlushed", - Type = "Event", - LiteralName = "COMMENTATOR_HISTORY_FLUSHED", - }, - { - Name = "CommentatorImmediateFovUpdate", - Type = "Event", - LiteralName = "COMMENTATOR_IMMEDIATE_FOV_UPDATE", - Payload = - { - { Name = "fov", Type = "number", Nilable = false }, - }, - }, - { - Name = "CommentatorMapUpdate", - Type = "Event", - LiteralName = "COMMENTATOR_MAP_UPDATE", - }, - { - Name = "CommentatorPlayerNameOverrideUpdate", - Type = "Event", - LiteralName = "COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE", - Payload = - { - { Name = "nameToOverride", Type = "cstring", Nilable = false }, - { Name = "overrideName", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "CommentatorPlayerUpdate", - Type = "Event", - LiteralName = "COMMENTATOR_PLAYER_UPDATE", - }, - { - Name = "CommentatorResetSettings", - Type = "Event", - LiteralName = "COMMENTATOR_RESET_SETTINGS", - }, - { - Name = "CommentatorTeamNameUpdate", - Type = "Event", - LiteralName = "COMMENTATOR_TEAM_NAME_UPDATE", - Payload = - { - { Name = "teamName", Type = "string", Nilable = false }, - }, - }, - { - Name = "CommentatorTeamsSwapped", - Type = "Event", - LiteralName = "COMMENTATOR_TEAMS_SWAPPED", - Payload = - { - { Name = "swapped", Type = "bool", Nilable = false }, - }, - }, - }, - - Tables = - { - { - Name = "TrackedSpellCategory", - Type = "Enumeration", - NumValues = 4, - MinValue = 0, - MaxValue = 3, - Fields = - { - { Name = "Offensive", Type = "TrackedSpellCategory", EnumValue = 0 }, - { Name = "Defensive", Type = "TrackedSpellCategory", EnumValue = 1 }, - { Name = "Debuff", Type = "TrackedSpellCategory", EnumValue = 2 }, - { Name = "Count", Type = "TrackedSpellCategory", EnumValue = 3 }, - }, - }, - { - 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 = "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 = "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/APIDocumentation/Documentation/CommentatorSharedDocumentation.lua b/APIDocumentation/Documentation/CommentatorSharedDocumentation.lua deleted file mode 100644 index 409f5e3..0000000 --- a/APIDocumentation/Documentation/CommentatorSharedDocumentation.lua +++ /dev/null @@ -1,23 +0,0 @@ -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/APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua b/APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua deleted file mode 100644 index 3692ae2..0000000 --- a/APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua +++ /dev/null @@ -1,25 +0,0 @@ -local CompactUnitFrames = -{ - Name = "CompactUnitFrames", - Type = "System", - Namespace = "C_CompactUnitFrames", - - Functions = - { - }, - - Events = - { - { - Name = "CompactUnitFrameProfilesLoaded", - Type = "Event", - LiteralName = "COMPACT_UNIT_FRAME_PROFILES_LOADED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(CompactUnitFrames); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CompanionDocumentation.lua b/APIDocumentation/Documentation/CompanionDocumentation.lua new file mode 100644 index 0000000..69a3839 --- /dev/null +++ b/APIDocumentation/Documentation/CompanionDocumentation.lua @@ -0,0 +1,122 @@ +local Companion = +{ + Name = "Companion", + Type = "System", + Namespace = "Companion", + + Functions = + { + { + Name = "CallCompanion", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "DismissCompanion", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GetCompanionCooldown", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCompanionInfo", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "creatureID", Type = "number", Nilable = false }, + { Name = "creatureName", Type = "string", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNumCompanions", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "PickupCompanion", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SummonRandomCritter", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "CompanionLearned", + Type = "Event", + LiteralName = "COMPANION_LEARNED", + }, + { + Name = "CompanionUnlearned", + Type = "Event", + LiteralName = "COMPANION_UNLEARNED", + }, + { + Name = "CompanionUpdate", + Type = "Event", + LiteralName = "COMPANION_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Companion); diff --git a/APIDocumentation/Documentation/ComplaintDocumentation.lua b/APIDocumentation/Documentation/ComplaintDocumentation.lua new file mode 100644 index 0000000..d5dea9f --- /dev/null +++ b/APIDocumentation/Documentation/ComplaintDocumentation.lua @@ -0,0 +1,130 @@ +local Complaint = +{ + Name = "Complaint", + Type = "System", + Namespace = "Complaint", + + Functions = + { + { + Name = "CalendarContextEventCanComplain", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canReport", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarContextEventComplain", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = true }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CanComplainChat", + Type = "Function", + + Arguments = + { + { Name = "lineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canComplain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanComplainInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "complain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ComplainChat", + Type = "Function", + + Arguments = + { + { Name = "lineID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canComplain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ComplainInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "complain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerIsPVPInactive", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "isInactive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReportPlayerIsPVPAFK", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Complaint); diff --git a/APIDocumentation/Documentation/ConfigurationWarningsDocumentation.lua b/APIDocumentation/Documentation/ConfigurationWarningsDocumentation.lua deleted file mode 100644 index d4c2c45..0000000 --- a/APIDocumentation/Documentation/ConfigurationWarningsDocumentation.lua +++ /dev/null @@ -1,89 +0,0 @@ -local ConfigurationWarnings = -{ - Name = "ConfigurationWarnings", - Type = "System", - Namespace = "C_ConfigurationWarnings", - - Functions = - { - { - Name = "GetConfigurationWarningSeen", - Type = "Function", - - Arguments = - { - { Name = "configurationWarning", Type = "ConfigurationWarning", Nilable = false }, - }, - - Returns = - { - { Name = "hasSeenConfigurationWarning", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetConfigurationWarningString", - Type = "Function", - - Arguments = - { - { Name = "configurationWarning", Type = "ConfigurationWarning", Nilable = false }, - }, - - Returns = - { - { Name = "configurationWarningString", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetConfigurationWarnings", - Type = "Function", - - Arguments = - { - { Name = "includeSeenWarnings", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "configurationWarnings", Type = "table", InnerType = "ConfigurationWarning", Nilable = false }, - }, - }, - { - Name = "SetConfigurationWarningSeen", - Type = "Function", - - Arguments = - { - { Name = "configurationWarning", Type = "ConfigurationWarning", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - 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(ConfigurationWarnings); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ConsoleDocumentation.lua b/APIDocumentation/Documentation/ConsoleDocumentation.lua deleted file mode 100644 index 4a2aa10..0000000 --- a/APIDocumentation/Documentation/ConsoleDocumentation.lua +++ /dev/null @@ -1,202 +0,0 @@ -local Console = -{ - Name = "Console", - Type = "System", - Namespace = "C_Console", - - Functions = - { - { - Name = "GetAllCommands", - Type = "Function", - - Returns = - { - { Name = "commands", Type = "table", InnerType = "ConsoleCommandInfo", Nilable = false }, - }, - }, - { - Name = "GetColorFromType", - Type = "Function", - - Arguments = - { - { Name = "colorType", Type = "ConsoleColorType", Nilable = false }, - }, - - Returns = - { - { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, - }, - }, - { - Name = "GetFontHeight", - Type = "Function", - - Returns = - { - { Name = "fontHeightInPixels", Type = "number", Nilable = false }, - }, - }, - { - Name = "PrintAllMatchingCommands", - Type = "Function", - - Arguments = - { - { Name = "partialCommandText", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetFontHeight", - Type = "Function", - - Arguments = - { - { Name = "fontHeightInPixels", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "ConsoleClear", - Type = "Event", - LiteralName = "CONSOLE_CLEAR", - }, - { - Name = "ConsoleColorsChanged", - Type = "Event", - LiteralName = "CONSOLE_COLORS_CHANGED", - }, - { - Name = "ConsoleFontSizeChanged", - Type = "Event", - LiteralName = "CONSOLE_FONT_SIZE_CHANGED", - }, - { - Name = "ConsoleLog", - Type = "Event", - LiteralName = "CONSOLE_LOG", - Payload = - { - { Name = "message", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ConsoleMessage", - Type = "Event", - LiteralName = "CONSOLE_MESSAGE", - Payload = - { - { Name = "message", Type = "cstring", Nilable = false }, - { Name = "colorType", Type = "number", Nilable = false }, - }, - }, - { - Name = "CvarUpdate", - Type = "Event", - LiteralName = "CVAR_UPDATE", - Payload = - { - { Name = "eventName", Type = "cstring", Nilable = false }, - { Name = "value", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GlueConsoleLog", - Type = "Event", - LiteralName = "GLUE_CONSOLE_LOG", - Payload = - { - { Name = "message", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ToggleConsole", - Type = "Event", - LiteralName = "TOGGLE_CONSOLE", - 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/APIDocumentation/Documentation/ConsoleScriptCollectionDocumentation.lua b/APIDocumentation/Documentation/ConsoleScriptCollectionDocumentation.lua deleted file mode 100644 index 6e03053..0000000 --- a/APIDocumentation/Documentation/ConsoleScriptCollectionDocumentation.lua +++ /dev/null @@ -1,116 +0,0 @@ -local ConsoleScriptCollection = -{ - Name = "ConsoleScriptCollection", - Type = "System", - Namespace = "C_ConsoleScriptCollection", - - Functions = - { - { - Name = "GetCollectionDataByID", - Type = "Function", - - Arguments = - { - { Name = "collectionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "data", Type = "ConsoleScriptCollectionData", Nilable = true }, - }, - }, - { - Name = "GetCollectionDataByTag", - Type = "Function", - - Arguments = - { - { Name = "collectionTag", Type = "string", Nilable = false }, - }, - - Returns = - { - { Name = "data", Type = "ConsoleScriptCollectionData", Nilable = true }, - }, - }, - { - Name = "GetElements", - Type = "Function", - - Arguments = - { - { Name = "collectionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "elementIDs", Type = "table", InnerType = "ConsoleScriptCollectionElementData", Nilable = false }, - }, - }, - { - Name = "GetScriptData", - Type = "Function", - - 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/APIDocumentation/Documentation/ContainerDocumentation.lua b/APIDocumentation/Documentation/ContainerDocumentation.lua index 770e30a..43fe0fd 100644 --- a/APIDocumentation/Documentation/ContainerDocumentation.lua +++ b/APIDocumentation/Documentation/ContainerDocumentation.lua @@ -2,7 +2,7 @@ local Container = { Name = "Container", Type = "System", - Namespace = "C_Container", + Namespace = "Container", Functions = { @@ -12,12 +12,12 @@ local Container = Arguments = { - { Name = "containerID", Type = "BagIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, }, Returns = { - { Name = "inventoryID", Type = "luaIndex", Nilable = false }, + { Name = "inventoryID", Type = "number", Nilable = false }, }, }, { @@ -26,9 +26,27 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, - { Name = "isEquipped", Type = "bool", Nilable = false, Default = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EquipmentManager_UnpackLocation", + Type = "Function", + + Arguments = + { + { Name = "location", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "player", Type = "bool", Nilable = false }, + { Name = "bank", Type = "bool", Nilable = false }, + { Name = "bags", Type = "bool", Nilable = false }, + { Name = "location or slot", Type = "number", Nilable = false }, + { Name = "bag", Type = "number", Nilable = false }, }, }, { @@ -37,27 +55,12 @@ local Container = Arguments = { - { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, }, Returns = { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetBagSlotFlag", - Type = "Function", - - Arguments = - { - { Name = "bagIndex", Type = "BagIndex", Nilable = false }, - { Name = "flag", Type = "BagSlotFlags", Nilable = false }, - }, - - Returns = - { - { Name = "isSet", Type = "bool", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, }, }, { @@ -66,12 +69,13 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "returnTable", Type = "table", Nilable = true }, }, Returns = { - { Name = "freeSlots", Type = "table", InnerType = "luaIndex", Nilable = false }, + { Name = "slotTable", Type = "table", Nilable = false }, }, }, { @@ -80,14 +84,14 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { - { Name = "startTime", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, { Name = "enable", Type = "number", Nilable = false }, }, }, @@ -97,14 +101,14 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { { Name = "durability", Type = "number", Nilable = false }, - { Name = "maxDurability", Type = "number", Nilable = false }, + { Name = "max", Type = "number", Nilable = false }, }, }, { @@ -113,13 +117,15 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { - { Name = "numGems", Type = "table", InnerType = "number", Nilable = false }, + { Name = "gem1", Type = "number", Nilable = false }, + { Name = "gem2", Type = "number", Nilable = false }, + { Name = "gem3", Type = "number", Nilable = false }, }, }, { @@ -128,13 +134,13 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { - { Name = "containerID", Type = "number", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, }, }, { @@ -143,13 +149,19 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { - { Name = "containerInfo", Type = "ContainerItemInfo", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "locked", Type = "1nil", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "readable", Type = "1nil", Nilable = false }, + { Name = "lootable", Type = "1nil", Nilable = false }, + { Name = "link", Type = "itemLink", Nilable = false }, }, }, { @@ -158,30 +170,13 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { - { Name = "itemLink", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetContainerItemPurchaseCurrency", - Type = "Function", - - 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 = "link", Type = "hyperlink", Nilable = false }, }, }, { @@ -190,14 +185,18 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, - { Name = "isEquipped", Type = "bool", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "IsEquipped", Type = "bool", Nilable = false }, }, Returns = { - { Name = "info", Type = "ItemPurchaseInfo", Nilable = false }, + { Name = "money", Type = "number", Nilable = false }, + { Name = "itemCount", Type = "number", Nilable = false }, + { Name = "refundSec", Type = "number", Nilable = false }, + { Name = "currecycount", Type = "number", Nilable = false }, + { Name = "hasEnchants", Type = "number", Nilable = false }, }, }, { @@ -206,30 +205,16 @@ local Container = 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 }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "itemInfo", Type = "ItemPurchaseItem", Nilable = false }, - }, - }, - { - Name = "GetContainerItemQuestInfo", - Type = "Function", - - Arguments = - { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "questInfo", Type = "ItemQuestInfo", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "link", Type = "itemLink", Nilable = false }, }, }, { @@ -238,13 +223,13 @@ local Container = Arguments = { - { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, }, Returns = { - { Name = "numFreeSlots", Type = "number", Nilable = false }, - { Name = "bagFamily", Type = "number", Nilable = true }, + { Name = "freeSlots", Type = "number", Nilable = false }, + { Name = "bagType", Type = "number", Nilable = false }, }, }, { @@ -253,7 +238,7 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, }, Returns = @@ -262,58 +247,30 @@ local Container = }, }, { - Name = "GetInsertItemsLeftToRight", - Type = "Function", - - Returns = - { - { Name = "isEnabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetItemCooldown", + Name = "GetItemFamily", Type = "Function", Arguments = { - { Name = "itemID", Type = "number", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "startTime", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, - { Name = "enable", Type = "number", Nilable = false }, + { Name = "bagType", Type = "number", Nilable = false }, }, }, { - Name = "IsBagSlotFlagEnabledOnOtherBankBags", + Name = "PickupBagFromSlot", Type = "Function", Arguments = { - { Name = "bagIndex", Type = "BagIndex", Nilable = false }, - { Name = "flagIndex", Type = "luaIndex", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, - Returns = - { - { Name = "isSet", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsContainerFiltered", - Type = "Function", - - Arguments = - { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isFiltered", Type = "bool", Nilable = false }, - }, }, { Name = "PickupContainerItem", @@ -321,8 +278,32 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PutItemInBackpack", + Type = "Function", + + Returns = + { + { Name = "hadItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PutItemInBag", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hadItem", Type = "bool", Nilable = false }, }, }, { @@ -331,48 +312,10 @@ local Container = Arguments = { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "texture", Type = "table", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, }, - }, - { - Name = "SetBagSlotFlag", - Type = "Function", - Arguments = - { - { Name = "bagIndex", Type = "BagIndex", Nilable = false }, - { Name = "flag", Type = "BagSlotFlags", Nilable = false }, - { Name = "isSet", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetInsertItemsLeftToRight", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetItemSearch", - Type = "Function", - - Arguments = - { - { Name = "searchString", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ShowContainerSellCursor", - Type = "Function", - - Arguments = - { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, - }, }, { Name = "SocketContainerItem", @@ -380,14 +323,10 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, }, { Name = "SplitContainerItem", @@ -395,10 +334,11 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, { Name = "amount", Type = "number", Nilable = false }, }, + }, { Name = "UseContainerItem", @@ -406,11 +346,11 @@ local Container = Arguments = { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, - { Name = "unitToken", Type = "UnitToken", Nilable = true }, - { Name = "reagentBankOpen", Type = "bool", Nilable = false, Default = false }, + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "target", Type = "string", Nilable = true }, }, + }, }, @@ -422,19 +362,9 @@ local Container = LiteralName = "BAG_CLOSED", Payload = { - { Name = "bagID", Type = "BagIndex", Nilable = false }, + { Name = "bagID", Type = "number", Nilable = false }, }, }, - { - Name = "BagContainerUpdate", - Type = "Event", - LiteralName = "BAG_CONTAINER_UPDATE", - }, - { - Name = "BagNewItemsUpdated", - Type = "Event", - LiteralName = "BAG_NEW_ITEMS_UPDATED", - }, { Name = "BagOpen", Type = "Event", @@ -444,27 +374,13 @@ local Container = { Name = "bagID", Type = "number", Nilable = false }, }, }, - { - Name = "BagOverflowWithFullInventory", - Type = "Event", - LiteralName = "BAG_OVERFLOW_WITH_FULL_INVENTORY", - }, - { - Name = "BagSlotFlagsUpdated", - Type = "Event", - LiteralName = "BAG_SLOT_FLAGS_UPDATED", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, { Name = "BagUpdate", Type = "Event", LiteralName = "BAG_UPDATE", Payload = { - { Name = "bagID", Type = "BagIndex", Nilable = false }, + { Name = "bagID", Type = "containerID", Nilable = false }, }, }, { @@ -472,147 +388,11 @@ local Container = Type = "Event", LiteralName = "BAG_UPDATE_COOLDOWN", }, - { - Name = "BagUpdateDelayed", - Type = "Event", - LiteralName = "BAG_UPDATE_DELAYED", - }, - { - Name = "EquipBindRefundableConfirm", - Type = "Event", - LiteralName = "EQUIP_BIND_REFUNDABLE_CONFIRM", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, - { - Name = "EquipBindTradeableConfirm", - Type = "Event", - LiteralName = "EQUIP_BIND_TRADEABLE_CONFIRM", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, - { - Name = "ExpandBagBarChanged", - Type = "Event", - LiteralName = "EXPAND_BAG_BAR_CHANGED", - Payload = - { - { Name = "expandBagBar", Type = "bool", Nilable = false }, - }, - }, - { - Name = "InventorySearchUpdate", - Type = "Event", - LiteralName = "INVENTORY_SEARCH_UPDATE", - }, - { - Name = "ItemLockChanged", - Type = "Event", - LiteralName = "ITEM_LOCK_CHANGED", - Payload = - { - { Name = "bagOrSlotIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "ItemLocked", - Type = "Event", - LiteralName = "ITEM_LOCKED", - Payload = - { - { Name = "bagOrSlotIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "ItemUnlocked", - Type = "Event", - LiteralName = "ITEM_UNLOCKED", - Payload = - { - { Name = "bagOrSlotIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "UseCombinedBagsChanged", - Type = "Event", - LiteralName = "USE_COMBINED_BAGS_CHANGED", - 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 = "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 +APIDocumentation:AddDocumentationTable(Container); diff --git a/APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua b/APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua deleted file mode 100644 index 644e109..0000000 --- a/APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua +++ /dev/null @@ -1,110 +0,0 @@ -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 = "ContentTrackingTargetType", - Type = "Enumeration", - NumValues = 4, - MinValue = 0, - MaxValue = 3, - 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 = "ContentTrackingType", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Appearance", Type = "ContentTrackingType", EnumValue = 0 }, - { Name = "Mount", Type = "ContentTrackingType", EnumValue = 1 }, - { Name = "Achievement", Type = "ContentTrackingType", EnumValue = 2 }, - }, - }, - { - 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 = "cstring", 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/APIDocumentation/Documentation/ContributionCollectorDocumentation.lua b/APIDocumentation/Documentation/ContributionCollectorDocumentation.lua deleted file mode 100644 index 6782e42..0000000 --- a/APIDocumentation/Documentation/ContributionCollectorDocumentation.lua +++ /dev/null @@ -1,75 +0,0 @@ -local ContributionCollector = -{ - Name = "ContributionCollector", - Type = "System", - Namespace = "C_ContributionCollector", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - { - Name = "ContributionAppearanceFlags", - Type = "Enumeration", - NumValues = 1, - MinValue = 0, - MaxValue = 0, - Fields = - { - { Name = "TooltipUseTimeRemaining", Type = "ContributionAppearanceFlags", EnumValue = 0 }, - }, - }, - { - 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/APIDocumentation/Documentation/CooldownFrameAPIDocumentation.lua b/APIDocumentation/Documentation/CooldownFrameAPIDocumentation.lua deleted file mode 100644 index 131ce94..0000000 --- a/APIDocumentation/Documentation/CooldownFrameAPIDocumentation.lua +++ /dev/null @@ -1,359 +0,0 @@ -local CooldownFrameAPI = -{ - Name = "CooldownFrameAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "Clear", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "GetCooldownDisplayDuration", - Type = "Function", - Documentation = { "The returned duration unit is milliseconds, unaffected by modRate." }, - - Arguments = - { - }, - - Returns = - { - { Name = "duration", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCooldownDuration", - Type = "Function", - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "start", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetDrawBling", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "drawBling", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetDrawEdge", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "drawEdge", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetDrawSwipe", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "drawSwipe", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetEdgeScale", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "edgeScale", 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 = "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", - - 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", - - Arguments = - { - { Name = "start", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, - { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, - }, - }, - { - Name = "SetCooldownDuration", - Type = "Function", - - Arguments = - { - { Name = "duration", Type = "number", Nilable = false }, - { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, - }, - }, - { - Name = "SetCooldownUNIX", - Type = "Function", - - 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", - - Arguments = - { - { Name = "seconds", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCountdownFont", - Type = "Function", - - Arguments = - { - { Name = "fontName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetDrawBling", - Type = "Function", - - Arguments = - { - { Name = "drawBling", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDrawEdge", - Type = "Function", - - Arguments = - { - { Name = "drawEdge", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDrawSwipe", - Type = "Function", - - Arguments = - { - { Name = "drawSwipe", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetEdgeScale", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetEdgeTexture", - Type = "Function", - - 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", - - Arguments = - { - { Name = "hideNumbers", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetReverse", - Type = "Function", - - Arguments = - { - { Name = "reverse", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetRotation", - Type = "Function", - - Arguments = - { - { Name = "rotationRadians", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSwipeColor", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "low", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - { Name = "high", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - }, - }, - { - Name = "SetUseCircularEdge", - Type = "Function", - - Arguments = - { - { Name = "useCircularEdge", Type = "bool", Nilable = false, Default = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(CooldownFrameAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CraftInfoDocumentation.lua b/APIDocumentation/Documentation/CraftInfoDocumentation.lua deleted file mode 100644 index 0f15e33..0000000 --- a/APIDocumentation/Documentation/CraftInfoDocumentation.lua +++ /dev/null @@ -1,35 +0,0 @@ -local CraftInfo = -{ - Name = "CraftInfo", - Type = "System", - Namespace = "C_CraftInfo", - - Functions = - { - }, - - Events = - { - { - Name = "CraftClose", - Type = "Event", - LiteralName = "CRAFT_CLOSE", - }, - { - Name = "CraftShow", - Type = "Event", - LiteralName = "CRAFT_SHOW", - }, - { - Name = "CraftUpdate", - Type = "Event", - LiteralName = "CRAFT_UPDATE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(CraftInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CreatureInfoDocumentation.lua b/APIDocumentation/Documentation/CreatureInfoDocumentation.lua deleted file mode 100644 index 2ee3594..0000000 --- a/APIDocumentation/Documentation/CreatureInfoDocumentation.lua +++ /dev/null @@ -1,91 +0,0 @@ -local CreatureInfo = -{ - Name = "CreatureInfo", - Type = "System", - Namespace = "C_CreatureInfo", - - Functions = - { - { - Name = "GetClassInfo", - Type = "Function", - - Arguments = - { - { Name = "classID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "classInfo", Type = "ClassInfo", Nilable = true }, - }, - }, - { - Name = "GetFactionInfo", - Type = "Function", - - Arguments = - { - { Name = "raceID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "factionInfo", Type = "FactionInfo", Nilable = true }, - }, - }, - { - Name = "GetRaceInfo", - Type = "Function", - - 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 = "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/APIDocumentation/Documentation/CurrencyConstantsDocumentation.lua b/APIDocumentation/Documentation/CurrencyConstantsDocumentation.lua deleted file mode 100644 index d0ff4c4..0000000 --- a/APIDocumentation/Documentation/CurrencyConstantsDocumentation.lua +++ /dev/null @@ -1,131 +0,0 @@ -local CurrencyConstants = -{ - Tables = - { - { - 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 = "DeprecatedCurrencyFlag", Type = "CurrencyFlags", EnumValue = 2147483648 }, - }, - }, - { - Name = "CurrencyFlagsB", - Type = "Enumeration", - NumValues = 4, - MinValue = 1, - MaxValue = 8, - 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 = "CurrencyGainFlags", - Type = "Enumeration", - NumValues = 3, - MinValue = 1, - MaxValue = 4, - Fields = - { - { Name = "BonusAward", Type = "CurrencyGainFlags", EnumValue = 1 }, - { Name = "DroppedFromDeath", Type = "CurrencyGainFlags", EnumValue = 2 }, - { Name = "FromAccountServer", Type = "CurrencyGainFlags", EnumValue = 4 }, - }, - }, - { - Name = "CurrencyTokenCategoryFlags", - Type = "Enumeration", - NumValues = 4, - MinValue = 1, - MaxValue = 8, - 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 = "LinkedCurrencyFlags", - Type = "Enumeration", - NumValues = 3, - MinValue = 1, - MaxValue = 4, - Fields = - { - { Name = "IgnoreAdd", Type = "LinkedCurrencyFlags", EnumValue = 1 }, - { Name = "IgnoreSubtract", Type = "LinkedCurrencyFlags", EnumValue = 2 }, - { Name = "SuppressChatLog", Type = "LinkedCurrencyFlags", EnumValue = 4 }, - }, - }, - { - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(CurrencyConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CurrencyConstants_ClassicDocumentation.lua b/APIDocumentation/Documentation/CurrencyConstants_ClassicDocumentation.lua deleted file mode 100644 index 5c714d4..0000000 --- a/APIDocumentation/Documentation/CurrencyConstants_ClassicDocumentation.lua +++ /dev/null @@ -1,83 +0,0 @@ -local CurrencyConstants_Classic = -{ - Tables = - { - { - Name = "CurrencyDestroyReason", - Type = "Enumeration", - NumValues = 11, - MinValue = 0, - MaxValue = 10, - 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 = "Last", Type = "CurrencyDestroyReason", EnumValue = 10 }, - }, - }, - { - Name = "CurrencySource", - Type = "Enumeration", - NumValues = 44, - MinValue = 0, - MaxValue = 43, - 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 = "QuestRewardIgnoreCaps", 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 = "WorldQuestRewardIgnoreCaps", Type = "CurrencySource", EnumValue = 36 }, - { Name = "AccountCopy", Type = "CurrencySource", EnumValue = 37 }, - { Name = "ArenaPoints", Type = "CurrencySource", EnumValue = 38 }, - { Name = "PvPTeamContribution", Type = "CurrencySource", EnumValue = 39 }, - { Name = "PvPHonorQuestReward", Type = "CurrencySource", EnumValue = 40 }, - { Name = "AuctionDeposit", Type = "CurrencySource", EnumValue = 41 }, - { Name = "Barbershop", Type = "CurrencySource", EnumValue = 42 }, - { Name = "Last", Type = "CurrencySource", EnumValue = 43 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(CurrencyConstants_Classic); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CurrencyDocumentation.lua b/APIDocumentation/Documentation/CurrencyDocumentation.lua new file mode 100644 index 0000000..6a1648f --- /dev/null +++ b/APIDocumentation/Documentation/CurrencyDocumentation.lua @@ -0,0 +1,177 @@ +local Currency = +{ + Name = "Currency", + Type = "System", + Namespace = "Currency", + + Functions = + { + { + Name = "ExpandCurrencyList", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "shouldExpand", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetBackpackCurrencyInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "extraCurrencyType", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseInfo", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "IsEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + { Name = "itemCount", Type = "number", Nilable = false }, + { Name = "refundSec", Type = "number", Nilable = false }, + { Name = "currecycount", Type = "number", Nilable = false }, + { Name = "hasEnchants", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseItem", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "link", Type = "itemLink", Nilable = false }, + }, + }, + { + Name = "GetCurrencyListInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "isExpanded", Type = "bool", Nilable = false }, + { Name = "isUnused", Type = "bool", Nilable = false }, + { Name = "isWatched", Type = "bool", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "extraCurrencyType", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrencyListSize", + Type = "Function", + + Returns = + { + { Name = "numEntries", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHolidayBGHonorCurrencyBonuses", + Type = "Function", + + Returns = + { + { Name = "unk", Type = "bool", Nilable = false }, + { Name = "honorWinReward", Type = "number", Nilable = false }, + { Name = "arenaWinReward", Type = "number", Nilable = false }, + { Name = "honorLossReward", Type = "number", Nilable = false }, + { Name = "arenaLossReward", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHonorCurrency", + Type = "Function", + + Returns = + { + { Name = "honorPoints", Type = "number", Nilable = false }, + { Name = "maxHonor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxArenaCurrency", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetCurrencyBackpack", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "watch", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetCurrencyUnused", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "makeUnused", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "CurrencyDisplayUpdate", + Type = "Event", + LiteralName = "CURRENCY_DISPLAY_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Currency); diff --git a/APIDocumentation/Documentation/CurrencyInfoDocumentation.lua b/APIDocumentation/Documentation/CurrencyInfoDocumentation.lua deleted file mode 100644 index 0c3db02..0000000 --- a/APIDocumentation/Documentation/CurrencyInfoDocumentation.lua +++ /dev/null @@ -1,148 +0,0 @@ -local CurrencyInfo = -{ - Name = "CurrencySystem", - Type = "System", - Namespace = "C_CurrencyInfo", - - Functions = - { - { - Name = "GetBasicCurrencyInfo", - Type = "Function", - - Arguments = - { - { Name = "currencyType", Type = "number", Nilable = false }, - { Name = "quantity", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "info", Type = "CurrencyDisplayInfo", Nilable = false }, - }, - }, - { - Name = "GetCurrencyContainerInfo", - Type = "Function", - - Arguments = - { - { Name = "currencyType", Type = "number", Nilable = false }, - { Name = "quantity", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "CurrencyDisplayInfo", Nilable = false }, - }, - }, - { - Name = "GetCurrencyInfo", - Type = "Function", - - Arguments = - { - { Name = "type", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "CurrencyInfo", Nilable = false }, - }, - }, - { - Name = "GetCurrencyInfoFromLink", - Type = "Function", - - Arguments = - { - { Name = "link", Type = "string", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "CurrencyInfo", Nilable = false }, - }, - }, - { - Name = "GetCurrencyListLink", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "link", Type = "cstring", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "CurrencyDisplayUpdate", - Type = "Event", - LiteralName = "CURRENCY_DISPLAY_UPDATE", - 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 = "quantityLostSource", Type = "number", Nilable = true }, - }, - }, - { - Name = "PlayerMoney", - Type = "Event", - LiteralName = "PLAYER_MONEY", - }, - }, - - Tables = - { - { - 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 = "isHeader", Type = "bool", Nilable = false }, - { Name = "isHeaderExpanded", Type = "bool", 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(CurrencyInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CursorConstDocumentation.lua b/APIDocumentation/Documentation/CursorConstDocumentation.lua deleted file mode 100644 index c6910a6..0000000 --- a/APIDocumentation/Documentation/CursorConstDocumentation.lua +++ /dev/null @@ -1,96 +0,0 @@ -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 = 66, - MinValue = 0, - MaxValue = 65, - 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 = "VehicleCursor", Type = "Cursormode", EnumValue = 30 }, - { Name = "MapPinCursor", Type = "Cursormode", EnumValue = 31 }, - { Name = "UIMoveCursor", Type = "Cursormode", EnumValue = 32 }, - { Name = "UIResizeCursor", Type = "Cursormode", EnumValue = 33 }, - { Name = "PointErrorCursor", Type = "Cursormode", EnumValue = 34 }, - { Name = "CastErrorCursor", Type = "Cursormode", EnumValue = 35 }, - { Name = "BuyErrorCursor", Type = "Cursormode", EnumValue = 36 }, - { Name = "AttackErrorCursor", Type = "Cursormode", EnumValue = 37 }, - { Name = "InteractErrorCursor", Type = "Cursormode", EnumValue = 38 }, - { Name = "SpeakErrorCursor", Type = "Cursormode", EnumValue = 39 }, - { Name = "InspectErrorCursor", Type = "Cursormode", EnumValue = 40 }, - { Name = "PickupErrorCursor", Type = "Cursormode", EnumValue = 41 }, - { Name = "TaxiErrorCursor", Type = "Cursormode", EnumValue = 42 }, - { Name = "TrainerErrorCursor", Type = "Cursormode", EnumValue = 43 }, - { Name = "MineErrorCursor", Type = "Cursormode", EnumValue = 44 }, - { Name = "SkinErrorCursor", Type = "Cursormode", EnumValue = 45 }, - { Name = "GatherErrorCursor", Type = "Cursormode", EnumValue = 46 }, - { Name = "LockErrorCursor", Type = "Cursormode", EnumValue = 47 }, - { Name = "MailErrorCursor", Type = "Cursormode", EnumValue = 48 }, - { Name = "LootAllErrorCursor", Type = "Cursormode", EnumValue = 49 }, - { Name = "RepairErrorCursor", Type = "Cursormode", EnumValue = 50 }, - { Name = "RepairnpcErrorCursor", Type = "Cursormode", EnumValue = 51 }, - { Name = "ItemErrorCursor", Type = "Cursormode", EnumValue = 52 }, - { Name = "SkinHordeErrorCursor", Type = "Cursormode", EnumValue = 53 }, - { Name = "SkinAllianceErrorCursor", Type = "Cursormode", EnumValue = 54 }, - { Name = "InnkeeperErrorCursor", Type = "Cursormode", EnumValue = 55 }, - { Name = "CampaignQuestErrorCursor", Type = "Cursormode", EnumValue = 56 }, - { Name = "CampaignQuestTurninErrorCursor", Type = "Cursormode", EnumValue = 57 }, - { Name = "QuestErrorCursor", Type = "Cursormode", EnumValue = 58 }, - { Name = "QuestRepeatableErrorCursor", Type = "Cursormode", EnumValue = 59 }, - { Name = "QuestTurninErrorCursor", Type = "Cursormode", EnumValue = 60 }, - { Name = "QuestLegendaryErrorCursor", Type = "Cursormode", EnumValue = 61 }, - { Name = "QuestLegendaryTurninErrorCursor", Type = "Cursormode", EnumValue = 62 }, - { Name = "VehicleErrorCursor", Type = "Cursormode", EnumValue = 63 }, - { Name = "MapPinErrorCursor", Type = "Cursormode", EnumValue = 64 }, - { Name = "CustomCursor", Type = "Cursormode", EnumValue = 65 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(CursorConst); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CursorDocumentation.lua b/APIDocumentation/Documentation/CursorDocumentation.lua index b6db8bf..2757856 100644 --- a/APIDocumentation/Documentation/CursorDocumentation.lua +++ b/APIDocumentation/Documentation/CursorDocumentation.lua @@ -2,95 +2,484 @@ local Cursor = { Name = "Cursor", Type = "System", - Namespace = "C_Cursor", + Namespace = "Cursor", Functions = { { - Name = "GetCursorItem", + Name = "AddTradeMoney", + Type = "Function", + + }, + { + Name = "AutoEquipCursorItem", + Type = "Function", + + }, + { + Name = "ClearCursor", + Type = "Function", + + }, + { + Name = "ClickAuctionSellItemButton", + Type = "Function", + + }, + { + Name = "ClickSendMailItemButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "autoReturn", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ClickSocketButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ClickTargetTradeButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ClickTradeButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CursorCanGoInSlot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canBePlaced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasItem", Type = "Function", Returns = { - { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "hasItem", Type = "bool", Nilable = false }, }, }, + { + Name = "CursorHasMacro", + Type = "Function", + + Returns = + { + { Name = "hasMacro", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasMoney", + Type = "Function", + + Returns = + { + { Name = "hasMoney", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasSpell", + Type = "Function", + + Returns = + { + { Name = "hasSpell", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeleteCursorItem", + Type = "Function", + + }, + { + Name = "DropCursorMoney", + Type = "Function", + + }, + { + Name = "DropItemOnUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "EquipCursorItem", + Type = "Function", + + }, + { + Name = "GetCursorInfo", + Type = "Function", + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "data", Type = "number", Nilable = false }, + { Name = "subType", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetCursorMoney", + Type = "Function", + + Returns = + { + { Name = "cursorMoney", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCursorPosition", + Type = "Function", + + Returns = + { + { Name = "cursorX", Type = "number", Nilable = false }, + { Name = "cursorY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMouseFocus", + Type = "Function", + + Returns = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "HideRepairCursor", + Type = "Function", + + }, + { + Name = "InRepairMode", + Type = "Function", + + Returns = + { + { Name = "inRepair", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupBagFromSlot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupCompanion", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "PickupContainerItem", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupGuildBankItem", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupGuildBankMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupInventoryItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupItem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "PickupMacro", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "PickupMerchantItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "PickupPetAction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "PickupPlayerMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupSpell", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "bookType", Type = "string", Nilable = false }, + }, + + }, + { + Name = "PickupStablePet", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "PickupTradeMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PlaceAction", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PutItemInBackpack", + Type = "Function", + + Returns = + { + { Name = "hadItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PutItemInBag", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "hadItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetCursor", + Type = "Function", + + }, + { + Name = "SetCursor", + Type = "Function", + + }, + { + Name = "ShowBuybackSellCursor", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ShowContainerSellCursor", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ShowInventorySellCursor", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ShowMerchantSellCursor", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ShowRepairCursor", + Type = "Function", + + }, + { + Name = "SplitContainerItem", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SplitGuildBankItem", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, }, Events = { { - Name = "BattlePetCursorClear", + Name = "CursorUpdate", Type = "Event", - LiteralName = "BATTLE_PET_CURSOR_CLEAR", - }, - { - Name = "CursorChanged", - Type = "Event", - LiteralName = "CURSOR_CHANGED", - 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", + LiteralName = "CURSOR_UPDATE", }, }, Tables = { - { - Name = "UICursorType", - Type = "Enumeration", - NumValues = 21, - 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 = "Ammo", Type = "UICursorType", EnumValue = 8 }, - { Name = "Pet", Type = "UICursorType", EnumValue = 10 }, - { Name = "GuildBank", Type = "UICursorType", EnumValue = 11 }, - { Name = "GuildBankMoney", Type = "UICursorType", EnumValue = 12 }, - { Name = "EquipmentSet", Type = "UICursorType", EnumValue = 13 }, - { Name = "Currency", Type = "UICursorType", EnumValue = 14 }, - { Name = "Flyout", Type = "UICursorType", EnumValue = 15 }, - { Name = "VoidItem", Type = "UICursorType", EnumValue = 16 }, - { Name = "BattlePet", Type = "UICursorType", EnumValue = 17 }, - { Name = "Mount", Type = "UICursorType", EnumValue = 18 }, - { Name = "Toy", Type = "UICursorType", EnumValue = 19 }, - { Name = "ConduitCollectionItem", Type = "UICursorType", EnumValue = 20 }, - { Name = "PerksProgramVendorItem", 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(Cursor); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Cursor); diff --git a/APIDocumentation/Documentation/CvarDocumentation.lua b/APIDocumentation/Documentation/CvarDocumentation.lua new file mode 100644 index 0000000..8faf5e6 --- /dev/null +++ b/APIDocumentation/Documentation/CvarDocumentation.lua @@ -0,0 +1,140 @@ +local Cvar = +{ + Name = "CVar", + Type = "System", + Namespace = "CVar", + + Functions = + { + { + Name = "GetCVar", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "string", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetCVarAbsoluteMin", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "min", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCVarBool", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCVarDefault", + Type = "Function", + + Arguments = + { + { Name = "CVar", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetCVarInfo", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "string", Nilable = false }, + { Name = "defaultValue", Type = "string", Nilable = false }, + { Name = "serverStoredAccountWide", Type = "bool", Nilable = false }, + { Name = "serverStoredPerCharacter", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCVarMin", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "min", Type = "number", Nilable = false }, + }, + }, + { + Name = "RegisterCVar", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + { Name = "default", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetCVar", + Type = "Function", + + Arguments = + { + { Name = "cvar", Type = "string", Nilable = false }, + { Name = "value", Type = "any", Nilable = false }, + { Name = "raiseEvent", Type = "string", Nilable = true }, + }, + + }, + }, + + Events = + { + { + Name = "CvarUpdate", + Type = "Event", + LiteralName = "CVAR_UPDATE", + Payload = + { + { Name = "glStr", Type = "string", Nilable = false }, + { Name = "value", Type = "string", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Cvar); diff --git a/APIDocumentation/Documentation/DamageConstantsDocumentation.lua b/APIDocumentation/Documentation/DamageConstantsDocumentation.lua deleted file mode 100644 index 6733a9c..0000000 --- a/APIDocumentation/Documentation/DamageConstantsDocumentation.lua +++ /dev/null @@ -1,105 +0,0 @@ -local DamageConstants = -{ - Tables = - { - { - Name = "Damageclass", - Type = "Enumeration", - NumValues = 47, - 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 = "NumClasses", Type = "Damageclass", EnumValue = 7 }, - { 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/APIDocumentation/Documentation/DateAndTimeDocumentation.lua b/APIDocumentation/Documentation/DateAndTimeDocumentation.lua deleted file mode 100644 index cb5f262..0000000 --- a/APIDocumentation/Documentation/DateAndTimeDocumentation.lua +++ /dev/null @@ -1,115 +0,0 @@ -local DateAndTime = -{ - Name = "DateAndTime", - Type = "System", - Namespace = "C_DateAndTime", - - Functions = - { - { - Name = "AdjustTimeByDays", - Type = "Function", - - Arguments = - { - { Name = "date", Type = "CalendarTime", Nilable = false }, - { Name = "days", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "newDate", Type = "CalendarTime", Nilable = false }, - }, - }, - { - Name = "AdjustTimeByMinutes", - Type = "Function", - - Arguments = - { - { Name = "date", Type = "CalendarTime", Nilable = false }, - { Name = "minutes", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "newDate", Type = "CalendarTime", Nilable = false }, - }, - }, - { - Name = "CompareCalendarTime", - Type = "Function", - - Arguments = - { - { Name = "lhsCalendarTime", Type = "CalendarTime", Nilable = false }, - { Name = "rhsCalendarTime", Type = "CalendarTime", Nilable = false }, - }, - - Returns = - { - { Name = "comparison", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCalendarTimeFromEpoch", - Type = "Function", - - 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 }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(DateAndTime); \ No newline at end of file diff --git a/APIDocumentation/Documentation/DeathInfoDocumentation.lua b/APIDocumentation/Documentation/DeathInfoDocumentation.lua deleted file mode 100644 index 07c7acd..0000000 --- a/APIDocumentation/Documentation/DeathInfoDocumentation.lua +++ /dev/null @@ -1,206 +0,0 @@ -local DeathInfo = -{ - Name = "DeathInfo", - Type = "System", - Namespace = "C_DeathInfo", - - Functions = - { - { - Name = "GetCorpseMapPosition", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, - }, - }, - { - Name = "GetDeathReleasePosition", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, - }, - }, - { - Name = "GetGraveyardsForMap", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "graveyards", Type = "table", InnerType = "GraveyardMapInfo", Nilable = false }, - }, - }, - { - Name = "GetSelfResurrectOptions", - Type = "Function", - - Returns = - { - { Name = "options", Type = "table", InnerType = "SelfResurrectOption", Nilable = false }, - }, - }, - { - Name = "UseSelfResurrectOption", - Type = "Function", - - Arguments = - { - { Name = "optionType", Type = "SelfResurrectOptionType", Nilable = false }, - { Name = "id", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AreaSpiritHealerInRange", - Type = "Event", - LiteralName = "AREA_SPIRIT_HEALER_IN_RANGE", - }, - { - Name = "AreaSpiritHealerOutOfRange", - Type = "Event", - LiteralName = "AREA_SPIRIT_HEALER_OUT_OF_RANGE", - }, - { - Name = "CemeteryPreferenceUpdated", - Type = "Event", - LiteralName = "CEMETERY_PREFERENCE_UPDATED", - }, - { - Name = "ConfirmXpLoss", - Type = "Event", - LiteralName = "CONFIRM_XP_LOSS", - }, - { - Name = "CorpseInInstance", - Type = "Event", - LiteralName = "CORPSE_IN_INSTANCE", - }, - { - Name = "CorpseInRange", - Type = "Event", - LiteralName = "CORPSE_IN_RANGE", - }, - { - Name = "CorpseOutOfRange", - Type = "Event", - LiteralName = "CORPSE_OUT_OF_RANGE", - }, - { - Name = "CorpsePositionUpdate", - Type = "Event", - LiteralName = "CORPSE_POSITION_UPDATE", - }, - { - Name = "PlayerAlive", - Type = "Event", - LiteralName = "PLAYER_ALIVE", - }, - { - Name = "PlayerDead", - Type = "Event", - LiteralName = "PLAYER_DEAD", - }, - { - Name = "PlayerSkinned", - Type = "Event", - LiteralName = "PLAYER_SKINNED", - Payload = - { - { Name = "hasFreeRepop", Type = "number", Nilable = false }, - }, - }, - { - Name = "PlayerUnghost", - Type = "Event", - LiteralName = "PLAYER_UNGHOST", - }, - { - Name = "RequestCemeteryListResponse", - Type = "Event", - LiteralName = "REQUEST_CEMETERY_LIST_RESPONSE", - Payload = - { - { Name = "isGossipTriggered", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ResurrectRequest", - Type = "Event", - LiteralName = "RESURRECT_REQUEST", - Payload = - { - { Name = "inviter", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SelfResSpellChanged", - Type = "Event", - LiteralName = "SELF_RES_SPELL_CHANGED", - }, - }, - - 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/APIDocumentation/Documentation/DebuggingAndProfilingDocumentation.lua b/APIDocumentation/Documentation/DebuggingAndProfilingDocumentation.lua new file mode 100644 index 0000000..7cc1dcb --- /dev/null +++ b/APIDocumentation/Documentation/DebuggingAndProfilingDocumentation.lua @@ -0,0 +1,236 @@ +local DebuggingAndProfiling = +{ + Name = "Debugging and Profiling", + Type = "System", + Namespace = "Debugging and Profiling", + + Functions = + { + { + Name = "FrameXML_Debug", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "GetAddOnCPUUsage", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "usage", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAddOnMemoryUsage", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "mem", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetEventCPUUsage", + Type = "Function", + + Arguments = + { + { Name = "event", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "usage", Type = "number", Nilable = false }, + { Name = "numEvents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFrameCPUUsage", + Type = "Function", + + Arguments = + { + { Name = "frame", Type = "frame", Nilable = false }, + { Name = "includeChildren", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "usage", Type = "number", Nilable = false }, + { Name = "calls", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFramerate", + Type = "Function", + + Returns = + { + { Name = "framerate", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFunctionCPUUsage", + Type = "Function", + + Arguments = + { + { Name = "function", Type = "function", Nilable = false }, + { Name = "includeSubroutines", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "usage", Type = "number", Nilable = false }, + { Name = "calls", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNetStats", + Type = "Function", + + Returns = + { + { Name = "bandwidthIn", Type = "number", Nilable = false }, + { Name = "bandwidthOut", Type = "number", Nilable = false }, + { Name = "latencyHome", Type = "number", Nilable = false }, + { Name = "latencyWorld", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScriptCPUUsage", + Type = "Function", + + Returns = + { + { Name = "usage", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTaxiBenchmarkMode", + Type = "Function", + + Returns = + { + { Name = "isBenchmark", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResetCPUUsage", + Type = "Function", + + }, + { + Name = "SetTaxiBenchmarkMode", + Type = "Function", + + Arguments = + { + { Name = "arg", Type = "string", Nilable = false }, + }, + + }, + { + Name = "UpdateAddOnCPUUsage", + Type = "Function", + + }, + { + Name = "UpdateAddOnMemoryUsage", + Type = "Function", + + }, + { + Name = "debugprofilestart", + Type = "Function", + + }, + { + Name = "debugprofilestop", + Type = "Function", + + Returns = + { + { Name = "time", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "debugstack", + Type = "Function", + + Arguments = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "countTop", Type = "number", Nilable = false }, + { Name = "countBot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "debugstring", Type = "string", Nilable = false }, + }, + }, + { + Name = "geterrorhandler", + Type = "Function", + + Returns = + { + { Name = "handler", Type = "function", Nilable = false }, + }, + }, + { + Name = "issecurevariable", + Type = "Function", + + Arguments = + { + { Name = "table", Type = "table", Nilable = true }, + { Name = "variable", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "issecure", Type = "bool", Nilable = false }, + { Name = "taint", Type = "string", Nilable = false }, + }, + }, + { + Name = "seterrorhandler", + Type = "Function", + + Arguments = + { + { Name = "errHandler", Type = "function", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(DebuggingAndProfiling); diff --git a/APIDocumentation/Documentation/DeprecatedDocumentation.lua b/APIDocumentation/Documentation/DeprecatedDocumentation.lua new file mode 100644 index 0000000..b27107a --- /dev/null +++ b/APIDocumentation/Documentation/DeprecatedDocumentation.lua @@ -0,0 +1,45 @@ +local Deprecated = +{ + Name = "Deprecated", + Type = "System", + Namespace = "Deprecated", + + Functions = + { + { + Name = "AcceptSkillUps", + Type = "Function", + + }, + { + Name = "AddSkillUp", + Type = "Function", + + }, + { + Name = "GetExtendedItemInfo", + Type = "Function", + + }, + { + Name = "ReportBug", + Type = "Function", + + }, + { + Name = "ReportSuggestion", + Type = "Function", + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Deprecated); diff --git a/APIDocumentation/Documentation/DuelDocumentation.lua b/APIDocumentation/Documentation/DuelDocumentation.lua new file mode 100644 index 0000000..1d0fc97 --- /dev/null +++ b/APIDocumentation/Documentation/DuelDocumentation.lua @@ -0,0 +1,57 @@ +local Duel = +{ + Name = "Duel", + Type = "System", + Namespace = "Duel", + + Functions = + { + { + Name = "AcceptDuel", + Type = "Function", + + }, + { + Name = "CancelDuel", + Type = "Function", + + }, + { + Name = "StartDuel", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + }, + + Events = + { + { + Name = "DuelFinished", + Type = "Event", + LiteralName = "DUEL_FINISHED", + }, + { + Name = "DuelInbounds", + Type = "Event", + LiteralName = "DUEL_INBOUNDS", + }, + { + Name = "DuelOutofbounds", + Type = "Event", + LiteralName = "DUEL_OUTOFBOUNDS", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Duel); diff --git a/APIDocumentation/Documentation/DuelInfoDocumentation.lua b/APIDocumentation/Documentation/DuelInfoDocumentation.lua deleted file mode 100644 index d9264f6..0000000 --- a/APIDocumentation/Documentation/DuelInfoDocumentation.lua +++ /dev/null @@ -1,44 +0,0 @@ -local DuelInfo = -{ - Name = "DuelInfo", - Type = "System", - Namespace = "C_DuelInfo", - - Functions = - { - }, - - Events = - { - { - Name = "DuelFinished", - Type = "Event", - LiteralName = "DUEL_FINISHED", - }, - { - Name = "DuelInbounds", - Type = "Event", - LiteralName = "DUEL_INBOUNDS", - }, - { - Name = "DuelOutofbounds", - Type = "Event", - LiteralName = "DUEL_OUTOFBOUNDS", - }, - { - Name = "DuelRequested", - Type = "Event", - LiteralName = "DUEL_REQUESTED", - Payload = - { - { Name = "playerName", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(DuelInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/EditModeManagerDocumentation.lua b/APIDocumentation/Documentation/EditModeManagerDocumentation.lua deleted file mode 100644 index f2de8c7..0000000 --- a/APIDocumentation/Documentation/EditModeManagerDocumentation.lua +++ /dev/null @@ -1,181 +0,0 @@ -local EditModeManager = -{ - Name = "EditModeManager", - Type = "System", - Namespace = "C_EditMode", - - Functions = - { - { - Name = "ConvertLayoutInfoToString", - Type = "Function", - - Arguments = - { - { Name = "layoutInfo", Type = "EditModeLayoutInfo", Nilable = false }, - }, - - Returns = - { - { Name = "layoutInfoAsString", Type = "string", Nilable = false }, - }, - }, - { - Name = "ConvertStringToLayoutInfo", - Type = "Function", - - 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 = "OnEditModeExit", - Type = "Function", - }, - { - Name = "OnLayoutAdded", - Type = "Function", - - Arguments = - { - { Name = "addedLayoutIndex", Type = "luaIndex", Nilable = false }, - { Name = "activateNewLayout", Type = "bool", Nilable = false }, - { Name = "isLayoutImported", Type = "bool", Nilable = false }, - }, - }, - { - Name = "OnLayoutDeleted", - Type = "Function", - - Arguments = - { - { Name = "deletedLayoutIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SaveLayouts", - Type = "Function", - - Arguments = - { - { Name = "saveInfo", Type = "EditModeLayouts", Nilable = false }, - }, - }, - { - Name = "SetAccountSetting", - Type = "Function", - - Arguments = - { - { Name = "setting", Type = "EditModeAccountSetting", Nilable = false }, - { Name = "value", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetActiveLayout", - Type = "Function", - - Arguments = - { - { Name = "activeLayout", Type = "luaIndex", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "EditModeLayoutsUpdated", - Type = "Event", - LiteralName = "EDIT_MODE_LAYOUTS_UPDATED", - 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/APIDocumentation/Documentation/EditModeManagerSharedDocumentation.lua b/APIDocumentation/Documentation/EditModeManagerSharedDocumentation.lua deleted file mode 100644 index 50ed9b0..0000000 --- a/APIDocumentation/Documentation/EditModeManagerSharedDocumentation.lua +++ /dev/null @@ -1,507 +0,0 @@ -local EditModeManagerShared = -{ - 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 = "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 = "EditModeAccountSetting", - Type = "Enumeration", - NumValues = 25, - MinValue = 0, - MaxValue = 24, - 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 = "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 = "EditModeAuraFrameSetting", - Type = "Enumeration", - NumValues = 8, - MinValue = 0, - MaxValue = 7, - 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 = "EditModeAuraFrameSystemIndices", - Type = "Enumeration", - NumValues = 2, - MinValue = 1, - MaxValue = 2, - Fields = - { - { Name = "BuffFrame", Type = "EditModeAuraFrameSystemIndices", EnumValue = 1 }, - { Name = "DebuffFrame", Type = "EditModeAuraFrameSystemIndices", EnumValue = 2 }, - }, - }, - { - Name = "EditModeBagsSetting", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Orientation", Type = "EditModeBagsSetting", EnumValue = 0 }, - { Name = "Direction", Type = "EditModeBagsSetting", EnumValue = 1 }, - { Name = "Size", Type = "EditModeBagsSetting", EnumValue = 2 }, - }, - }, - { - 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 = "EditModeDurabilityFrameSetting", - Type = "Enumeration", - NumValues = 1, - MinValue = 0, - MaxValue = 0, - Fields = - { - { Name = "Size", Type = "EditModeDurabilityFrameSetting", EnumValue = 0 }, - }, - }, - { - 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 = 2, - MinValue = 0, - MaxValue = 1, - Fields = - { - { Name = "Height", Type = "EditModeObjectiveTrackerSetting", EnumValue = 0 }, - { Name = "Opacity", Type = "EditModeObjectiveTrackerSetting", 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 = 17, - MinValue = 0, - MaxValue = 16, - 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 = "EditModeUnitFrameSetting", - Type = "Enumeration", - NumValues = 17, - MinValue = 0, - MaxValue = 16, - 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 = "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 = "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 = "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 = "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(EditModeManagerShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/EncounterInfoDocumentation.lua b/APIDocumentation/Documentation/EncounterInfoDocumentation.lua deleted file mode 100644 index 160a521..0000000 --- a/APIDocumentation/Documentation/EncounterInfoDocumentation.lua +++ /dev/null @@ -1,90 +0,0 @@ -local EncounterInfo = -{ - Name = "EncounterInfo", - Type = "System", - Namespace = "C_EncounterInfo", - - Functions = - { - }, - - Events = - { - { - Name = "BossKill", - Type = "Event", - LiteralName = "BOSS_KILL", - Payload = - { - { Name = "encounterID", Type = "number", Nilable = false }, - { Name = "encounterName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "DisableLowLevelRaid", - Type = "Event", - LiteralName = "DISABLE_LOW_LEVEL_RAID", - }, - { - Name = "EnableLowLevelRaid", - Type = "Event", - LiteralName = "ENABLE_LOW_LEVEL_RAID", - }, - { - Name = "EncounterEnd", - Type = "Event", - LiteralName = "ENCOUNTER_END", - 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", - 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", - }, - { - Name = "InstanceLockStop", - Type = "Event", - LiteralName = "INSTANCE_LOCK_STOP", - }, - { - Name = "InstanceLockWarning", - Type = "Event", - LiteralName = "INSTANCE_LOCK_WARNING", - }, - { - Name = "RaidTargetUpdate", - Type = "Event", - LiteralName = "RAID_TARGET_UPDATE", - }, - { - Name = "UpdateInstanceInfo", - Type = "Event", - LiteralName = "UPDATE_INSTANCE_INFO", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(EncounterInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/EncounterJournalConstantsDocumentation.lua b/APIDocumentation/Documentation/EncounterJournalConstantsDocumentation.lua deleted file mode 100644 index 66283ad..0000000 --- a/APIDocumentation/Documentation/EncounterJournalConstantsDocumentation.lua +++ /dev/null @@ -1,126 +0,0 @@ -local EncounterJournalConstants = -{ - Tables = - { - { - Name = "JournalEncounterFlags", - Type = "Enumeration", - NumValues = 6, - MinValue = 1, - MaxValue = 32, - 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 = "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 = 2, - MinValue = 1, - MaxValue = 2, - Fields = - { - { Name = "Timewalker", Type = "JournalInstanceFlags", EnumValue = 1 }, - { Name = "HideUserSelectableDifficulty", Type = "JournalInstanceFlags", EnumValue = 2 }, - }, - }, - { - 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/APIDocumentation/Documentation/EquipmentManagerDocumentation.lua b/APIDocumentation/Documentation/EquipmentManagerDocumentation.lua index 2ccb3ba..54f57a6 100644 --- a/APIDocumentation/Documentation/EquipmentManagerDocumentation.lua +++ b/APIDocumentation/Documentation/EquipmentManagerDocumentation.lua @@ -1,42 +1,18 @@ local EquipmentManager = { - Name = "EquipmentSet", + Name = "Equipment Manager", Type = "System", - Namespace = "C_EquipmentSet", + Namespace = "Equipment Manager", Functions = { - { - Name = "AssignSpecToEquipmentSet", - Type = "Function", - - 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", - - Arguments = - { - { Name = "equipmentSetName", Type = "cstring", Nilable = false }, - { Name = "icon", Type = "cstring", Nilable = true }, + { Name = "enabled", Type = "bool", Nilable = false }, }, }, { @@ -45,7 +21,65 @@ local EquipmentManager = Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "EquipmentManagerClearIgnoredSlotsForSave", + Type = "Function", + + }, + { + Name = "EquipmentManagerIgnoreSlotForSave", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EquipmentManagerIsSlotIgnoredForSave", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EquipmentManagerUnignoreSlotForSave", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EquipmentManager_UnpackLocation", + Type = "Function", + + Arguments = + { + { Name = "location", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "player", Type = "bool", Nilable = false }, + { Name = "bank", Type = "bool", Nilable = false }, + { Name = "bags", Type = "bool", Nilable = false }, + { Name = "location or slot", Type = "number", Nilable = false }, + { Name = "bag", Type = "number", Nilable = false }, }, }, { @@ -54,63 +88,12 @@ local EquipmentManager = Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, }, Returns = { - { Name = "hasLockedItems", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetEquipmentSetAssignedSpec", - Type = "Function", - - Arguments = - { - { Name = "equipmentSetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "specIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "GetEquipmentSetForSpec", - Type = "Function", - - Arguments = - { - { Name = "specIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "equipmentSetID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetEquipmentSetID", - Type = "Function", - - 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 = "isLocked", Type = "bool", Nilable = false }, }, }, { @@ -119,62 +102,57 @@ local EquipmentManager = Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { { Name = "name", Type = "string", Nilable = false }, - { Name = "iconFileID", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", 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", + Name = "GetEquipmentSetInfoByName", Type = "Function", Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, }, Returns = { - { Name = "slotIgnored", Type = "table", InnerType = "bool", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "setID", Type = "number", Nilable = false }, }, }, { - Name = "GetItemIDs", + Name = "GetEquipmentSetItemIDs", Type = "Function", Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, }, Returns = { - { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + { Name = "itemIDs", Type = "table", Nilable = false }, }, }, { - Name = "GetItemLocations", + Name = "GetEquipmentSetLocations", Type = "Function", Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, }, Returns = { - { Name = "locations", Type = "table", InnerType = "number", Nilable = false }, + { Name = "itemIDs", Type = "table", Nilable = false }, }, }, { @@ -183,41 +161,7 @@ local EquipmentManager = Returns = { - { Name = "numEquipmentSets", Type = "number", Nilable = false }, - }, - }, - { - Name = "IgnoreSlotForSave", - Type = "Function", - - Arguments = - { - { Name = "slot", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "IsSlotIgnoredForSave", - Type = "Function", - - Arguments = - { - { Name = "slot", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isSlotIgnored", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ModifyEquipmentSet", - Type = "Function", - - Arguments = - { - { Name = "equipmentSetID", Type = "number", Nilable = false }, - { Name = "newName", Type = "cstring", Nilable = false }, - { Name = "newIcon", Type = "cstring", Nilable = true }, + { Name = "numSets", Type = "number", Nilable = false }, }, }, { @@ -226,8 +170,19 @@ local EquipmentManager = Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + + }, + { + Name = "PickupEquipmentSetByName", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, { Name = "SaveEquipmentSet", @@ -235,46 +190,33 @@ local EquipmentManager = Arguments = { - { Name = "equipmentSetID", Type = "number", Nilable = false }, - { Name = "icon", Type = "cstring", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, }, - }, - { - Name = "UnassignEquipmentSetSpec", - Type = "Function", - Arguments = - { - { Name = "equipmentSetID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnignoreSlotForSave", - Type = "Function", - - Arguments = - { - { Name = "slot", Type = "luaIndex", Nilable = false }, - }, }, { Name = "UseEquipmentSet", Type = "Function", - Arguments = - { - { Name = "equipmentSetID", Type = "number", Nilable = false }, - }, - Returns = { - { Name = "setWasEquipped", Type = "bool", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, }, }, }, Events = { + { + Name = "AutoequipBindConfirm", + Type = "Event", + LiteralName = "AUTOEQUIP_BIND_CONFIRM", + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, { Name = "EquipmentSetsChanged", Type = "Event", @@ -284,22 +226,12 @@ local EquipmentManager = Name = "EquipmentSwapFinished", Type = "Event", LiteralName = "EQUIPMENT_SWAP_FINISHED", - Payload = - { - { Name = "result", Type = "bool", Nilable = false }, - { Name = "setID", Type = "number", Nilable = true }, - }, }, { Name = "EquipmentSwapPending", Type = "Event", LiteralName = "EQUIPMENT_SWAP_PENDING", }, - { - Name = "TransmogOutfitsChanged", - Type = "Event", - LiteralName = "TRANSMOG_OUTFITS_CHANGED", - }, }, Tables = @@ -307,4 +239,4 @@ local EquipmentManager = }, }; -APIDocumentation:AddDocumentationTable(EquipmentManager); \ No newline at end of file +APIDocumentation:AddDocumentationTable(EquipmentManager); diff --git a/APIDocumentation/Documentation/EventUtilsDocumentation.lua b/APIDocumentation/Documentation/EventUtilsDocumentation.lua deleted file mode 100644 index 2a80c35..0000000 --- a/APIDocumentation/Documentation/EventUtilsDocumentation.lua +++ /dev/null @@ -1,43 +0,0 @@ -local EventUtils = -{ - Name = "EventUtils", - Type = "System", - Namespace = "C_EventUtils", - - Functions = - { - { - Name = "IsEventValid", - Type = "Function", - - Arguments = - { - { Name = "eventName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "valid", Type = "bool", Nilable = false }, - }, - }, - { - Name = "NotifySettingsLoaded", - Type = "Function", - }, - }, - - Events = - { - { - Name = "SettingsLoaded", - Type = "Event", - LiteralName = "SETTINGS_LOADED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(EventUtils); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ExpansionDocumentation.lua b/APIDocumentation/Documentation/ExpansionDocumentation.lua deleted file mode 100644 index 1eff160..0000000 --- a/APIDocumentation/Documentation/ExpansionDocumentation.lua +++ /dev/null @@ -1,196 +0,0 @@ -local Expansion = -{ - Name = "Expansion", - Type = "System", - - Functions = - { - { - Name = "CanUpgradeExpansion", - 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 = "GetExpansionDisplayInfo", - Type = "Function", - - Arguments = - { - { Name = "expansionLevel", Type = "number", Nilable = false }, - { Name = "desiredReleaseType", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "ExpansionDisplayInfo", Nilable = true }, - }, - }, - { - 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", - 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 = "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 = "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 }, - }, - }, - }, - - Events = - { - { - Name = "MaxExpansionLevelUpdated", - Type = "Event", - LiteralName = "MAX_EXPANSION_LEVEL_UPDATED", - }, - { - Name = "MinExpansionLevelUpdated", - Type = "Event", - LiteralName = "MIN_EXPANSION_LEVEL_UPDATED", - }, - }, - - Tables = - { - { - 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 = "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/APIDocumentation/Documentation/ExpansionLandingPageConstantsDocumentation.lua b/APIDocumentation/Documentation/ExpansionLandingPageConstantsDocumentation.lua deleted file mode 100644 index 8ba748a..0000000 --- a/APIDocumentation/Documentation/ExpansionLandingPageConstantsDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -local ExpansionLandingPageConstants = -{ - Tables = - { - { - Name = "ExpansionLandingPageType", - Type = "Enumeration", - NumValues = 2, - MinValue = 0, - MaxValue = 1, - Fields = - { - { Name = "None", Type = "ExpansionLandingPageType", EnumValue = 0 }, - { Name = "Dragonflight", Type = "ExpansionLandingPageType", EnumValue = 1 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(ExpansionLandingPageConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ExperienceXpDocumentation.lua b/APIDocumentation/Documentation/ExperienceXpDocumentation.lua new file mode 100644 index 0000000..e0cb5a2 --- /dev/null +++ b/APIDocumentation/Documentation/ExperienceXpDocumentation.lua @@ -0,0 +1,71 @@ +local ExperienceXp = +{ + Name = "Experience", + Type = "System", + Namespace = "Experience", + + Functions = + { + { + Name = "GetRewardXP", + Type = "Function", + + }, + { + Name = "GetXPExhaustion", + Type = "Function", + + Returns = + { + { Name = "exhaustionXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsXPUserDisabled", + Type = "Function", + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitXP", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "currXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitXPMax", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "playerMaxXP", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ExperienceXp); diff --git a/APIDocumentation/Documentation/FactionDocumentation.lua b/APIDocumentation/Documentation/FactionDocumentation.lua new file mode 100644 index 0000000..9d37652 --- /dev/null +++ b/APIDocumentation/Documentation/FactionDocumentation.lua @@ -0,0 +1,204 @@ +local Faction = +{ + Name = "Faction", + Type = "System", + Namespace = "Faction", + + Functions = + { + { + Name = "CollapseAllFactionHeaders", + Type = "Function", + + }, + { + Name = "CollapseFactionHeader", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ExpandAllFactionHeaders", + Type = "Function", + + }, + { + Name = "ExpandFactionHeader", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "FactionToggleAtWar", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetFactionInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "standingID", Type = "number", Nilable = false }, + { Name = "barMin", Type = "number", Nilable = false }, + { Name = "barMax", Type = "number", Nilable = false }, + { Name = "barValue", Type = "number", Nilable = false }, + { Name = "atWarWith", Type = "bool", Nilable = false }, + { Name = "canToggleAtWar", Type = "bool", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "isCollapsed", Type = "bool", Nilable = false }, + { Name = "hasRep", Type = "bool", Nilable = false }, + { Name = "isWatched", Type = "bool", Nilable = false }, + { Name = "isChild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNumFactions", + Type = "Function", + + Returns = + { + { Name = "numFactions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedFaction", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetWatchedFactionInfo", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "standingID", Type = "number", Nilable = false }, + { Name = "barMin", Type = "number", Nilable = false }, + { Name = "barMax", Type = "number", Nilable = false }, + { Name = "barValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsFactionInactive", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isInactive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetFactionActive", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetFactionInactive", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetSelectedFaction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetWatchedFactionIndex", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "ChatMsgCombatFactionChange", + Type = "Event", + LiteralName = "CHAT_MSG_COMBAT_FACTION_CHANGE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitFaction", + Type = "Event", + LiteralName = "UNIT_FACTION", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UpdateFaction", + Type = "Event", + LiteralName = "UPDATE_FACTION", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Faction); diff --git a/APIDocumentation/Documentation/FogOfWarDocumentation.lua b/APIDocumentation/Documentation/FogOfWarDocumentation.lua deleted file mode 100644 index 8143b60..0000000 --- a/APIDocumentation/Documentation/FogOfWarDocumentation.lua +++ /dev/null @@ -1,31 +0,0 @@ -local FogOfWar = -{ - Name = "FogOfWar", - Type = "System", - Namespace = "C_FogOfWar", - - Functions = - { - }, - - Events = - { - }, - - 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/APIDocumentation/Documentation/FontDocumentation.lua b/APIDocumentation/Documentation/FontDocumentation.lua deleted file mode 100644 index 697b6bd..0000000 --- a/APIDocumentation/Documentation/FontDocumentation.lua +++ /dev/null @@ -1,40 +0,0 @@ -local Font = -{ - Name = "Font", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - { - 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 = "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/APIDocumentation/Documentation/FrameAPICharacterModelBaseDocumentation.lua b/APIDocumentation/Documentation/FrameAPICharacterModelBaseDocumentation.lua deleted file mode 100644 index eccb47d..0000000 --- a/APIDocumentation/Documentation/FrameAPICharacterModelBaseDocumentation.lua +++ /dev/null @@ -1,265 +0,0 @@ -local FrameAPICharacterModelBase = -{ - Name = "FrameAPICharacterModelBase", - Type = "ScriptObject", - - Functions = - { - { - Name = "ApplySpellVisualKit", - Type = "Function", - - Arguments = - { - { Name = "spellVisualKitID", Type = "number", Nilable = false }, - { Name = "oneShot", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "CanSetUnit", - Type = "Function", - - Arguments = - { - { Name = "unit", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "FreezeAnimation", - Type = "Function", - - 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", - - Arguments = - { - { Name = "anim", Type = "AnimationDataEnum", Nilable = false }, - }, - - Returns = - { - { Name = "hasAnimation", Type = "bool", Nilable = false }, - }, - }, - { - Name = "PlayAnimKit", - Type = "Function", - - 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", - - Arguments = - { - { Name = "anim", Type = "AnimationDataEnum", Nilable = false }, - { Name = "variation", Type = "number", Nilable = true }, - }, - }, - { - Name = "SetBarberShopAlternateForm", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "SetCamDistanceScale", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCreature", - Type = "Function", - - Arguments = - { - { Name = "creatureID", Type = "number", Nilable = false }, - { Name = "displayID", Type = "number", Nilable = false, Default = 0 }, - }, - }, - { - Name = "SetDisplayInfo", - Type = "Function", - - Arguments = - { - { Name = "displayID", Type = "number", Nilable = false }, - { Name = "mountDisplayID", Type = "number", Nilable = true }, - }, - }, - { - Name = "SetDoBlend", - Type = "Function", - - Arguments = - { - { Name = "doBlend", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetItem", - Type = "Function", - - Arguments = - { - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "appearanceModID", Type = "number", Nilable = true }, - { Name = "itemVisualID", Type = "number", Nilable = true }, - }, - }, - { - Name = "SetItemAppearance", - Type = "Function", - - Arguments = - { - { Name = "itemAppearanceID", Type = "number", Nilable = false }, - { Name = "itemVisualID", Type = "number", Nilable = true }, - { Name = "itemSubclass", Type = "ItemWeaponSubclass", Nilable = true }, - }, - }, - { - Name = "SetKeepModelOnHide", - Type = "Function", - - Arguments = - { - { Name = "keepModelOnHide", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetPortraitZoom", - Type = "Function", - - Arguments = - { - { Name = "zoom", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetRotation", - Type = "Function", - - Arguments = - { - { Name = "radians", Type = "number", Nilable = false }, - { Name = "animate", Type = "bool", Nilable = false, Default = true }, - }, - }, - { - Name = "SetUnit", - Type = "Function", - - Arguments = - { - { Name = "unit", Type = "UnitToken", Nilable = false }, - { Name = "blend", Type = "bool", Nilable = false, Default = 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/APIDocumentation/Documentation/FrameAPICinematicModelDocumentation.lua b/APIDocumentation/Documentation/FrameAPICinematicModelDocumentation.lua deleted file mode 100644 index d66ceae..0000000 --- a/APIDocumentation/Documentation/FrameAPICinematicModelDocumentation.lua +++ /dev/null @@ -1,185 +0,0 @@ -local FrameAPICinematicModel = -{ - Name = "FrameAPICinematicModel", - Type = "ScriptObject", - - Functions = - { - { - Name = "EquipItem", - Type = "Function", - - Arguments = - { - { Name = "itemID", Type = "number", Nilable = false }, - }, - }, - { - Name = "InitializeCamera", - Type = "Function", - - Arguments = - { - { Name = "scaleFactor", Type = "number", Nilable = false, Default = 0 }, - }, - }, - { - Name = "InitializePanCamera", - Type = "Function", - - Arguments = - { - { Name = "scaleFactor", Type = "number", Nilable = false, Default = 0 }, - }, - }, - { - Name = "RefreshCamera", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "SetAnimOffset", - Type = "Function", - - Arguments = - { - { Name = "offset", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraPosition", - Type = "Function", - - Arguments = - { - { Name = "position", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, - }, - }, - { - Name = "SetCameraTarget", - Type = "Function", - - Arguments = - { - { Name = "position", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, - }, - }, - { - Name = "SetCreatureData", - Type = "Function", - - Arguments = - { - { Name = "creatureID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFacingLeft", - Type = "Function", - - Arguments = - { - { Name = "isFacingLeft", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetFadeTimes", - Type = "Function", - - Arguments = - { - { Name = "fadeInSeconds", Type = "number", Nilable = false }, - { Name = "fadeOutSeconds", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetHeightFactor", - Type = "Function", - - Arguments = - { - { Name = "factor", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetJumpInfo", - Type = "Function", - - Arguments = - { - { Name = "jumpLength", Type = "number", Nilable = false }, - { Name = "jumpHeight", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetPanDistance", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpellVisualKit", - Type = "Function", - - Arguments = - { - { Name = "visualKitID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetTargetDistance", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "StartPan", - Type = "Function", - - 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/APIDocumentation/Documentation/FrameAPICooldownDocumentation.lua b/APIDocumentation/Documentation/FrameAPICooldownDocumentation.lua deleted file mode 100644 index b41eea7..0000000 --- a/APIDocumentation/Documentation/FrameAPICooldownDocumentation.lua +++ /dev/null @@ -1,359 +0,0 @@ -local FrameAPICooldown = -{ - Name = "FrameAPICooldown", - Type = "ScriptObject", - - Functions = - { - { - Name = "Clear", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "GetCooldownDisplayDuration", - Type = "Function", - Documentation = { "The returned duration unit is milliseconds, unaffected by modRate." }, - - Arguments = - { - }, - - Returns = - { - { Name = "duration", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetCooldownDuration", - Type = "Function", - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "start", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetDrawBling", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "drawBling", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetDrawEdge", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "drawEdge", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetDrawSwipe", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "drawSwipe", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetEdgeScale", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "edgeScale", 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 = "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", - - 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", - - Arguments = - { - { Name = "start", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, - { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, - }, - }, - { - Name = "SetCooldownDuration", - Type = "Function", - - Arguments = - { - { Name = "duration", Type = "number", Nilable = false }, - { Name = "modRate", Type = "number", Nilable = false, Default = 1 }, - }, - }, - { - Name = "SetCooldownUNIX", - Type = "Function", - - 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", - - Arguments = - { - { Name = "seconds", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCountdownFont", - Type = "Function", - - Arguments = - { - { Name = "fontName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetDrawBling", - Type = "Function", - - Arguments = - { - { Name = "drawBling", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDrawEdge", - Type = "Function", - - Arguments = - { - { Name = "drawEdge", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDrawSwipe", - Type = "Function", - - Arguments = - { - { Name = "drawSwipe", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetEdgeScale", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetEdgeTexture", - Type = "Function", - - 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", - - Arguments = - { - { Name = "hideNumbers", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetReverse", - Type = "Function", - - Arguments = - { - { Name = "reverse", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetRotation", - Type = "Function", - - Arguments = - { - { Name = "rotationRadians", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSwipeColor", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "low", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - { Name = "high", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - }, - }, - { - Name = "SetUseCircularEdge", - Type = "Function", - - Arguments = - { - { Name = "useCircularEdge", Type = "bool", Nilable = false, Default = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameAPICooldown); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPIDressUpModelDocumentation.lua b/APIDocumentation/Documentation/FrameAPIDressUpModelDocumentation.lua deleted file mode 100644 index ba4ab44..0000000 --- a/APIDocumentation/Documentation/FrameAPIDressUpModelDocumentation.lua +++ /dev/null @@ -1,99 +0,0 @@ -local FrameAPIDressUpModel = -{ - Name = "FrameAPIDressUpModel", - Type = "ScriptObject", - - Functions = - { - { - Name = "Dress", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "GetAutoDress", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetSheathed", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "sheathed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetAutoDress", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetSheathed", - Type = "Function", - - Arguments = - { - { Name = "sheathed", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "TryOn", - Type = "Function", - - Arguments = - { - { Name = "linkOrItemModifiedAppearanceID", Type = "IDOrLink", Nilable = false }, - { Name = "handSlotName", Type = "cstring", Nilable = true }, - { Name = "spellEnchantID", Type = "number", Nilable = true }, - }, - }, - { - Name = "Undress", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "UndressSlot", - Type = "Function", - - Arguments = - { - { Name = "inventorySlot", Type = "luaIndex", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameAPIDressUpModel); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPIFogOfWarFrameDocumentation.lua b/APIDocumentation/Documentation/FrameAPIFogOfWarFrameDocumentation.lua deleted file mode 100644 index 03484c0..0000000 --- a/APIDocumentation/Documentation/FrameAPIFogOfWarFrameDocumentation.lua +++ /dev/null @@ -1,153 +0,0 @@ -local FrameAPIFogOfWarFrame = -{ - Name = "FrameAPIFogOfWarFrame", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - }, - }, - { - Name = "SetFogOfWarBackgroundTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "FileAsset", Nilable = false }, - { Name = "horizontalTile", Type = "bool", Nilable = false }, - { Name = "verticalTile", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFogOfWarMaskAtlas", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - }, - }, - { - Name = "SetFogOfWarMaskTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "FileAsset", Nilable = false }, - }, - }, - { - Name = "SetMaskScalar", - Type = "Function", - - Arguments = - { - { Name = "scalar", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetUiMapID", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameAPIFogOfWarFrame); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPIModelSceneFrameDocumentation.lua b/APIDocumentation/Documentation/FrameAPIModelSceneFrameDocumentation.lua deleted file mode 100644 index 04fe047..0000000 --- a/APIDocumentation/Documentation/FrameAPIModelSceneFrameDocumentation.lua +++ /dev/null @@ -1,558 +0,0 @@ -local FrameAPIModelSceneFrame = -{ - Name = "FrameAPIModelSceneFrame", - Type = "ScriptObject", - - Functions = - { - { - Name = "ClearFog", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "CreateActor", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "template", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetActorAtIndex", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", 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", - - 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 = "SetCameraFarClip", - Type = "Function", - - Arguments = - { - { Name = "farClip", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraFieldOfView", - Type = "Function", - Documentation = { "Field of view in radians" }, - - Arguments = - { - { Name = "fov", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraNearClip", - Type = "Function", - - Arguments = - { - { Name = "nearClip", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraOrientationByAxisVectors", - Type = "Function", - - 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", - - Arguments = - { - { Name = "yaw", Type = "number", Nilable = false }, - { Name = "pitch", Type = "number", Nilable = false }, - { Name = "roll", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraPosition", - Type = "Function", - - Arguments = - { - { Name = "positionX", Type = "number", Nilable = false }, - { Name = "positionY", Type = "number", Nilable = false }, - { Name = "positionZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetDesaturation", - Type = "Function", - - Arguments = - { - { Name = "strength", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetDrawLayer", - Type = "Function", - - Arguments = - { - { Name = "layer", Type = "DrawLayer", Nilable = false }, - }, - }, - { - Name = "SetFogColor", - Type = "Function", - - Arguments = - { - { Name = "colorR", Type = "number", Nilable = false }, - { Name = "colorG", Type = "number", Nilable = false }, - { Name = "colorB", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFogFar", - Type = "Function", - - Arguments = - { - { Name = "far", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFogNear", - Type = "Function", - - Arguments = - { - { Name = "near", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLightAmbientColor", - Type = "Function", - - Arguments = - { - { Name = "colorR", Type = "number", Nilable = false }, - { Name = "colorG", Type = "number", Nilable = false }, - { Name = "colorB", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLightDiffuseColor", - Type = "Function", - - Arguments = - { - { Name = "colorR", Type = "number", Nilable = false }, - { Name = "colorG", Type = "number", Nilable = false }, - { Name = "colorB", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLightDirection", - Type = "Function", - - Arguments = - { - { Name = "directionX", Type = "number", Nilable = false }, - { Name = "directionY", Type = "number", Nilable = false }, - { Name = "directionZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLightPosition", - Type = "Function", - - Arguments = - { - { Name = "positionX", Type = "number", Nilable = false }, - { Name = "positionY", Type = "number", Nilable = false }, - { Name = "positionZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLightType", - Type = "Function", - - Arguments = - { - { Name = "lightType", Type = "ModelLightType", Nilable = false }, - }, - }, - { - Name = "SetLightVisible", - Type = "Function", - - Arguments = - { - { Name = "visible", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetPaused", - Type = "Function", - - Arguments = - { - { Name = "paused", Type = "bool", Nilable = false }, - { Name = "affectsGlobalPause", Type = "bool", Nilable = false, Default = true }, - }, - }, - { - Name = "SetViewInsets", - Type = "Function", - - Arguments = - { - { Name = "insets", Type = "uiRect", Nilable = false }, - }, - }, - { - Name = "SetViewTranslation", - Type = "Function", - - 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/APIDocumentation/Documentation/FrameAPIModelSceneFrameSharedDocumentation.lua b/APIDocumentation/Documentation/FrameAPIModelSceneFrameSharedDocumentation.lua deleted file mode 100644 index 024d90c..0000000 --- a/APIDocumentation/Documentation/FrameAPIModelSceneFrameSharedDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -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/APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua b/APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua deleted file mode 100644 index 4c7a590..0000000 --- a/APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua +++ /dev/null @@ -1,90 +0,0 @@ -local FrameAPISimpleCheckout = -{ - Name = "FrameAPISimpleCheckout", - Type = "ScriptObject", - - Functions = - { - { - Name = "CancelOpenCheckout", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "ClearFocus", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "CloseCheckout", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "CopyExternalLink", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "OpenCheckout", - Type = "Function", - - 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", - - Arguments = - { - { Name = "zoomLevel", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameAPISimpleCheckout); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPITabardModelBaseDocumentation.lua b/APIDocumentation/Documentation/FrameAPITabardModelBaseDocumentation.lua deleted file mode 100644 index 0bd5176..0000000 --- a/APIDocumentation/Documentation/FrameAPITabardModelBaseDocumentation.lua +++ /dev/null @@ -1,76 +0,0 @@ -local FrameAPITabardModelBase = -{ - Name = "FrameAPITabardModelBase", - Type = "ScriptObject", - - Functions = - { - { - Name = "CanSaveTabardNow", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "canSave", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CycleVariation", - Type = "Function", - - Arguments = - { - { Name = "variationIndex", Type = "luaIndex", Nilable = false }, - { Name = "delta", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetLowerEmblemTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - }, - }, - { - Name = "GetUpperEmblemTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - }, - }, - { - Name = "InitializeTabardColors", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "Save", - Type = "Function", - - Arguments = - { - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameAPITabardModelBase); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPITabardModelDocumentation.lua b/APIDocumentation/Documentation/FrameAPITabardModelDocumentation.lua deleted file mode 100644 index 640b9aa..0000000 --- a/APIDocumentation/Documentation/FrameAPITabardModelDocumentation.lua +++ /dev/null @@ -1,71 +0,0 @@ -local FrameAPITabardModel = -{ - Name = "FrameAPITabardModel", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetLowerBackgroundFileName", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "path", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetLowerEmblemFileName", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "path", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetUpperBackgroundFileName", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "path", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetUpperEmblemFileName", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "path", Type = "string", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameAPITabardModel); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPIUnitPositionFrameDocumentation.lua b/APIDocumentation/Documentation/FrameAPIUnitPositionFrameDocumentation.lua deleted file mode 100644 index 1c2386b..0000000 --- a/APIDocumentation/Documentation/FrameAPIUnitPositionFrameDocumentation.lua +++ /dev/null @@ -1,153 +0,0 @@ -local FrameAPIUnitPositionFrame = -{ - Name = "FrameAPIUnitPositionFrame", - Type = "ScriptObject", - - Functions = - { - { - Name = "AddUnit", - Type = "Function", - - 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", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetPlayerPingTexture", - Type = "Function", - - 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", - - Arguments = - { - { Name = "mapID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetUnitColor", - Type = "Function", - - 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", - - 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/APIDocumentation/Documentation/FrameScriptDocumentation.lua b/APIDocumentation/Documentation/FrameScriptDocumentation.lua deleted file mode 100644 index 7334b1b..0000000 --- a/APIDocumentation/Documentation/FrameScriptDocumentation.lua +++ /dev/null @@ -1,33 +0,0 @@ -local FrameScript = -{ - Name = "FrameScript", - Type = "System", - - Functions = - { - { - Name = "CreateWindow", - Type = "Function", - - Arguments = - { - { Name = "popupStyle", Type = "bool", Nilable = false, Default = true }, - }, - - Returns = - { - { Name = "window", Type = "SimpleWindow", Nilable = true }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(FrameScript); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FriendListDocumentation.lua b/APIDocumentation/Documentation/FriendListDocumentation.lua deleted file mode 100644 index c99d82b..0000000 --- a/APIDocumentation/Documentation/FriendListDocumentation.lua +++ /dev/null @@ -1,530 +0,0 @@ -local FriendList = -{ - Name = "FriendList", - Type = "System", - Namespace = "C_FriendList", - - Functions = - { - { - Name = "AddFriend", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "notes", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "AddIgnore", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "added", Type = "bool", Nilable = false }, - }, - }, - { - Name = "AddOrDelIgnore", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "AddOrRemoveFriend", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "notes", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "DelIgnore", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "removed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "DelIgnoreByIndex", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "GetFriendInfo", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "FriendInfo", Nilable = false }, - }, - }, - { - Name = "GetFriendInfoByIndex", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "FriendInfo", Nilable = false }, - }, - }, - { - Name = "GetIgnoreName", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "name", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetNumFriends", - Type = "Function", - - Returns = - { - { Name = "numFriends", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumIgnores", - Type = "Function", - - Returns = - { - { Name = "numIgnores", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumOnlineFriends", - Type = "Function", - - Returns = - { - { Name = "numOnline", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumWhoResults", - Type = "Function", - - Returns = - { - { Name = "numWhos", Type = "number", Nilable = false }, - { Name = "totalNumWhos", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetSelectedFriend", - Type = "Function", - - Returns = - { - { Name = "index", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "GetSelectedIgnore", - Type = "Function", - - Returns = - { - { Name = "index", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "GetWhoInfo", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "WhoInfo", Nilable = false }, - }, - }, - { - Name = "IsFriend", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "isFriend", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsIgnored", - Type = "Function", - - Arguments = - { - { Name = "token", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "isIgnored", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsIgnoredByGuid", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "isIgnored", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsOnIgnoredList", - Type = "Function", - - Arguments = - { - { Name = "token", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "isIgnored", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RemoveFriend", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "removed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RemoveFriendByIndex", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SendWho", - Type = "Function", - - Arguments = - { - { Name = "filter", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetFriendNotes", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "notes", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "found", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFriendNotesByIndex", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - { Name = "notes", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetSelectedFriend", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SetSelectedIgnore", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SetWhoToUi", - Type = "Function", - - Arguments = - { - { Name = "whoToUi", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ShowFriends", - Type = "Function", - }, - { - Name = "SortWho", - Type = "Function", - - Arguments = - { - { Name = "sorting", Type = "cstring", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "BattletagInviteShow", - Type = "Event", - LiteralName = "BATTLETAG_INVITE_SHOW", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "BnBlockFailedTooMany", - Type = "Event", - LiteralName = "BN_BLOCK_FAILED_TOO_MANY", - Payload = - { - { Name = "blockType", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "BnBlockListUpdated", - Type = "Event", - LiteralName = "BN_BLOCK_LIST_UPDATED", - }, - { - Name = "BnChatWhisperUndeliverable", - Type = "Event", - LiteralName = "BN_CHAT_WHISPER_UNDELIVERABLE", - Payload = - { - { Name = "senderID", Type = "number", Nilable = false }, - }, - }, - { - Name = "BnConnected", - Type = "Event", - LiteralName = "BN_CONNECTED", - }, - { - Name = "BnCustomMessageChanged", - Type = "Event", - LiteralName = "BN_CUSTOM_MESSAGE_CHANGED", - Payload = - { - { Name = "id", Type = "number", Nilable = true }, - }, - }, - { - Name = "BnCustomMessageLoaded", - Type = "Event", - LiteralName = "BN_CUSTOM_MESSAGE_LOADED", - }, - { - Name = "BnDisconnected", - Type = "Event", - LiteralName = "BN_DISCONNECTED", - Payload = - { - { Name = "result", Type = "bool", Nilable = false }, - }, - }, - { - Name = "BnFriendAccountOffline", - Type = "Event", - LiteralName = "BN_FRIEND_ACCOUNT_OFFLINE", - Payload = - { - { Name = "friendId", Type = "number", Nilable = false }, - }, - }, - { - Name = "BnFriendAccountOnline", - Type = "Event", - LiteralName = "BN_FRIEND_ACCOUNT_ONLINE", - Payload = - { - { Name = "friendId", Type = "number", Nilable = false }, - }, - }, - { - Name = "BnFriendInfoChanged", - Type = "Event", - LiteralName = "BN_FRIEND_INFO_CHANGED", - Payload = - { - { Name = "friendIndex", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "BnFriendInviteAdded", - Type = "Event", - LiteralName = "BN_FRIEND_INVITE_ADDED", - Payload = - { - { Name = "accountID", Type = "number", Nilable = false }, - }, - }, - { - Name = "BnFriendInviteListInitialized", - Type = "Event", - LiteralName = "BN_FRIEND_INVITE_LIST_INITIALIZED", - Payload = - { - { Name = "listSize", Type = "number", Nilable = false }, - }, - }, - { - Name = "BnFriendInviteRemoved", - Type = "Event", - LiteralName = "BN_FRIEND_INVITE_REMOVED", - }, - { - Name = "BnFriendListSizeChanged", - Type = "Event", - LiteralName = "BN_FRIEND_LIST_SIZE_CHANGED", - Payload = - { - { Name = "accountID", Type = "number", Nilable = true }, - }, - }, - { - Name = "BnInfoChanged", - Type = "Event", - LiteralName = "BN_INFO_CHANGED", - }, - { - Name = "BnRequestFofSucceeded", - Type = "Event", - LiteralName = "BN_REQUEST_FOF_SUCCEEDED", - }, - { - Name = "FriendlistUpdate", - Type = "Event", - LiteralName = "FRIENDLIST_UPDATE", - }, - { - Name = "IgnorelistUpdate", - Type = "Event", - LiteralName = "IGNORELIST_UPDATE", - }, - { - Name = "MutelistUpdate", - Type = "Event", - LiteralName = "MUTELIST_UPDATE", - }, - { - Name = "WhoListUpdate", - Type = "Event", - LiteralName = "WHO_LIST_UPDATE", - }, - }, - - 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 = "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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(FriendList); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua b/APIDocumentation/Documentation/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua deleted file mode 100644 index f1a6fa4..0000000 --- a/APIDocumentation/Documentation/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua +++ /dev/null @@ -1,23 +0,0 @@ -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/APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua b/APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua deleted file mode 100644 index 61bd3ed..0000000 --- a/APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua +++ /dev/null @@ -1,22 +0,0 @@ -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/APIDocumentation/Documentation/GMTicketInfoDocumentation.lua b/APIDocumentation/Documentation/GMTicketInfoDocumentation.lua deleted file mode 100644 index 7ff87fe..0000000 --- a/APIDocumentation/Documentation/GMTicketInfoDocumentation.lua +++ /dev/null @@ -1,78 +0,0 @@ -local GMTicketInfo = -{ - Name = "GMTicketInfo", - Type = "System", - Namespace = "C_GMTicketInfo", - - Functions = - { - }, - - Events = - { - { - Name = "GmPlayerInfo", - Type = "Event", - LiteralName = "GM_PLAYER_INFO", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "info", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ItemRestorationButtonStatus", - Type = "Event", - LiteralName = "ITEM_RESTORATION_BUTTON_STATUS", - }, - { - Name = "PetitionClosed", - Type = "Event", - LiteralName = "PETITION_CLOSED", - }, - { - Name = "PetitionShow", - Type = "Event", - LiteralName = "PETITION_SHOW", - }, - { - Name = "PlayerReportSubmitted", - Type = "Event", - LiteralName = "PLAYER_REPORT_SUBMITTED", - Payload = - { - { Name = "invitedByGUID", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "QuickTicketSystemStatus", - Type = "Event", - LiteralName = "QUICK_TICKET_SYSTEM_STATUS", - }, - { - Name = "QuickTicketThrottleChanged", - Type = "Event", - LiteralName = "QUICK_TICKET_THROTTLE_CHANGED", - }, - { - Name = "UpdateWebTicket", - Type = "Event", - LiteralName = "UPDATE_WEB_TICKET", - 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 }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(GMTicketInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GamePadConstDocumentation.lua b/APIDocumentation/Documentation/GamePadConstDocumentation.lua deleted file mode 100644 index 7fb5d54..0000000 --- a/APIDocumentation/Documentation/GamePadConstDocumentation.lua +++ /dev/null @@ -1,24 +0,0 @@ -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/APIDocumentation/Documentation/GamePadDocumentation.lua b/APIDocumentation/Documentation/GamePadDocumentation.lua deleted file mode 100644 index f9c534c..0000000 --- a/APIDocumentation/Documentation/GamePadDocumentation.lua +++ /dev/null @@ -1,411 +0,0 @@ -local GamePad = -{ - Name = "GamePad", - Type = "System", - Namespace = "C_GamePad", - - Functions = - { - { - Name = "AddSDLMapping", - Type = "Function", - - Arguments = - { - { Name = "platform", Type = "ClientPlatformType", Nilable = false }, - { Name = "mapping", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ApplyConfigs", - Type = "Function", - }, - { - Name = "AxisIndexToConfigName", - Type = "Function", - - Arguments = - { - { Name = "axisIndex", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "configName", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "ButtonBindingToIndex", - Type = "Function", - - Arguments = - { - { Name = "bindingName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "buttonIndex", Type = "number", Nilable = true }, - }, - }, - { - Name = "ButtonIndexToBinding", - Type = "Function", - - Arguments = - { - { Name = "buttonIndex", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "bindingName", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "ButtonIndexToConfigName", - Type = "Function", - - Arguments = - { - { Name = "buttonIndex", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "configName", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "ClearLedColor", - Type = "Function", - }, - { - Name = "DeleteConfig", - Type = "Function", - - 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", - - Arguments = - { - { Name = "configID", Type = "GamePadConfigID", Nilable = false }, - }, - - Returns = - { - { Name = "config", Type = "GamePadConfig", Nilable = true }, - }, - }, - { - Name = "GetDeviceMappedState", - Type = "Function", - - Arguments = - { - { Name = "deviceID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "state", Type = "GamePadMappedState", Nilable = true }, - }, - }, - { - Name = "GetDeviceRawState", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "config", Type = "GamePadConfig", Nilable = false }, - }, - }, - { - Name = "SetLedColor", - Type = "Function", - - Arguments = - { - { Name = "color", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, - }, - }, - { - Name = "SetVibration", - Type = "Function", - - Arguments = - { - { Name = "vibrationType", Type = "cstring", Nilable = false }, - { Name = "intensity", Type = "number", Nilable = false }, - }, - }, - { - Name = "StickIndexToConfigName", - Type = "Function", - - 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", - Payload = - { - { Name = "isActive", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GamePadConfigsChanged", - Type = "Event", - LiteralName = "GAME_PAD_CONFIGS_CHANGED", - }, - { - Name = "GamePadConnected", - Type = "Event", - LiteralName = "GAME_PAD_CONNECTED", - }, - { - Name = "GamePadDisconnected", - Type = "Event", - LiteralName = "GAME_PAD_DISCONNECTED", - }, - { - Name = "GamePadPowerChanged", - Type = "Event", - LiteralName = "GAME_PAD_POWER_CHANGED", - 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/APIDocumentation/Documentation/GameRulesDocumentation.lua b/APIDocumentation/Documentation/GameRulesDocumentation.lua deleted file mode 100644 index ece34c4..0000000 --- a/APIDocumentation/Documentation/GameRulesDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -local GameRules = -{ - Name = "GameRules", - Type = "System", - Namespace = "C_GameRules", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(GameRules); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GarrisonConstantsDocumentation.lua b/APIDocumentation/Documentation/GarrisonConstantsDocumentation.lua deleted file mode 100644 index db8d80f..0000000 --- a/APIDocumentation/Documentation/GarrisonConstantsDocumentation.lua +++ /dev/null @@ -1,365 +0,0 @@ -local GarrisonConstants = -{ - Tables = - { - { - 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/APIDocumentation/Documentation/GlueDocumentation.lua b/APIDocumentation/Documentation/GlueDocumentation.lua deleted file mode 100644 index fd5ca63..0000000 --- a/APIDocumentation/Documentation/GlueDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Glue = -{ - Name = "Glue", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Glue); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GlyphDocumentation.lua b/APIDocumentation/Documentation/GlyphDocumentation.lua new file mode 100644 index 0000000..2329d23 --- /dev/null +++ b/APIDocumentation/Documentation/GlyphDocumentation.lua @@ -0,0 +1,132 @@ +local Glyph = +{ + Name = "Glyph", + Type = "System", + Namespace = "Glyph", + + Functions = + { + { + Name = "GetGlyphLink", + Type = "Function", + + Arguments = + { + { Name = "socket", Type = "number", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetGlyphSocketInfo", + Type = "Function", + + Arguments = + { + { Name = "socket", Type = "number", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + { Name = "glyphType", Type = "number", Nilable = false }, + { Name = "glyphTooltipIndex", Type = "luaIndex", Nilable = false }, + { Name = "glyphSpell", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumGlyphSockets", + Type = "Function", + + }, + { + Name = "GlyphMatchesSocket", + Type = "Function", + + Arguments = + { + { Name = "socket", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "match", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlaceGlyphInSocket", + Type = "Function", + + Arguments = + { + { Name = "socket", Type = "number", Nilable = false }, + }, + + }, + { + Name = "RemoveGlyphFromSocket", + Type = "Function", + + Arguments = + { + { Name = "socket", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SpellCanTargetGlyph", + Type = "Function", + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "GlyphAdded", + Type = "Event", + LiteralName = "GLYPH_ADDED", + }, + { + Name = "GlyphDisabled", + Type = "Event", + LiteralName = "GLYPH_DISABLED", + }, + { + Name = "GlyphEnabled", + Type = "Event", + LiteralName = "GLYPH_ENABLED", + }, + { + Name = "GlyphRemoved", + Type = "Event", + LiteralName = "GLYPH_REMOVED", + }, + { + Name = "GlyphUpdated", + Type = "Event", + LiteralName = "GLYPH_UPDATED", + }, + { + Name = "UseGlyph", + Type = "Event", + LiteralName = "USE_GLYPH", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Glyph); diff --git a/APIDocumentation/Documentation/GlyphInfoDocumentation.lua b/APIDocumentation/Documentation/GlyphInfoDocumentation.lua deleted file mode 100644 index 4b1c202..0000000 --- a/APIDocumentation/Documentation/GlyphInfoDocumentation.lua +++ /dev/null @@ -1,70 +0,0 @@ -local GlyphInfo = -{ - Name = "GlyphInfo", - Type = "System", - Namespace = "C_GlyphInfo", - - Functions = - { - }, - - Events = - { - { - Name = "ActivateGlyph", - Type = "Event", - LiteralName = "ACTIVATE_GLYPH", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "CancelGlyphCast", - Type = "Event", - LiteralName = "CANCEL_GLYPH_CAST", - }, - { - Name = "GlyphAdded", - Type = "Event", - LiteralName = "GLYPH_ADDED", - Payload = - { - { Name = "glyphSlot", Type = "number", Nilable = false }, - }, - }, - { - Name = "GlyphRemoved", - Type = "Event", - LiteralName = "GLYPH_REMOVED", - Payload = - { - { Name = "glyphSlot", Type = "number", Nilable = false }, - }, - }, - { - Name = "GlyphUpdated", - Type = "Event", - LiteralName = "GLYPH_UPDATED", - Payload = - { - { Name = "glyphSlot", Type = "number", Nilable = false }, - }, - }, - { - Name = "UseGlyph", - Type = "Event", - LiteralName = "USE_GLYPH", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(GlyphInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GmSurveyDocumentation.lua b/APIDocumentation/Documentation/GmSurveyDocumentation.lua new file mode 100644 index 0000000..68e4f09 --- /dev/null +++ b/APIDocumentation/Documentation/GmSurveyDocumentation.lua @@ -0,0 +1,95 @@ +local GmSurvey = +{ + Name = "GM Survey", + Type = "System", + Namespace = "GM Survey", + + Functions = + { + { + Name = "GMSurveyAnswer", + Type = "Function", + + Arguments = + { + { Name = "questionIndex", Type = "luaIndex", Nilable = false }, + { Name = "answerIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "answerText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GMSurveyAnswerSubmit", + Type = "Function", + + Arguments = + { + { Name = "question", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "comment", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GMSurveyCommentSubmit", + Type = "Function", + + Arguments = + { + { Name = "comment", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GMSurveyNumAnswers", + Type = "Function", + + Arguments = + { + { Name = "questionIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numAnswers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GMSurveyQuestion", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "surveyQuestion", Type = "string", Nilable = false }, + }, + }, + { + Name = "GMSurveySubmit", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "GmsurveyDisplay", + Type = "Event", + LiteralName = "GMSURVEY_DISPLAY", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GmSurvey); diff --git a/APIDocumentation/Documentation/GmTicketDocumentation.lua b/APIDocumentation/Documentation/GmTicketDocumentation.lua new file mode 100644 index 0000000..40e92ee --- /dev/null +++ b/APIDocumentation/Documentation/GmTicketDocumentation.lua @@ -0,0 +1,80 @@ +local GmTicket = +{ + Name = "GM Ticket", + Type = "System", + Namespace = "GM Ticket", + + Functions = + { + { + Name = "DeleteGMTicket", + Type = "Function", + + }, + { + Name = "GMResponseNeedMoreHelp", + Type = "Function", + + }, + { + Name = "GMResponseResolve", + Type = "Function", + + }, + { + Name = "GetGMStatus", + Type = "Function", + + }, + { + Name = "GetGMTicket", + Type = "Function", + + }, + { + Name = "GetGMTicketCategories", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "NewGMTicket", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "needResponse", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "Stuck", + Type = "Function", + + }, + { + Name = "UpdateGMTicket", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GmTicket); diff --git a/APIDocumentation/Documentation/GossipConstantsDocumentation.lua b/APIDocumentation/Documentation/GossipConstantsDocumentation.lua deleted file mode 100644 index 789dfee..0000000 --- a/APIDocumentation/Documentation/GossipConstantsDocumentation.lua +++ /dev/null @@ -1,95 +0,0 @@ -local GossipConstants = -{ - Tables = - { - { - Name = "GossipNpcOption", - Type = "Enumeration", - NumValues = 54, - MinValue = 0, - MaxValue = 53, - 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 = "TabardVendor", 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 = "PetUntrainer", 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 = "GossipNpcOptionDisplayFlags", - Type = "Enumeration", - NumValues = 1, - MinValue = 1, - MaxValue = 1, - Fields = - { - { Name = "ForceInteractionOnSingleChoice", Type = "GossipNpcOptionDisplayFlags", EnumValue = 1 }, - }, - }, - { - Name = "GossipOptionRecFlags", - Type = "Enumeration", - NumValues = 2, - MinValue = 1, - MaxValue = 2, - Fields = - { - { Name = "QuestLabelPrepend", Type = "GossipOptionRecFlags", EnumValue = 1 }, - { Name = "HideOptionIDFromClient", Type = "GossipOptionRecFlags", EnumValue = 2 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(GossipConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GossipInfoDocumentation.lua b/APIDocumentation/Documentation/GossipInfoDocumentation.lua deleted file mode 100644 index 5ffd07b..0000000 --- a/APIDocumentation/Documentation/GossipInfoDocumentation.lua +++ /dev/null @@ -1,328 +0,0 @@ -local GossipInfo = -{ - Name = "GossipInfo", - Type = "System", - Namespace = "C_GossipInfo", - - Functions = - { - { - Name = "CloseGossip", - Type = "Function", - }, - { - Name = "ForceGossip", - Type = "Function", - - Returns = - { - { Name = "forceGossip", Type = "bool", 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", - - Arguments = - { - { Name = "friendshipFactionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "reputationInfo", Type = "FriendshipReputationInfo", Nilable = false }, - }, - }, - { - Name = "GetFriendshipReputationRanks", - Type = "Function", - - Arguments = - { - { Name = "friendshipFactionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "rankInfo", Type = "FriendshipReputationRankInfo", 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 = "GetOptions", - Type = "Function", - - Returns = - { - { Name = "info", Type = "table", InnerType = "GossipOptionUIInfo", Nilable = false }, - }, - }, - { - Name = "GetPoiForUiMapID", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "gossipPoiID", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetPoiInfo", - Type = "Function", - - 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 = "SelectActiveQuest", - Type = "Function", - - Arguments = - { - { Name = "optionID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SelectAvailableQuest", - Type = "Function", - - Arguments = - { - { Name = "optionID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SelectOption", - Type = "Function", - - Arguments = - { - { Name = "optionID", Type = "number", Nilable = false }, - { Name = "text", Type = "cstring", Nilable = true }, - { Name = "confirmed", Type = "bool", Nilable = true }, - }, - }, - { - Name = "SelectOptionByIndex", - Type = "Function", - - 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", - }, - { - Name = "GossipClosed", - Type = "Event", - LiteralName = "GOSSIP_CLOSED", - }, - { - Name = "GossipConfirm", - Type = "Event", - LiteralName = "GOSSIP_CONFIRM", - Payload = - { - { Name = "gossipID", Type = "number", Nilable = false }, - { Name = "text", Type = "string", Nilable = false }, - { Name = "cost", Type = "number", Nilable = false }, - }, - }, - { - Name = "GossipConfirmCancel", - Type = "Event", - LiteralName = "GOSSIP_CONFIRM_CANCEL", - }, - { - Name = "GossipEnterCode", - Type = "Event", - LiteralName = "GOSSIP_ENTER_CODE", - Payload = - { - { Name = "gossipID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GossipShow", - Type = "Event", - LiteralName = "GOSSIP_SHOW", - Payload = - { - { Name = "uiTextureKit", Type = "textureKit", Nilable = true }, - }, - }, - }, - - Tables = - { - { - 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 = "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 = "FriendshipReputationRankInfo", - Type = "Structure", - Fields = - { - { Name = "currentLevel", Type = "number", Nilable = false }, - { Name = "maxLevel", Type = "number", 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 = "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 = "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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(GossipInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GuildBankDocumentation.lua b/APIDocumentation/Documentation/GuildBankDocumentation.lua index 8419449..fbd2e4b 100644 --- a/APIDocumentation/Documentation/GuildBankDocumentation.lua +++ b/APIDocumentation/Documentation/GuildBankDocumentation.lua @@ -1,53 +1,386 @@ local GuildBank = { - Name = "GuildBank", + Name = "Guild Bank", Type = "System", - Namespace = "C_GuildBank", + Namespace = "Guild Bank", Functions = { + { + Name = "AutoStoreGuildBankItem", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "BuyGuildBankTab", + Type = "Function", + + }, + { + Name = "CanEditGuildTabInfo", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanGuildBankRepair", + Type = "Function", + + Returns = + { + { Name = "canRepair", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanWithdrawGuildBankMoney", + Type = "Function", + + Returns = + { + { Name = "canWithdraw", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseGuildBankFrame", + Type = "Function", + + }, + { + Name = "DepositGuildBankMoney", + Type = "Function", + + Arguments = + { + { Name = "money", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetCurrentGuildBankTab", + Type = "Function", + + Arguments = + { + { Name = "currentTab", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetGuildBankItemInfo", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetGuildBankItemLink", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "item", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetGuildBankMoney", + Type = "Function", + + Returns = + { + { Name = "guildBankMoney", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildBankMoneyTransaction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { 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 = "GetGuildBankTabCost", + Type = "Function", + + Returns = + { + { Name = "tabCost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildBankTabInfo", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "isViewable", Type = "bool", Nilable = false }, + { Name = "canDeposit", Type = "bool", Nilable = false }, + { Name = "numWithdrawals", Type = "number", Nilable = false }, + { Name = "remainingWithdrawals", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildBankTabPermissions", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canView", Type = "bool", Nilable = false }, + { Name = "canDeposit", Type = "bool", Nilable = false }, + { Name = "canUpdateText", Type = "bool", Nilable = false }, + { Name = "numWithdrawls", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildBankText", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetGuildBankTransaction", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "itemLink", Type = "hyperlink", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "tab1", Type = "number", Nilable = false }, + { Name = "tab2", Type = "number", Nilable = false }, + { 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 = "GetGuildBankWithdrawLimit", + Type = "Function", + + Returns = + { + { Name = "goldWithdrawLimit", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildBankWithdrawMoney", + Type = "Function", + + Returns = + { + { Name = "withdrawLimit", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGuildBankMoneyTransactions", + Type = "Function", + + Returns = + { + { Name = "numTransactions", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGuildBankTabs", + Type = "Function", + + Returns = + { + { Name = "numTabs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGuildBankTransactions", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numTransactions", Type = "number", Nilable = false }, + }, + }, + { + Name = "PickupGuildBankItem", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupGuildBankMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "QueryGuildBankLog", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + }, + { + Name = "QueryGuildBankTab", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + }, + { + Name = "QueryGuildBankText", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetCurrentGuildBankTab", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetGuildBankTabPermissions", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "permission", Type = "number", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetGuildBankText", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SplitGuildBankItem", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "WithdrawGuildBankMoney", + Type = "Function", + + Returns = + { + { Name = "canWithdraw", Type = "bool", Nilable = false }, + }, + }, }, Events = { - { - Name = "GuildbankItemLockChanged", - Type = "Event", - LiteralName = "GUILDBANK_ITEM_LOCK_CHANGED", - }, - { - Name = "GuildbankTextChanged", - Type = "Event", - LiteralName = "GUILDBANK_TEXT_CHANGED", - Payload = - { - { Name = "guildBankTab", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "GuildbankUpdateMoney", - Type = "Event", - LiteralName = "GUILDBANK_UPDATE_MONEY", - }, - { - Name = "GuildbankUpdateTabs", - Type = "Event", - LiteralName = "GUILDBANK_UPDATE_TABS", - }, - { - Name = "GuildbankUpdateText", - Type = "Event", - LiteralName = "GUILDBANK_UPDATE_TEXT", - Payload = - { - { Name = "guildBankTab", Type = "number", Nilable = false }, - }, - }, - { - Name = "GuildbankUpdateWithdrawmoney", - Type = "Event", - LiteralName = "GUILDBANK_UPDATE_WITHDRAWMONEY", - }, { Name = "GuildbankbagslotsChanged", Type = "Event", @@ -68,6 +401,36 @@ local GuildBank = Type = "Event", LiteralName = "GUILDBANKLOG_UPDATE", }, + { + Name = "GuildbankItemLockChanged", + Type = "Event", + LiteralName = "GUILDBANK_ITEM_LOCK_CHANGED", + }, + { + Name = "GuildbankTextChanged", + Type = "Event", + LiteralName = "GUILDBANK_TEXT_CHANGED", + }, + { + Name = "GuildbankUpdateMoney", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_MONEY", + }, + { + Name = "GuildbankUpdateTabs", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_TABS", + }, + { + Name = "GuildbankUpdateText", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_TEXT", + }, + { + Name = "GuildbankUpdateWithdrawmoney", + Type = "Event", + LiteralName = "GUILDBANK_UPDATE_WITHDRAWMONEY", + }, }, Tables = @@ -75,4 +438,4 @@ local GuildBank = }, }; -APIDocumentation:AddDocumentationTable(GuildBank); \ No newline at end of file +APIDocumentation:AddDocumentationTable(GuildBank); diff --git a/APIDocumentation/Documentation/GuildDocumentation.lua b/APIDocumentation/Documentation/GuildDocumentation.lua new file mode 100644 index 0000000..646edf0 --- /dev/null +++ b/APIDocumentation/Documentation/GuildDocumentation.lua @@ -0,0 +1,670 @@ +local Guild = +{ + Name = "Guild", + Type = "System", + Namespace = "Guild", + + Functions = + { + { + Name = "AcceptGuild", + Type = "Function", + + }, + { + Name = "BuyGuildCharter", + Type = "Function", + + Arguments = + { + { Name = "guildName", Type = "string", Nilable = false }, + }, + + }, + { + Name = "CanEditGuildEvent", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanEditGuildInfo", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanEditMOTD", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanEditOfficerNote", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanEditPublicNote", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanGuildDemote", + Type = "Function", + + Returns = + { + { Name = "canDemote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanGuildInvite", + Type = "Function", + + Returns = + { + { Name = "canInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanGuildPromote", + Type = "Function", + + Returns = + { + { Name = "canPromote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanGuildRemove", + Type = "Function", + + Returns = + { + { Name = "canRemove", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanViewOfficerNote", + Type = "Function", + + Returns = + { + { Name = "canView", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseGuildRegistrar", + Type = "Function", + + }, + { + Name = "CloseGuildRoster", + Type = "Function", + + }, + { + Name = "CloseTabardCreation", + Type = "Function", + + }, + { + Name = "DeclineGuild", + Type = "Function", + + }, + { + Name = "GetGuildCharterCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildEventInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "player1", Type = "string", Nilable = false }, + { Name = "player2", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { 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 = "GetGuildInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "guildName", Type = "string", Nilable = false }, + { Name = "guildRankName", Type = "string", Nilable = false }, + { Name = "guildRankIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetGuildInfoText", + Type = "Function", + + Returns = + { + { Name = "guildInfoText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetGuildRosterInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "rankIndex", Type = "luaIndex", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "zone", Type = "string", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + { Name = "officernote", Type = "string", Nilable = false }, + { Name = "online", Type = "bool", Nilable = false }, + { Name = "status", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetGuildRosterLastOnline", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "years", Type = "number", Nilable = false }, + { Name = "months", Type = "number", Nilable = false }, + { Name = "days", Type = "number", Nilable = false }, + { Name = "hours", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGuildRosterMOTD", + Type = "Function", + + Returns = + { + { Name = "guildMOTD", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetGuildRosterSelection", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetGuildRosterShowOffline", + Type = "Function", + + Returns = + { + { Name = "showOffline", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetGuildTabardFileNames", + Type = "Function", + + Returns = + { + { Name = "tabardBackgroundUpper", Type = "string", Nilable = false }, + { Name = "tabardBackgroundLower", Type = "string", Nilable = false }, + { Name = "tabardEmblemUpper", Type = "string", Nilable = false }, + { Name = "tabardEmblemLower", Type = "string", Nilable = false }, + { Name = "tabardBorderUpper", Type = "string", Nilable = false }, + { Name = "tabardBorderLower", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumGuildEvents", + Type = "Function", + + Returns = + { + { Name = "numEvents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGuildMembers", + Type = "Function", + + Arguments = + { + { Name = "includeOffline", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "numGuildMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTabardCreationCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTabardInfo", + Type = "Function", + + }, + { + Name = "GuildControlAddRank", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildControlDelRank", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildControlGetNumRanks", + Type = "Function", + + Returns = + { + { Name = "numRanks", Type = "number", Nilable = false }, + }, + }, + { + Name = "GuildControlGetRankFlags", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GuildControlGetRankName", + Type = "Function", + + Arguments = + { + { Name = "rank", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "rankName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GuildControlSaveRank", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildControlSetRank", + Type = "Function", + + Arguments = + { + { Name = "rank", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GuildControlSetRankFlag", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "GuildDemote", + Type = "Function", + + Returns = + { + { Name = "canDemote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildDisband", + Type = "Function", + + }, + { + Name = "GuildInfo", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildInvite", + Type = "Function", + + Returns = + { + { Name = "canInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildLeave", + Type = "Function", + + }, + { + Name = "GuildPromote", + Type = "Function", + + Returns = + { + { Name = "canPromote", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GuildRoster", + Type = "Function", + + }, + { + Name = "GuildRosterSetOfficerNote", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildRosterSetPublicNote", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildSetLeader", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildSetMOTD", + Type = "Function", + + Arguments = + { + { Name = "message", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GuildUninvite", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "IsGuildLeader", + Type = "Function", + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInGuild", + Type = "Function", + + Returns = + { + { Name = "inGuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QueryGuildEventLog", + Type = "Function", + + }, + { + Name = "SetGuildInfoText", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetGuildRosterSelection", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetGuildRosterShowOffline", + Type = "Function", + + Arguments = + { + { Name = "showOffline", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SortGuildRoster", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + }, + + }, + { + Name = "TurnInGuildCharter", + Type = "Function", + + }, + { + Name = "UnitIsInMyGuild", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inGuild", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ChatMsgGuild", + Type = "Event", + LiteralName = "CHAT_MSG_GUILD", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "GuildtabardUpdate", + Type = "Event", + LiteralName = "GUILDTABARD_UPDATE", + }, + { + Name = "GuildEventLogUpdate", + Type = "Event", + LiteralName = "GUILD_EVENT_LOG_UPDATE", + }, + { + Name = "GuildInviteCancel", + Type = "Event", + LiteralName = "GUILD_INVITE_CANCEL", + }, + { + Name = "GuildInviteRequest", + Type = "Event", + LiteralName = "GUILD_INVITE_REQUEST", + Payload = + { + { Name = "from", Type = "string", Nilable = false }, + { Name = "guildname", Type = "string", Nilable = false }, + }, + }, + { + Name = "GuildMotd", + Type = "Event", + LiteralName = "GUILD_MOTD", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "GuildRegistrarClosed", + Type = "Event", + LiteralName = "GUILD_REGISTRAR_CLOSED", + }, + { + Name = "GuildRegistrarShow", + Type = "Event", + LiteralName = "GUILD_REGISTRAR_SHOW", + }, + { + Name = "GuildRosterUpdate", + Type = "Event", + LiteralName = "GUILD_ROSTER_UPDATE", + Payload = + { + { Name = "update", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayerGuildUpdate", + Type = "Event", + LiteralName = "PLAYER_GUILD_UPDATE", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Guild); diff --git a/APIDocumentation/Documentation/GuildInfoDocumentation.lua b/APIDocumentation/Documentation/GuildInfoDocumentation.lua deleted file mode 100644 index 17a05a3..0000000 --- a/APIDocumentation/Documentation/GuildInfoDocumentation.lua +++ /dev/null @@ -1,314 +0,0 @@ -local GuildInfo = -{ - Name = "GuildInfo", - Type = "System", - Namespace = "C_GuildInfo", - - Functions = - { - { - 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 = "GetGuildRankOrder", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "rankOrder", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "GetGuildTabardInfo", - Type = "Function", - - Arguments = - { - { Name = "unit", Type = "UnitToken", Nilable = true }, - }, - - Returns = - { - { Name = "tabardInfo", Type = "GuildTabardInfo", Nilable = true }, - }, - }, - { - Name = "GuildControlGetRankFlags", - Type = "Function", - - Arguments = - { - { Name = "rankOrder", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "permissions", Type = "table", InnerType = "bool", Nilable = false }, - }, - }, - { - Name = "GuildRoster", - Type = "Function", - }, - { - Name = "IsGuildOfficer", - Type = "Function", - - Returns = - { - { Name = "isOfficer", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsGuildRankAssignmentAllowed", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "rankOrder", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isGuildRankAssignmentAllowed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "MemberExistsByName", - Type = "Function", - - Arguments = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "exists", Type = "bool", Nilable = false }, - }, - }, - { - Name = "QueryGuildMembersForRecipe", - Type = "Function", - - 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", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "SetGuildRankOrder", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "rankOrder", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SetNote", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "note", Type = "cstring", Nilable = false }, - { Name = "isPublic", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "CloseTabardFrame", - Type = "Event", - LiteralName = "CLOSE_TABARD_FRAME", - }, - { - Name = "DisableDeclineGuildInvite", - Type = "Event", - LiteralName = "DISABLE_DECLINE_GUILD_INVITE", - }, - { - Name = "EnableDeclineGuildInvite", - Type = "Event", - LiteralName = "ENABLE_DECLINE_GUILD_INVITE", - }, - { - Name = "GuildEventLogUpdate", - Type = "Event", - LiteralName = "GUILD_EVENT_LOG_UPDATE", - }, - { - Name = "GuildInviteCancel", - Type = "Event", - LiteralName = "GUILD_INVITE_CANCEL", - }, - { - Name = "GuildInviteRequest", - Type = "Event", - LiteralName = "GUILD_INVITE_REQUEST", - 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 = "bkgColorR", Type = "number", Nilable = true }, - { Name = "bkgColorG", Type = "number", Nilable = true }, - { Name = "bkgColorB", Type = "number", Nilable = true }, - { Name = "borderColorR", Type = "number", Nilable = true }, - { Name = "borderColorG", Type = "number", Nilable = true }, - { Name = "borderColorB", Type = "number", Nilable = true }, - { Name = "emblemColorR", Type = "number", Nilable = true }, - { Name = "emblemColorG", Type = "number", Nilable = true }, - { Name = "emblemColorB", Type = "number", Nilable = true }, - { Name = "emblemFilename", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "GuildMotd", - Type = "Event", - LiteralName = "GUILD_MOTD", - Payload = - { - { Name = "motdText", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GuildPartyStateUpdated", - Type = "Event", - LiteralName = "GUILD_PARTY_STATE_UPDATED", - Payload = - { - { Name = "inGuildParty", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GuildRanksUpdate", - Type = "Event", - LiteralName = "GUILD_RANKS_UPDATE", - }, - { - Name = "GuildRegistrarClosed", - Type = "Event", - LiteralName = "GUILD_REGISTRAR_CLOSED", - }, - { - Name = "GuildRegistrarShow", - Type = "Event", - LiteralName = "GUILD_REGISTRAR_SHOW", - }, - { - Name = "GuildRenameRequired", - Type = "Event", - LiteralName = "GUILD_RENAME_REQUIRED", - Payload = - { - { Name = "flagSet", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GuildRosterUpdate", - Type = "Event", - LiteralName = "GUILD_ROSTER_UPDATE", - Payload = - { - { Name = "canRequestRosterUpdate", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GuildtabardUpdate", - Type = "Event", - LiteralName = "GUILDTABARD_UPDATE", - }, - { - Name = "OpenTabardFrame", - Type = "Event", - LiteralName = "OPEN_TABARD_FRAME", - }, - { - Name = "PlayerGuildUpdate", - Type = "Event", - LiteralName = "PLAYER_GUILD_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "RequiredGuildRenameResult", - Type = "Event", - LiteralName = "REQUIRED_GUILD_RENAME_RESULT", - Payload = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "TabardCansaveChanged", - Type = "Event", - LiteralName = "TABARD_CANSAVE_CHANGED", - }, - { - Name = "TabardSavePending", - Type = "Event", - LiteralName = "TABARD_SAVE_PENDING", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(GuildInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GuildInfoSharedDocumentation.lua b/APIDocumentation/Documentation/GuildInfoSharedDocumentation.lua deleted file mode 100644 index 1dac70c..0000000 --- a/APIDocumentation/Documentation/GuildInfoSharedDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -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 = "emblemFilename", Type = "cstring", Nilable = false }, - { Name = "emblemStyle", Type = "number", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(GuildInfoShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/HeirloomInfoDocumentation.lua b/APIDocumentation/Documentation/HeirloomInfoDocumentation.lua deleted file mode 100644 index fd22f36..0000000 --- a/APIDocumentation/Documentation/HeirloomInfoDocumentation.lua +++ /dev/null @@ -1,40 +0,0 @@ -local HeirloomInfo = -{ - Name = "HeirloomInfo", - Type = "System", - Namespace = "C_HeirloomInfo", - - Functions = - { - }, - - Events = - { - { - Name = "HeirloomUpgradeTargetingChanged", - Type = "Event", - LiteralName = "HEIRLOOM_UPGRADE_TARGETING_CHANGED", - Payload = - { - { Name = "pendingHeirloomUpgradeSpellcast", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HeirloomsUpdated", - Type = "Event", - LiteralName = "HEIRLOOMS_UPDATED", - 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/APIDocumentation/Documentation/HyperlinkDocumentation.lua b/APIDocumentation/Documentation/HyperlinkDocumentation.lua new file mode 100644 index 0000000..6fd1ebb --- /dev/null +++ b/APIDocumentation/Documentation/HyperlinkDocumentation.lua @@ -0,0 +1,461 @@ +local Hyperlink = +{ + Name = "Hyperlink", + Type = "System", + Namespace = "Hyperlink", + + Functions = + { + { + Name = "GetAchievementLink", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAuctionItemLink", + Type = "Function", + + Arguments = + { + { Name = "list", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetBuybackItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetContainerItemLink", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetCursorInfo", + Type = "Function", + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "data", Type = "number", Nilable = false }, + { Name = "subType", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetExistingSocketLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetGlyphLink", + Type = "Function", + + Arguments = + { + { Name = "socket", Type = "number", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetGuildBankItemLink", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "item", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetGuildBankTransaction", + Type = "Function", + + Arguments = + { + { Name = "tab", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "itemLink", Type = "hyperlink", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "tab1", Type = "number", Nilable = false }, + { Name = "tab2", Type = "number", Nilable = false }, + { 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 = "GetInboxItemLink", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + { Name = "attachmentIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "itemlink", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemLink", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetItemGem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetLootRollItemLink", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetLootSlotLink", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMacroItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetMerchantItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetNewSocketLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetQuestItemLink", + Type = "Function", + + Arguments = + { + { Name = "itemType", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestLink", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetQuestLogItemLink", + Type = "Function", + + Arguments = + { + { Name = "itemType", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetSendMailItemLink", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemlink", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetSpellLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "id", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + { Name = "tradeLink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTalentLink", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "talentIndex", Type = "luaIndex", Nilable = false }, + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradePlayerItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillListLink", + Type = "Function", + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillReagentItemLink", + Type = "Function", + + Arguments = + { + { Name = "skillIndex", Type = "luaIndex", Nilable = false }, + { Name = "reagentIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillRecipeLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeTargetItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Hyperlink); diff --git a/APIDocumentation/Documentation/InGameMoviePlaybackDocumentation.lua b/APIDocumentation/Documentation/InGameMoviePlaybackDocumentation.lua new file mode 100644 index 0000000..3cc9950 --- /dev/null +++ b/APIDocumentation/Documentation/InGameMoviePlaybackDocumentation.lua @@ -0,0 +1,82 @@ +local InGameMoviePlayback = +{ + Name = "Ingame Movie Playback", + Type = "System", + Namespace = "Ingame Movie Playback", + + Functions = + { + { + Name = "GameMovieFinished", + Type = "Function", + + }, + { + Name = "GetMovieResolution", + Type = "Function", + + Returns = + { + { Name = "resolution", Type = "number", Nilable = false }, + }, + }, + { + Name = "InCinematic", + Type = "Function", + + Returns = + { + { Name = "inCinematic", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpeningCinematic", + Type = "Function", + + }, + { + Name = "StopCinematic", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "CinematicStart", + Type = "Event", + LiteralName = "CINEMATIC_START", + }, + { + Name = "CinematicStop", + Type = "Event", + LiteralName = "CINEMATIC_STOP", + }, + { + Name = "MovieCompressingProgress", + Type = "Event", + LiteralName = "MOVIE_COMPRESSING_PROGRESS", + }, + { + Name = "MovieRecordingProgress", + Type = "Event", + LiteralName = "MOVIE_RECORDING_PROGRESS", + }, + { + Name = "MovieUncompressedMovie", + Type = "Event", + LiteralName = "MOVIE_UNCOMPRESSED_MOVIE", + Payload = + { + { Name = "filename", Type = "string", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(InGameMoviePlayback); diff --git a/APIDocumentation/Documentation/InputConstantsDocumentation.lua b/APIDocumentation/Documentation/InputConstantsDocumentation.lua deleted file mode 100644 index f0d36b2..0000000 --- a/APIDocumentation/Documentation/InputConstantsDocumentation.lua +++ /dev/null @@ -1,22 +0,0 @@ -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/APIDocumentation/Documentation/InputDocumentation.lua b/APIDocumentation/Documentation/InputDocumentation.lua deleted file mode 100644 index 2a073d8..0000000 --- a/APIDocumentation/Documentation/InputDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Input = -{ - Name = "Input", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Input); \ No newline at end of file diff --git a/APIDocumentation/Documentation/InspectDocumentation.lua b/APIDocumentation/Documentation/InspectDocumentation.lua new file mode 100644 index 0000000..e735c04 --- /dev/null +++ b/APIDocumentation/Documentation/InspectDocumentation.lua @@ -0,0 +1,119 @@ +local Inspect = +{ + Name = "Inspect", + Type = "System", + Namespace = "Inspect", + + Functions = + { + { + Name = "CanInspect", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "showError", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "canInspect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClearInspectPlayer", + Type = "Function", + + }, + { + Name = "GetInspectArenaTeamData", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "teamName", Type = "string", Nilable = false }, + { Name = "teamSize", Type = "number", Nilable = false }, + { Name = "teamRating", Type = "number", Nilable = false }, + { Name = "teamPlayed", Type = "number", Nilable = false }, + { Name = "teamWins", Type = "number", Nilable = false }, + { Name = "playerPlayed", Type = "number", Nilable = false }, + { Name = "playerRating", Type = "number", Nilable = false }, + { Name = "bg_red", Type = "number", Nilable = false }, + { Name = "bg_green", Type = "number", Nilable = false }, + { Name = "bg_blue", Type = "number", Nilable = false }, + { Name = "emblem", Type = "number", Nilable = false }, + { Name = "emblem_red", Type = "number", Nilable = false }, + { Name = "emblem_green", Type = "number", Nilable = false }, + { Name = "emblem_blue", Type = "number", Nilable = false }, + { Name = "border", Type = "number", Nilable = false }, + { Name = "border_red", Type = "number", Nilable = false }, + { Name = "border_green", Type = "number", Nilable = false }, + { Name = "border_blue", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInspectHonorData", + Type = "Function", + + Returns = + { + { Name = "todayHK", Type = "number", Nilable = false }, + { Name = "todayHonor", Type = "number", Nilable = false }, + { Name = "yesterdayHK", Type = "number", Nilable = false }, + { Name = "yesterdayHonor", Type = "number", Nilable = false }, + { Name = "lifetimeHK", Type = "number", Nilable = false }, + { Name = "lifetimeRank", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasInspectHonorData", + Type = "Function", + + Returns = + { + { Name = "hasData", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NotifyInspect", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + }, + { + Name = "RequestInspectHonorData", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "InspectHonorUpdate", + Type = "Event", + LiteralName = "INSPECT_HONOR_UPDATE", + }, + { + Name = "InspectTalentReady", + Type = "Event", + LiteralName = "INSPECT_TALENT_READY", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Inspect); diff --git a/APIDocumentation/Documentation/InstanceDocumentation.lua b/APIDocumentation/Documentation/InstanceDocumentation.lua new file mode 100644 index 0000000..6546342 --- /dev/null +++ b/APIDocumentation/Documentation/InstanceDocumentation.lua @@ -0,0 +1,244 @@ +local Instance = +{ + Name = "Instance", + Type = "System", + Namespace = "Instance", + + Functions = + { + { + Name = "CanShowResetInstances", + Type = "Function", + + Returns = + { + { Name = "canResetInstances", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetDungeonDifficulty", + Type = "Function", + + Returns = + { + { Name = "difficulty", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceBootTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "timeleft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceDifficulty", + Type = "Function", + + Returns = + { + { Name = "difficulty", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInstanceInfo", + Type = "Function", + + }, + { + Name = "GetInstanceLockTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumSavedInstances", + Type = "Function", + + Returns = + { + { Name = "savedInstances", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumWorldStateUI", + Type = "Function", + + Returns = + { + { Name = "numUI", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSavedInstanceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "instanceName", Type = "string", Nilable = false }, + { Name = "instanceID", Type = "number", Nilable = false }, + { Name = "instanceReset", Type = "number", Nilable = false }, + { Name = "instanceDifficulty", Type = "number", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + { Name = "extended", Type = "bool", Nilable = false }, + { Name = "instanceIDMostSig", Type = "number", Nilable = false }, + { Name = "isRaid", Type = "bool", Nilable = false }, + { Name = "maxPlayers", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetWorldStateUIInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "uiType", Type = "number", Nilable = false }, + { Name = "state", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "dynamicIcon", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "dynamicTooltip", Type = "string", Nilable = false }, + { Name = "extendedUI", Type = "string", Nilable = false }, + { Name = "extendedUIState1", Type = "number", Nilable = false }, + { Name = "extendedUIState2", Type = "number", Nilable = false }, + { Name = "extendedUIState3", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsInInstance", + Type = "Function", + + Returns = + { + { Name = "isInstance", Type = "bool", Nilable = false }, + { Name = "instanceType", Type = "string", Nilable = false }, + }, + }, + { + Name = "LFGTeleport", + Type = "Function", + + Arguments = + { + { Name = "portOut", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "RequestRaidInfo", + Type = "Function", + + }, + { + Name = "ResetInstances", + Type = "Function", + + Returns = + { + { Name = "canResetInstances", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RespondInstanceLock", + Type = "Function", + + Arguments = + { + { Name = "response", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetDungeonDifficulty", + Type = "Function", + + Arguments = + { + { Name = "difficulty", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetRaidDifficulty", + Type = "Function", + + Arguments = + { + { Name = "difficulty", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "CorpseInInstance", + Type = "Event", + LiteralName = "CORPSE_IN_INSTANCE", + }, + { + Name = "InstanceBootStart", + Type = "Event", + LiteralName = "INSTANCE_BOOT_START", + }, + { + Name = "InstanceBootStop", + Type = "Event", + LiteralName = "INSTANCE_BOOT_STOP", + }, + { + Name = "InstanceEncounterEngageUnit", + Type = "Event", + LiteralName = "INSTANCE_ENCOUNTER_ENGAGE_UNIT", + }, + { + Name = "InstanceLockStart", + Type = "Event", + LiteralName = "INSTANCE_LOCK_START", + }, + { + Name = "InstanceLockStop", + Type = "Event", + LiteralName = "INSTANCE_LOCK_STOP", + }, + { + Name = "RaidInstanceWelcome", + Type = "Event", + LiteralName = "RAID_INSTANCE_WELCOME", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "ttl", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateInstanceInfo", + Type = "Event", + LiteralName = "UPDATE_INSTANCE_INFO", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Instance); diff --git a/APIDocumentation/Documentation/InstanceEncounterDocumentation.lua b/APIDocumentation/Documentation/InstanceEncounterDocumentation.lua deleted file mode 100644 index a21cea1..0000000 --- a/APIDocumentation/Documentation/InstanceEncounterDocumentation.lua +++ /dev/null @@ -1,63 +0,0 @@ -local InstanceEncounter = -{ - Name = "InstanceEncounter", - Type = "System", - Namespace = "C_InstanceEncounter", - - Functions = - { - }, - - Events = - { - { - Name = "InstanceEncounterAddTimer", - Type = "Event", - LiteralName = "INSTANCE_ENCOUNTER_ADD_TIMER", - Payload = - { - { Name = "timeRemaining", Type = "number", Nilable = false }, - }, - }, - { - Name = "InstanceEncounterEngageUnit", - Type = "Event", - LiteralName = "INSTANCE_ENCOUNTER_ENGAGE_UNIT", - }, - { - Name = "InstanceEncounterObjectiveComplete", - Type = "Event", - LiteralName = "INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE", - Payload = - { - { Name = "objectiveID", Type = "number", Nilable = false }, - }, - }, - { - Name = "InstanceEncounterObjectiveStart", - Type = "Event", - LiteralName = "INSTANCE_ENCOUNTER_OBJECTIVE_START", - Payload = - { - { Name = "objectiveID", Type = "number", Nilable = false }, - { Name = "objectiveProgress", Type = "number", Nilable = false }, - }, - }, - { - Name = "InstanceEncounterObjectiveUpdate", - Type = "Event", - LiteralName = "INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE", - 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/APIDocumentation/Documentation/InventoryDocumentation.lua b/APIDocumentation/Documentation/InventoryDocumentation.lua new file mode 100644 index 0000000..83ffc71 --- /dev/null +++ b/APIDocumentation/Documentation/InventoryDocumentation.lua @@ -0,0 +1,429 @@ +local Inventory = +{ + Name = "Inventory", + Type = "System", + Namespace = "Inventory", + + Functions = + { + { + Name = "AutoEquipCursorItem", + Type = "Function", + + }, + { + Name = "BankButtonIDToInvSlotID", + Type = "Function", + + Arguments = + { + { Name = "buttonID", Type = "number", Nilable = false }, + { Name = "isBag", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "inventoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CancelPendingEquip", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ContainerIDToInventoryID", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "inventoryID", Type = "number", Nilable = false }, + }, + }, + { + Name = "CursorCanGoInSlot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canBePlaced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EquipCursorItem", + Type = "Function", + + }, + { + Name = "EquipItemByName", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "EquipPendingItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "EquipmentManager_UnpackLocation", + Type = "Function", + + Arguments = + { + { Name = "location", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "player", Type = "bool", Nilable = false }, + { Name = "bank", Type = "bool", Nilable = false }, + { Name = "bags", Type = "bool", Nilable = false }, + { Name = "location or slot", Type = "number", Nilable = false }, + { Name = "bag", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryAlertStatus", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemBroken", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isBroken", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemCooldown", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemCount", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemDurability", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "durability", Type = "number", Nilable = false }, + { Name = "max", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemGems", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "gem1", Type = "number", Nilable = false }, + { Name = "gem2", Type = "number", Nilable = false }, + { Name = "gem3", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemID", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemLink", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemQuality", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "quality", Type = "itemQuality", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemTexture", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetInventoryItemsForSlot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "availableItems", Type = "table", Nilable = false }, + }, + }, + { + Name = "GetInventorySlotInfo", + Type = "Function", + + Arguments = + { + { Name = "slotName", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "checkRelic", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedItem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsEquippedItemType", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInventoryItemLocked", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KeyRingButtonIDToInvSlotID", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "PickupInventoryItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetInventoryPortraitTexture", + Type = "Function", + + Arguments = + { + { Name = "texture", Type = "table", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SocketInventoryItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "UpdateInventoryAlertStatus", + Type = "Function", + + }, + { + Name = "UseInventoryItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "UnitInventoryChanged", + Type = "Event", + LiteralName = "UNIT_INVENTORY_CHANGED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UpdateInventoryAlerts", + Type = "Event", + LiteralName = "UPDATE_INVENTORY_ALERTS", + }, + { + Name = "UpdateInventoryDurability", + Type = "Event", + LiteralName = "UPDATE_INVENTORY_DURABILITY", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Inventory); diff --git a/APIDocumentation/Documentation/ItemConstantsDocumentation.lua b/APIDocumentation/Documentation/ItemConstantsDocumentation.lua deleted file mode 100644 index 7cd93c4..0000000 --- a/APIDocumentation/Documentation/ItemConstantsDocumentation.lua +++ /dev/null @@ -1,427 +0,0 @@ -local ItemConstants = -{ - Tables = - { - { - 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 = "ItemClass", - Type = "Enumeration", - NumValues = 20, - MinValue = 0, - MaxValue = 19, - 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 = "ItemConsumableSubclass", - Type = "Enumeration", - NumValues = 8, - MinValue = 0, - MaxValue = 7, - Fields = - { - { Name = "Generic", Type = "ItemConsumableSubclass", EnumValue = 0 }, - { Name = "Potion", Type = "ItemConsumableSubclass", EnumValue = 1 }, - { Name = "Elixir", Type = "ItemConsumableSubclass", EnumValue = 2 }, - { Name = "Scroll", Type = "ItemConsumableSubclass", EnumValue = 3 }, - { Name = "Fooddrink", Type = "ItemConsumableSubclass", EnumValue = 4 }, - { Name = "Itemenhancement", Type = "ItemConsumableSubclass", EnumValue = 5 }, - { Name = "Bandage", Type = "ItemConsumableSubclass", EnumValue = 6 }, - { Name = "Other", Type = "ItemConsumableSubclass", EnumValue = 7 }, - }, - }, - { - Name = "ItemGemColor", - Type = "Enumeration", - NumValues = 26, - MinValue = 1, - MaxValue = 33554432, - 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 = "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 = "ItemQuality", - Type = "Enumeration", - NumValues = 9, - MinValue = 0, - MaxValue = 8, - Fields = - { - { Name = "Poor", Type = "ItemQuality", EnumValue = 0 }, - { Name = "Standard", Type = "ItemQuality", EnumValue = 1 }, - { Name = "Good", 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 }, - }, - }, - { - 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 = 26, - MinValue = 0, - MaxValue = 25, - 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 = "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 = "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 = "SlotRegion", - Type = "Enumeration", - NumValues = 5, - MinValue = 0, - MaxValue = 4, - Fields = - { - { Name = "Invalid", Type = "SlotRegion", EnumValue = 0 }, - { Name = "PlayerEquip", Type = "SlotRegion", EnumValue = 1 }, - { Name = "PlayerInv", Type = "SlotRegion", EnumValue = 2 }, - { Name = "Bank", Type = "SlotRegion", EnumValue = 3 }, - { Name = "ReagentBank", Type = "SlotRegion", EnumValue = 4 }, - }, - }, - { - 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 = "ItemConsts", - Type = "Constants", - Values = - { - { Name = "NUM_ITEM_ENCHANTMENT_SOCKETS", Type = "number", Value = 3 }, - }, - }, - { - 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/APIDocumentation/Documentation/ItemConstants_ClassicDocumentation.lua b/APIDocumentation/Documentation/ItemConstants_ClassicDocumentation.lua deleted file mode 100644 index dc51ba9..0000000 --- a/APIDocumentation/Documentation/ItemConstants_ClassicDocumentation.lua +++ /dev/null @@ -1,27 +0,0 @@ -local ItemConstants_Classic = -{ - Tables = - { - { - Name = "ItemGemSubclass", - Type = "Enumeration", - NumValues = 9, - MinValue = 0, - MaxValue = 8, - Fields = - { - { Name = "Red", Type = "ItemGemSubclass", EnumValue = 0 }, - { Name = "Blue", Type = "ItemGemSubclass", EnumValue = 1 }, - { Name = "Yellow", Type = "ItemGemSubclass", EnumValue = 2 }, - { Name = "Purple", Type = "ItemGemSubclass", EnumValue = 3 }, - { Name = "Green", Type = "ItemGemSubclass", EnumValue = 4 }, - { Name = "Orange", Type = "ItemGemSubclass", EnumValue = 5 }, - { Name = "Meta", Type = "ItemGemSubclass", EnumValue = 6 }, - { Name = "Simple", Type = "ItemGemSubclass", EnumValue = 7 }, - { Name = "Prismatic", Type = "ItemGemSubclass", EnumValue = 8 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(ItemConstants_Classic); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemDocumentation.lua b/APIDocumentation/Documentation/ItemDocumentation.lua index bba63ee..fcf8ec5 100644 --- a/APIDocumentation/Documentation/ItemDocumentation.lua +++ b/APIDocumentation/Documentation/ItemDocumentation.lua @@ -2,78 +2,154 @@ local Item = { Name = "Item", Type = "System", - Namespace = "C_Item", + Namespace = "Item", Functions = { { - Name = "DoesItemExist", + Name = "BindEnchant", + Type = "Function", + + }, + { + Name = "CancelPendingEquip", Type = "Function", Arguments = { - { Name = "emptiableItemLocation", Type = "EmptiableItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + }, + { + Name = "ConfirmBindOnUse", + Type = "Function", + + }, + { + Name = "CursorHasItem", + Type = "Function", + Returns = { - { Name = "itemExists", Type = "bool", Nilable = false }, + { Name = "hasItem", Type = "bool", Nilable = false }, }, }, { - Name = "DoesItemExistByID", + Name = "DeleteCursorItem", + Type = "Function", + + }, + { + Name = "EndBoundTradeable", Type = "Function", Arguments = { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EndRefund", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EquipItemByName", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "EquipPendingItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetItemCooldown", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "itemExists", Type = "bool", Nilable = false }, + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, }, }, { - Name = "GetCurrentItemLevel", + Name = "GetItemCount", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemId", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "includeBank", Type = "bool", Nilable = true }, + { Name = "includeCharges", Type = "bool", Nilable = true }, }, Returns = { - { Name = "currentItemLevel", Type = "number", Nilable = true }, + { Name = "itemCount", Type = "number", Nilable = false }, }, }, { - Name = "GetItemGUID", + Name = "GetItemFamily", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "bagType", Type = "number", Nilable = false }, }, }, { - Name = "GetItemID", + Name = "GetItemGem", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, }, Returns = { - { Name = "itemID", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "link", Type = "hyperlink", Nilable = false }, }, }, { @@ -82,395 +158,406 @@ local Item = Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "icon", Type = "fileID", Nilable = true }, - }, - }, - { - Name = "GetItemIconByID", - Type = "Function", - - Arguments = - { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, - }, - - Returns = - { - { Name = "icon", Type = "fileID", Nilable = true }, - }, - }, - { - Name = "GetItemInventoryType", - Type = "Function", - - Arguments = - { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "inventoryType", Type = "InventoryType", Nilable = true }, - }, - }, - { - Name = "GetItemInventoryTypeByID", - Type = "Function", - - Arguments = - { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, - }, - - Returns = - { - { Name = "inventoryType", Type = "InventoryType", Nilable = true }, - }, - }, - { - Name = "GetItemLink", - Type = "Function", - - Arguments = - { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, { Name = "itemLink", Type = "string", Nilable = true }, }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, }, { - Name = "GetItemMaxStackSize", + Name = "GetItemInfo", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "stackSize", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetItemMaxStackSizeByID", - Type = "Function", - - Arguments = - { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, - }, - - Returns = - { - { Name = "stackSize", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetItemName", - Type = "Function", - - Arguments = - { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, - }, - - Returns = - { + { Name = "itemID", Type = "number", Nilable = true }, { Name = "itemName", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetItemNameByID", - Type = "Function", - - Arguments = - { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { + { Name = "name", Type = "string", Nilable = false }, + { Name = "link", Type = "string", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "iLevel", Type = "number", Nilable = false }, + { Name = "reqLevel", Type = "number", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "subclass", Type = "string", Nilable = false }, + { Name = "maxStack", Type = "number", Nilable = false }, + { Name = "equipSlot", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "vendorPrice", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemQualityColor", + Type = "Function", + + Arguments = + { + { Name = "quality", Type = "itemQuality", Nilable = false }, + }, + + Returns = + { + { Name = "redComponent", Type = "number", Nilable = false }, + { Name = "greenComponent", Type = "number", Nilable = false }, + { Name = "blueComponent", Type = "number", Nilable = false }, + { Name = "hexColor", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetItemSpell", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, { Name = "itemName", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetItemQuality", - Type = "Function", - - Arguments = - { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "itemQuality", Type = "ItemQuality", Nilable = true }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, }, }, { - Name = "GetItemQualityByID", + Name = "GetItemStatDelta", Type = "Function", Arguments = { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "item1Link", Type = "string", Nilable = false }, + { Name = "item2Link", Type = "string", Nilable = false }, + { Name = "returnTable", Type = "table", Nilable = true }, }, Returns = { - { Name = "itemQuality", Type = "ItemQuality", Nilable = true }, + { Name = "statTable", Type = "table", Nilable = false }, }, }, { - Name = "GetStackCount", + Name = "GetItemStats", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemLink", Type = "string", Nilable = false }, + { Name = "returnTable", Type = "table", Nilable = true }, }, Returns = { - { Name = "stackCount", Type = "number", Nilable = false }, + { Name = "statTable", Type = "table", Nilable = false }, }, }, { - Name = "IsBound", + Name = "GetItemUniqueness", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "isBound", Type = "bool", Nilable = false }, + { Name = "uniqueFamily", Type = "number", Nilable = false }, + { Name = "maxEquipped", Type = "number", Nilable = false }, }, }, { - Name = "IsItemDataCached", + Name = "IsConsumableItem", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "isCached", Type = "bool", Nilable = false }, + { Name = "consumable", Type = "bool", Nilable = false }, }, }, { - Name = "IsItemDataCachedByID", + Name = "IsCurrentItem", Type = "Function", Arguments = { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "isCached", Type = "bool", Nilable = false }, + { Name = "isItem", Type = "bool", Nilable = false }, }, }, { - Name = "IsLocked", + Name = "IsDressableItem", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "isDressable", Type = "bool", Nilable = false }, }, }, { - Name = "LockItem", + Name = "IsEquippableItem", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isEquippable", Type = "bool", Nilable = false }, }, }, { - Name = "LockItemByGUID", + Name = "IsEquippedItem", Type = "Function", Arguments = { - { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, }, }, { - Name = "RequestLoadItemData", + Name = "IsEquippedItemType", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "type", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, }, }, { - Name = "RequestLoadItemDataByID", + Name = "IsHarmfulItem", Type = "Function", Arguments = { - { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, }, }, { - Name = "UnlockItem", + Name = "IsHelpfulItem", Type = "Function", Arguments = { - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, }, }, { - Name = "UnlockItemByGUID", + Name = "IsItemInRange", Type = "Function", Arguments = { - { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, }, + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsableItem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "notEnoughMana", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemHasRange", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "hasRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupItem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ReplaceEnchant", + Type = "Function", + + }, + { + Name = "SpellCanTargetItem", + Type = "Function", + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellTargetItem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "UseItemByName", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + }, + }, }, Events = { { - Name = "ActionWillBindItem", + Name = "CloseInboxItem", Type = "Event", - LiteralName = "ACTION_WILL_BIND_ITEM", - }, - { - Name = "BindEnchant", - Type = "Event", - LiteralName = "BIND_ENCHANT", - }, - { - Name = "CharacterItemFixupNotification", - Type = "Event", - LiteralName = "CHARACTER_ITEM_FIXUP_NOTIFICATION", + LiteralName = "CLOSE_INBOX_ITEM", Payload = { - { Name = "fixupVersion", Type = "number", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, }, }, - { - Name = "ConfirmBeforeUse", - Type = "Event", - LiteralName = "CONFIRM_BEFORE_USE", - }, { Name = "DeleteItemConfirm", Type = "Event", LiteralName = "DELETE_ITEM_CONFIRM", 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 = "itemName", Type = "string", Nilable = false }, + { Name = "itemQuality", Type = "number", Nilable = false }, }, }, { - Name = "EndBoundTradeable", + Name = "ItemLocked", Type = "Event", - LiteralName = "END_BOUND_TRADEABLE", + LiteralName = "ITEM_LOCKED", + }, + { + Name = "ItemLockChanged", + Type = "Event", + LiteralName = "ITEM_LOCK_CHANGED", + }, + { + Name = "ItemPush", + Type = "Event", + LiteralName = "ITEM_PUSH", Payload = { - { Name = "reason", Type = "cstring", Nilable = false }, + { Name = "bagID", Type = "number", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, }, }, { - Name = "GetItemInfoReceived", + Name = "ItemUnlocked", Type = "Event", - LiteralName = "GET_ITEM_INFO_RECEIVED", - Payload = - { - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "success", Type = "bool", Nilable = false }, - }, + LiteralName = "ITEM_UNLOCKED", }, { - Name = "ItemDataLoadResult", + Name = "MailLockSendItems", Type = "Event", - LiteralName = "ITEM_DATA_LOAD_RESULT", - Payload = - { - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "success", Type = "bool", Nilable = false }, - }, + LiteralName = "MAIL_LOCK_SEND_ITEMS", }, { - Name = "MerchantConfirmTradeTimerRemoval", + Name = "MailUnlockSendItems", Type = "Event", - LiteralName = "MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL", - Payload = - { - { Name = "itemLink", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ReplaceEnchant", - Type = "Event", - LiteralName = "REPLACE_ENCHANT", - Payload = - { - { Name = "existingStr", Type = "cstring", Nilable = false }, - { Name = "replacementStr", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ReplaceTradeskillEnchant", - Type = "Event", - LiteralName = "REPLACE_TRADESKILL_ENCHANT", - Payload = - { - { Name = "existing", Type = "cstring", Nilable = false }, - { Name = "replacement", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "TradeReplaceEnchant", - Type = "Event", - LiteralName = "TRADE_REPLACE_ENCHANT", - Payload = - { - { Name = "existing", Type = "cstring", Nilable = false }, - { Name = "replacement", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "UseBindConfirm", - Type = "Event", - LiteralName = "USE_BIND_CONFIRM", - }, - { - Name = "UseNoRefundConfirm", - Type = "Event", - LiteralName = "USE_NO_REFUND_CONFIRM", + LiteralName = "MAIL_UNLOCK_SEND_ITEMS", }, }, @@ -479,4 +566,4 @@ local Item = }, }; -APIDocumentation:AddDocumentationTable(Item); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Item); diff --git a/APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua b/APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua deleted file mode 100644 index 6caf9dc..0000000 --- a/APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local ItemLocationShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ItemLocationShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemSharedDocumentation.lua b/APIDocumentation/Documentation/ItemSharedDocumentation.lua deleted file mode 100644 index e77ddde..0000000 --- a/APIDocumentation/Documentation/ItemSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local ItemShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ItemShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua b/APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua deleted file mode 100644 index a4b63a2..0000000 --- a/APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua +++ /dev/null @@ -1,54 +0,0 @@ -local ItemSocketInfo = -{ - Name = "ItemSocketInfo", - Type = "System", - Namespace = "C_ItemSocketInfo", - - Functions = - { - { - Name = "CompleteSocketing", - Type = "Function", - }, - }, - - Events = - { - { - Name = "SocketInfoAccept", - Type = "Event", - LiteralName = "SOCKET_INFO_ACCEPT", - }, - { - Name = "SocketInfoClose", - Type = "Event", - LiteralName = "SOCKET_INFO_CLOSE", - }, - { - Name = "SocketInfoFailure", - Type = "Event", - LiteralName = "SOCKET_INFO_FAILURE", - }, - { - Name = "SocketInfoRefundableConfirm", - Type = "Event", - LiteralName = "SOCKET_INFO_REFUNDABLE_CONFIRM", - }, - { - Name = "SocketInfoSuccess", - Type = "Event", - LiteralName = "SOCKET_INFO_SUCCESS", - }, - { - Name = "SocketInfoUpdate", - Type = "Event", - LiteralName = "SOCKET_INFO_UPDATE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ItemSocketInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemTextDocumentation.lua b/APIDocumentation/Documentation/ItemTextDocumentation.lua index 67f4911..ea2d862 100644 --- a/APIDocumentation/Documentation/ItemTextDocumentation.lua +++ b/APIDocumentation/Documentation/ItemTextDocumentation.lua @@ -1,11 +1,80 @@ local ItemText = { - Name = "ItemText", + Name = "Item Text", Type = "System", - Namespace = "C_ItemText", + Namespace = "Item Text", Functions = { + { + Name = "CloseItemText", + Type = "Function", + + }, + { + Name = "ItemTextGetCreator", + Type = "Function", + + Returns = + { + { Name = "creator", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemTextGetItem", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemTextGetMaterial", + Type = "Function", + + Returns = + { + { Name = "material", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemTextGetPage", + Type = "Function", + + Returns = + { + { Name = "page", Type = "number", Nilable = false }, + }, + }, + { + Name = "ItemTextGetText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "ItemTextHasNextPage", + Type = "Function", + + Returns = + { + { Name = "next", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemTextNextPage", + Type = "Function", + + }, + { + Name = "ItemTextPrevPage", + Type = "Function", + + }, }, Events = @@ -31,7 +100,7 @@ local ItemText = LiteralName = "ITEM_TEXT_TRANSLATION", Payload = { - { Name = "delay", Type = "number", Nilable = false }, + { Name = "maxvalue", Type = "number", Nilable = false }, }, }, }, @@ -41,4 +110,4 @@ local ItemText = }, }; -APIDocumentation:AddDocumentationTable(ItemText); \ No newline at end of file +APIDocumentation:AddDocumentationTable(ItemText); diff --git a/APIDocumentation/Documentation/ItemUpgradeDocumentation.lua b/APIDocumentation/Documentation/ItemUpgradeDocumentation.lua deleted file mode 100644 index df6b1f8..0000000 --- a/APIDocumentation/Documentation/ItemUpgradeDocumentation.lua +++ /dev/null @@ -1,39 +0,0 @@ -local ItemUpgrade = -{ - Name = "ItemUpgrade", - Type = "System", - Namespace = "C_ItemUpgrade", - - Functions = - { - { - Name = "GetItemHyperlink", - Type = "Function", - - Returns = - { - { Name = "link", Type = "cstring", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "ItemUpgradeFailed", - Type = "Event", - LiteralName = "ITEM_UPGRADE_FAILED", - }, - { - Name = "ItemUpgradeMasterSetItem", - Type = "Event", - LiteralName = "ITEM_UPGRADE_MASTER_SET_ITEM", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ItemUpgrade); \ No newline at end of file diff --git a/APIDocumentation/Documentation/KeyBindingsDocumentation.lua b/APIDocumentation/Documentation/KeyBindingsDocumentation.lua deleted file mode 100644 index 78a5112..0000000 --- a/APIDocumentation/Documentation/KeyBindingsDocumentation.lua +++ /dev/null @@ -1,88 +0,0 @@ -local KeyBindings = -{ - Name = "KeyBindings", - Type = "System", - Namespace = "C_KeyBindings", - - Functions = - { - { - Name = "GetBindingIndex", - Type = "Function", - - Arguments = - { - { Name = "action", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "bindingIndex", Type = "luaIndex", Nilable = true }, - }, - }, - { - Name = "GetCustomBindingType", - Type = "Function", - - Arguments = - { - { Name = "bindingIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "customBindingType", Type = "CustomBindingType", Nilable = true }, - }, - }, - }, - - Events = - { - { - Name = "ModifierStateChanged", - Type = "Event", - LiteralName = "MODIFIER_STATE_CHANGED", - Payload = - { - { Name = "key", Type = "cstring", Nilable = false }, - { Name = "down", Type = "number", Nilable = false }, - }, - }, - { - Name = "UpdateBindings", - Type = "Event", - LiteralName = "UPDATE_BINDINGS", - }, - }, - - Tables = - { - { - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(KeyBindings); \ No newline at end of file diff --git a/APIDocumentation/Documentation/KeybindDocumentation.lua b/APIDocumentation/Documentation/KeybindDocumentation.lua new file mode 100644 index 0000000..9908542 --- /dev/null +++ b/APIDocumentation/Documentation/KeybindDocumentation.lua @@ -0,0 +1,297 @@ +local Keybind = +{ + Name = "Keybind", + Type = "System", + Namespace = "Keybind", + + Functions = + { + { + Name = "ClearOverrideBindings", + Type = "Function", + + Arguments = + { + { Name = "owner", Type = "table", Nilable = false }, + }, + + }, + { + Name = "GetBinding", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "commandName", Type = "string", Nilable = false }, + { Name = "binding1", Type = "string", Nilable = false }, + { Name = "binding2", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBindingAction", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = false }, + { Name = "checkOverride", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "action", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBindingByKey", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "action", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetBindingKey", + Type = "Function", + + Arguments = + { + { Name = "COMMAND", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "key1", Type = "string", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetCurrentBindingSet", + Type = "Function", + + Returns = + { + { Name = "bindingSet", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBindings", + Type = "Function", + + Returns = + { + { Name = "numBindings", Type = "number", Nilable = false }, + }, + }, + { + Name = "LoadBindings", + Type = "Function", + + Arguments = + { + { Name = "set", Type = "number", Nilable = false }, + }, + + }, + { + Name = "RunBinding", + Type = "Function", + + Arguments = + { + { Name = "COMMAND", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SaveBindings", + Type = "Function", + + Arguments = + { + { Name = "set", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetBinding", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = false }, + { Name = "command", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBindingClick", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = false }, + { Name = "buttonName", Type = "string", Nilable = false }, + { Name = "mouseButton", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBindingItem", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = true }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBindingMacro", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetBindingSpell", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = false }, + { Name = "spellname", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetMouselookOverrideBinding", + Type = "Function", + + Arguments = + { + { Name = "key", Type = "string", Nilable = false }, + { Name = "binding", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetOverrideBinding", + Type = "Function", + + Arguments = + { + { Name = "owner", Type = "table", Nilable = false }, + { Name = "isPriority", Type = "bool", Nilable = false }, + { Name = "key", Type = "string", Nilable = false }, + { Name = "command", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetOverrideBindingClick", + Type = "Function", + + Arguments = + { + { Name = "owner", Type = "table", Nilable = false }, + { Name = "isPriority", Type = "bool", Nilable = false }, + { Name = "key", Type = "string", Nilable = false }, + { Name = "buttonName", Type = "string", Nilable = false }, + { Name = "mouseButton", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SetOverrideBindingItem", + Type = "Function", + + Arguments = + { + { Name = "owner", Type = "table", Nilable = true }, + { Name = "isPriority", Type = "bool", Nilable = true }, + { Name = "key", Type = "string", Nilable = true }, + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SetOverrideBindingMacro", + Type = "Function", + + Arguments = + { + { Name = "owner", Type = "table", Nilable = true }, + { Name = "isPriority", Type = "bool", Nilable = true }, + { Name = "key", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SetOverrideBindingSpell", + Type = "Function", + + Arguments = + { + { Name = "owner", Type = "table", Nilable = false }, + { Name = "isPriority", Type = "bool", Nilable = false }, + { Name = "key", Type = "string", Nilable = false }, + { Name = "spellname", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Keybind); diff --git a/APIDocumentation/Documentation/KeyboardDocumentation.lua b/APIDocumentation/Documentation/KeyboardDocumentation.lua new file mode 100644 index 0000000..a2f8336 --- /dev/null +++ b/APIDocumentation/Documentation/KeyboardDocumentation.lua @@ -0,0 +1,119 @@ +local Keyboard = +{ + Name = "Keyboard", + Type = "System", + Namespace = "Keyboard", + + Functions = + { + { + Name = "GetCurrentKeyBoardFocus", + Type = "Function", + + Returns = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "IsAltKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsControlKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLeftAltKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLeftControlKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLeftShiftKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsModifierKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightAltKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightControlKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRightShiftKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsShiftKeyDown", + Type = "Function", + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Keyboard); diff --git a/APIDocumentation/Documentation/KnowledgeBaseDocumentation.lua b/APIDocumentation/Documentation/KnowledgeBaseDocumentation.lua index 0ee5985..524efd0 100644 --- a/APIDocumentation/Documentation/KnowledgeBaseDocumentation.lua +++ b/APIDocumentation/Documentation/KnowledgeBaseDocumentation.lua @@ -2,10 +2,263 @@ local KnowledgeBase = { Name = "KnowledgeBase", Type = "System", - Namespace = "C_KnowledgeBase", + Namespace = "KnowledgeBase", Functions = { + { + Name = "KBArticle_BeginLoading", + Type = "Function", + + Arguments = + { + { Name = "articleId", Type = "number", Nilable = false }, + { Name = "searchType", Type = "number", Nilable = false }, + }, + + }, + { + Name = "KBArticle_GetData", + Type = "Function", + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "subject", Type = "string", Nilable = false }, + { Name = "subjectAlt", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "keywords", Type = "string", Nilable = false }, + { Name = "languageId", Type = "number", Nilable = false }, + { Name = "isHot", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KBArticle_IsLoaded", + Type = "Function", + + Returns = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KBQuery_BeginLoading", + Type = "Function", + + Arguments = + { + { Name = "searchText", Type = "string", Nilable = false }, + { Name = "categoryIndex", Type = "luaIndex", Nilable = false }, + { Name = "subcategoryIndex", Type = "luaIndex", Nilable = false }, + { Name = "numArticles", Type = "number", Nilable = false }, + { Name = "page", Type = "number", Nilable = false }, + }, + + }, + { + Name = "KBQuery_GetArticleHeaderCount", + Type = "Function", + + Returns = + { + { Name = "articleHeaderCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBQuery_GetArticleHeaderData", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "articleId", Type = "number", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "isHotIssue", Type = "bool", Nilable = false }, + { Name = "isRecentlyUpdated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KBQuery_GetTotalArticleCount", + Type = "Function", + + Returns = + { + { Name = "totalArticleHeaderCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBQuery_IsLoaded", + Type = "Function", + + Returns = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KBSetup_BeginLoading", + Type = "Function", + + Arguments = + { + { Name = "numArticles", Type = "number", Nilable = false }, + { Name = "currentPage", Type = "number", Nilable = false }, + }, + + }, + { + Name = "KBSetup_GetArticleHeaderCount", + Type = "Function", + + Returns = + { + { Name = "articleHeaderCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetArticleHeaderData", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "articleId", Type = "number", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "isHotIssue", Type = "bool", Nilable = false }, + { Name = "isRecentlyUpdated", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetCategoryCount", + Type = "Function", + + Returns = + { + { Name = "numCategories", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetCategoryData", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "categoryId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetLanguageCount", + Type = "Function", + + Returns = + { + { Name = "numLanguages", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetLanguageData", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "languageId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetSubCategoryCount", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numSubCategories", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetSubCategoryData", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "subindex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "categoryId", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "KBSetup_GetTotalArticleCount", + Type = "Function", + + Returns = + { + { Name = "numArticles", Type = "number", Nilable = false }, + }, + }, + { + Name = "KBSetup_IsLoaded", + Type = "Function", + + Returns = + { + { Name = "isLoaded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "KBSystem_GetMOTD", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "KBSystem_GetServerNotice", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "KBSystem_GetServerStatus", + Type = "Function", + + Returns = + { + { Name = "statusMessage", Type = "string", Nilable = false }, + }, + }, }, Events = @@ -57,4 +310,4 @@ local KnowledgeBase = }, }; -APIDocumentation:AddDocumentationTable(KnowledgeBase); \ No newline at end of file +APIDocumentation:AddDocumentationTable(KnowledgeBase); diff --git a/APIDocumentation/Documentation/LFGConstantsDocumentation.lua b/APIDocumentation/Documentation/LFGConstantsDocumentation.lua deleted file mode 100644 index 4141bcc..0000000 --- a/APIDocumentation/Documentation/LFGConstantsDocumentation.lua +++ /dev/null @@ -1,30 +0,0 @@ -local LFGConstants = -{ - Tables = - { - { - Name = "LFGListFilter", - Type = "Enumeration", - NumValues = 4, - MinValue = 1, - MaxValue = 8, - 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 = "GroupFinderConstants", - Type = "Constants", - Values = - { - { Name = "MAX_GROUP_FINDER_ACTIVITIES", Type = "number", Value = 41 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(LFGConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LFGInfoDocumentation.lua b/APIDocumentation/Documentation/LFGInfoDocumentation.lua deleted file mode 100644 index d4b5aff..0000000 --- a/APIDocumentation/Documentation/LFGInfoDocumentation.lua +++ /dev/null @@ -1,234 +0,0 @@ -local LFGInfo = -{ - Name = "LFGInfo", - Type = "System", - Namespace = "C_LFGInfo", - - Functions = - { - }, - - Events = - { - { - Name = "IslandCompleted", - Type = "Event", - LiteralName = "ISLAND_COMPLETED", - Payload = - { - { Name = "mapID", Type = "number", Nilable = false }, - { Name = "winner", Type = "number", Nilable = false }, - }, - }, - { - Name = "LfgBootProposalUpdate", - Type = "Event", - LiteralName = "LFG_BOOT_PROPOSAL_UPDATE", - }, - { - Name = "LfgCompletionReward", - Type = "Event", - LiteralName = "LFG_COMPLETION_REWARD", - }, - { - Name = "LfgInvalidErrorMessage", - Type = "Event", - LiteralName = "LFG_INVALID_ERROR_MESSAGE", - 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", - }, - { - Name = "LfgOfferContinue", - Type = "Event", - LiteralName = "LFG_OFFER_CONTINUE", - 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", - Payload = - { - { Name = "dungeonID", Type = "number", Nilable = false }, - }, - }, - { - Name = "LfgProposalDone", - Type = "Event", - LiteralName = "LFG_PROPOSAL_DONE", - }, - { - Name = "LfgProposalFailed", - Type = "Event", - LiteralName = "LFG_PROPOSAL_FAILED", - }, - { - Name = "LfgProposalShow", - Type = "Event", - LiteralName = "LFG_PROPOSAL_SHOW", - }, - { - Name = "LfgProposalSucceeded", - Type = "Event", - LiteralName = "LFG_PROPOSAL_SUCCEEDED", - }, - { - Name = "LfgProposalUpdate", - Type = "Event", - LiteralName = "LFG_PROPOSAL_UPDATE", - }, - { - Name = "LfgQueueStatusUpdate", - Type = "Event", - LiteralName = "LFG_QUEUE_STATUS_UPDATE", - }, - { - Name = "LfgReadyCheckDeclined", - Type = "Event", - LiteralName = "LFG_READY_CHECK_DECLINED", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "LfgReadyCheckHide", - Type = "Event", - LiteralName = "LFG_READY_CHECK_HIDE", - }, - { - Name = "LfgReadyCheckPlayerIsReady", - Type = "Event", - LiteralName = "LFG_READY_CHECK_PLAYER_IS_READY", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "LfgReadyCheckShow", - Type = "Event", - LiteralName = "LFG_READY_CHECK_SHOW", - Payload = - { - { Name = "isRequeue", Type = "bool", Nilable = false }, - }, - }, - { - Name = "LfgReadyCheckUpdate", - Type = "Event", - LiteralName = "LFG_READY_CHECK_UPDATE", - }, - { - Name = "LfgRoleCheckDeclined", - Type = "Event", - LiteralName = "LFG_ROLE_CHECK_DECLINED", - }, - { - Name = "LfgRoleCheckHide", - Type = "Event", - LiteralName = "LFG_ROLE_CHECK_HIDE", - }, - { - Name = "LfgRoleCheckRoleChosen", - Type = "Event", - LiteralName = "LFG_ROLE_CHECK_ROLE_CHOSEN", - 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", - Payload = - { - { Name = "isRequeue", Type = "bool", Nilable = false }, - }, - }, - { - Name = "LfgRoleCheckUpdate", - Type = "Event", - LiteralName = "LFG_ROLE_CHECK_UPDATE", - }, - { - Name = "LfgRoleUpdate", - Type = "Event", - LiteralName = "LFG_ROLE_UPDATE", - }, - { - Name = "LfgUpdate", - Type = "Event", - LiteralName = "LFG_UPDATE", - }, - { - Name = "LfgUpdateRandomInfo", - Type = "Event", - LiteralName = "LFG_UPDATE_RANDOM_INFO", - }, - { - Name = "ShowLfgExpandSearchPrompt", - Type = "Event", - LiteralName = "SHOW_LFG_EXPAND_SEARCH_PROMPT", - }, - { - Name = "UpdateLfgList", - Type = "Event", - LiteralName = "UPDATE_LFG_LIST", - }, - { - Name = "WarfrontCompleted", - Type = "Event", - LiteralName = "WARFRONT_COMPLETED", - 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/APIDocumentation/Documentation/LFGListInfoDocumentation.lua b/APIDocumentation/Documentation/LFGListInfoDocumentation.lua deleted file mode 100644 index a25adc4..0000000 --- a/APIDocumentation/Documentation/LFGListInfoDocumentation.lua +++ /dev/null @@ -1,397 +0,0 @@ -local LFGListInfo = -{ - Name = "LFGList", - Type = "System", - Namespace = "C_LFGList", - - Functions = - { - { - Name = "ClearCreationTextFields", - Type = "Function", - }, - { - Name = "CopyActiveEntryInfoToCreationFields", - Type = "Function", - }, - { - Name = "CreateListing", - Type = "Function", - - Arguments = - { - { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, - { Name = "newPlayerFriendly", Type = "bool", Nilable = true }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetActiveEntryInfo", - Type = "Function", - - Returns = - { - { Name = "entryData", Type = "LfgEntryData", Nilable = false }, - }, - }, - { - Name = "GetActivityInfoTable", - Type = "Function", - - Arguments = - { - { Name = "activityID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "activityInfo", Type = "GroupFinderActivityInfo", Nilable = false }, - }, - }, - { - Name = "GetFilteredSearchResults", - Type = "Function", - - Returns = - { - { Name = "totalResultsFound", Type = "number", Nilable = false, Default = 0 }, - { Name = "filteredResults", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetRedirectedMapDifficultyID", - Type = "Function", - - Arguments = - { - { Name = "difficultyID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "redirectedMapDifficultyID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetRoles", - Type = "Function", - - Returns = - { - { Name = "roles", Type = "LFGRoles", Nilable = false }, - }, - }, - { - Name = "GetSavedRoles", - Type = "Function", - - Returns = - { - { Name = "roles", Type = "LFGRoles", Nilable = false }, - }, - }, - { - Name = "GetSearchResultInfo", - Type = "Function", - - Arguments = - { - { Name = "searchResultID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "searchResultData", Type = "LfgSearchResultData", 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", - - Arguments = - { - { Name = "searchResultID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasSearchResultInfo", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsLookingForGroupEnabled", - Type = "Function", - - Returns = - { - { Name = "isEnabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsPlayerAuthenticatedForLFG", - Type = "Function", - - Arguments = - { - { Name = "categoryID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "isAuthenticated", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RequestInvite", - Type = "Function", - - Arguments = - { - { Name = "searchResultID", Type = "number", Nilable = false }, - }, - }, - { - Name = "Search", - Type = "Function", - - Arguments = - { - { Name = "categoryID", Type = "number", Nilable = false }, - { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, - { Name = "filter", Type = "number", Nilable = false, Default = 0 }, - { Name = "preferredFilters", Type = "number", Nilable = false, Default = 0 }, - }, - }, - { - Name = "SetRoles", - Type = "Function", - - Arguments = - { - { Name = "roles", Type = "LFGRoles", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "UpdateListing", - Type = "Function", - - Arguments = - { - { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, - { Name = "newPlayerFriendly", Type = "bool", Nilable = true }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "LfgGroupDelistedLeadershipChange", - Type = "Event", - LiteralName = "LFG_GROUP_DELISTED_LEADERSHIP_CHANGE", - Payload = - { - { Name = "listingName", Type = "string", Nilable = false }, - { Name = "automaticDelistTimeRemaining", Type = "number", Nilable = false }, - }, - }, - { - Name = "LfgListActiveEntryUpdate", - Type = "Event", - LiteralName = "LFG_LIST_ACTIVE_ENTRY_UPDATE", - Payload = - { - { Name = "created", Type = "bool", Nilable = true }, - }, - }, - { - Name = "LfgListAvailabilityUpdate", - Type = "Event", - LiteralName = "LFG_LIST_AVAILABILITY_UPDATE", - }, - { - Name = "LfgListEntryCreationFailed", - Type = "Event", - LiteralName = "LFG_LIST_ENTRY_CREATION_FAILED", - }, - { - Name = "LfgListEntryExpiredTimeout", - Type = "Event", - LiteralName = "LFG_LIST_ENTRY_EXPIRED_TIMEOUT", - }, - { - Name = "LfgListEntryExpiredTooManyPlayers", - Type = "Event", - LiteralName = "LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS", - }, - { - Name = "LfgListRoleUpdate", - Type = "Event", - LiteralName = "LFG_LIST_ROLE_UPDATE", - }, - { - Name = "LfgListSearchFailed", - Type = "Event", - LiteralName = "LFG_LIST_SEARCH_FAILED", - Payload = - { - { Name = "reason", Type = "cstring", Nilable = true }, - }, - }, - { - Name = "LfgListSearchResultUpdated", - Type = "Event", - LiteralName = "LFG_LIST_SEARCH_RESULT_UPDATED", - Payload = - { - { Name = "searchResultID", Type = "number", Nilable = false }, - }, - }, - { - Name = "LfgListSearchResultsReceived", - Type = "Event", - LiteralName = "LFG_LIST_SEARCH_RESULTS_RECEIVED", - }, - }, - - Tables = - { - { - 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 = "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 = "filters", Type = "number", Nilable = false }, - { Name = "minLevel", Type = "number", Nilable = false }, - { Name = "maxLevel", 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 = "iconFileDataID", Type = "number", 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 = "LfgEntryData", - Type = "Structure", - Fields = - { - { Name = "activityIDs", Type = "table", InnerType = "number", Nilable = false }, - { Name = "comment", Type = "kstringLfgListApplicant", Nilable = false }, - { Name = "duration", Type = "time_t", Nilable = false }, - { Name = "newPlayerFriendly", Type = "bool", Nilable = false }, - }, - }, - { - Name = "LFGRoles", - Type = "Structure", - Fields = - { - { Name = "tank", Type = "bool", Nilable = false }, - { Name = "healer", Type = "bool", Nilable = false }, - { Name = "dps", Type = "bool", Nilable = false }, - }, - }, - { - 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 = "newPlayerFriendly", Type = "bool", Nilable = true }, - }, - }, - { - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(LFGListInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LevelConstantsDocumentation.lua b/APIDocumentation/Documentation/LevelConstantsDocumentation.lua deleted file mode 100644 index ca6d570..0000000 --- a/APIDocumentation/Documentation/LevelConstantsDocumentation.lua +++ /dev/null @@ -1,17 +0,0 @@ -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/APIDocumentation/Documentation/LimitedPlayTimeDocumentation.lua b/APIDocumentation/Documentation/LimitedPlayTimeDocumentation.lua new file mode 100644 index 0000000..7711961 --- /dev/null +++ b/APIDocumentation/Documentation/LimitedPlayTimeDocumentation.lua @@ -0,0 +1,56 @@ +local LimitedPlayTime = +{ + Name = "Limited Play Time", + Type = "System", + Namespace = "Limited Play Time", + + Functions = + { + { + Name = "GetBillingTimeRested", + Type = "Function", + + Returns = + { + { Name = "time", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "NoPlayTime", + Type = "Function", + + Returns = + { + { Name = "hasNoTime", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PartialPlayTime", + Type = "Function", + + Returns = + { + { Name = "partialPlayTime", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BillingNagDialog", + Type = "Event", + LiteralName = "BILLING_NAG_DIALOG", + Payload = + { + { Name = "remaining", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LimitedPlayTime); diff --git a/APIDocumentation/Documentation/LoadingScreenDocumentation.lua b/APIDocumentation/Documentation/LoadingScreenDocumentation.lua deleted file mode 100644 index 14afa7d..0000000 --- a/APIDocumentation/Documentation/LoadingScreenDocumentation.lua +++ /dev/null @@ -1,30 +0,0 @@ -local LoadingScreen = -{ - Name = "LoadingScreen", - Type = "System", - Namespace = "C_LoadingScreen", - - Functions = - { - }, - - Events = - { - { - Name = "LoadingScreenDisabled", - Type = "Event", - LiteralName = "LOADING_SCREEN_DISABLED", - }, - { - Name = "LoadingScreenEnabled", - Type = "Event", - LiteralName = "LOADING_SCREEN_ENABLED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(LoadingScreen); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LocaleDocumentation.lua b/APIDocumentation/Documentation/LocaleDocumentation.lua deleted file mode 100644 index b9e6495..0000000 --- a/APIDocumentation/Documentation/LocaleDocumentation.lua +++ /dev/null @@ -1,28 +0,0 @@ -local Locale = -{ - Name = "Locale", - Type = "System", - - Functions = - { - }, - - 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/APIDocumentation/Documentation/LocaleSpecificDocumentation.lua b/APIDocumentation/Documentation/LocaleSpecificDocumentation.lua new file mode 100644 index 0000000..a6a122f --- /dev/null +++ b/APIDocumentation/Documentation/LocaleSpecificDocumentation.lua @@ -0,0 +1,66 @@ +local LocaleSpecific = +{ + Name = "Locale Specific", + Type = "System", + Namespace = "Locale Specific", + + Functions = + { + { + Name = "DeclineName", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "gender", Type = "number", Nilable = false }, + { Name = "declensionSet", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "genitive", Type = "string", Nilable = false }, + { Name = "dative", Type = "string", Nilable = false }, + { Name = "accusative", Type = "string", Nilable = false }, + { Name = "instrumental", Type = "string", Nilable = false }, + { Name = "prepositional", Type = "string", Nilable = false }, + }, + }, + { + Name = "FillLocalizedClassList", + Type = "Function", + + Arguments = + { + { Name = "table", Type = "number", Nilable = false }, + { Name = "female", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "GetNumDeclensionSets", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "gender", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numSets", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LocaleSpecific); diff --git a/APIDocumentation/Documentation/LocalizationDocumentation.lua b/APIDocumentation/Documentation/LocalizationDocumentation.lua deleted file mode 100644 index 11838cc..0000000 --- a/APIDocumentation/Documentation/LocalizationDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Localization = -{ - Name = "Localization", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Localization); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LookingForGroupDocumentation.lua b/APIDocumentation/Documentation/LookingForGroupDocumentation.lua new file mode 100644 index 0000000..1d8ae5e --- /dev/null +++ b/APIDocumentation/Documentation/LookingForGroupDocumentation.lua @@ -0,0 +1,159 @@ +local LookingForGroup = +{ + Name = "Looking for Group", + Type = "System", + Namespace = "Looking for Group", + + Functions = + { + { + Name = "GetLFGMode", + Type = "Function", + + Returns = + { + { Name = "mode", Type = "string", Nilable = false }, + { Name = "submode", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetLFGRoles", + Type = "Function", + + Returns = + { + { Name = "leader", Type = "bool", Nilable = false }, + { Name = "tank", Type = "bool", Nilable = false }, + { Name = "healer", Type = "bool", Nilable = false }, + { Name = "damage", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetLFGTypes", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "SetLFGComment", + Type = "Function", + + Arguments = + { + { Name = "comment", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetLFGRoles", + Type = "Function", + + Arguments = + { + { Name = "leader", Type = "bool", Nilable = false }, + { Name = "tank", Type = "bool", Nilable = false }, + { Name = "healer", Type = "bool", Nilable = false }, + { Name = "damage", Type = "bool", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "LfgBootProposalUpdate", + Type = "Event", + LiteralName = "LFG_BOOT_PROPOSAL_UPDATE", + }, + { + Name = "LfgCompletionReward", + Type = "Event", + LiteralName = "LFG_COMPLETION_REWARD", + }, + { + Name = "LfgLockInfoReceived", + Type = "Event", + LiteralName = "LFG_LOCK_INFO_RECEIVED", + }, + { + Name = "LfgOfferContinue", + Type = "Event", + LiteralName = "LFG_OFFER_CONTINUE", + }, + { + Name = "LfgOpenFromGossip", + Type = "Event", + LiteralName = "LFG_OPEN_FROM_GOSSIP", + }, + { + Name = "LfgProposalFailed", + Type = "Event", + LiteralName = "LFG_PROPOSAL_FAILED", + }, + { + Name = "LfgProposalShow", + Type = "Event", + LiteralName = "LFG_PROPOSAL_SHOW", + }, + { + Name = "LfgProposalSucceeded", + Type = "Event", + LiteralName = "LFG_PROPOSAL_SUCCEEDED", + }, + { + Name = "LfgProposalUpdate", + Type = "Event", + LiteralName = "LFG_PROPOSAL_UPDATE", + }, + { + Name = "LfgQueueStatusUpdate", + Type = "Event", + LiteralName = "LFG_QUEUE_STATUS_UPDATE", + }, + { + Name = "LfgRoleCheckHide", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_HIDE", + }, + { + Name = "LfgRoleCheckRoleChosen", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_ROLE_CHOSEN", + }, + { + Name = "LfgRoleCheckShow", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_SHOW", + }, + { + Name = "LfgRoleCheckUpdate", + Type = "Event", + LiteralName = "LFG_ROLE_CHECK_UPDATE", + }, + { + Name = "LfgRoleUpdate", + Type = "Event", + LiteralName = "LFG_ROLE_UPDATE", + }, + { + Name = "LfgUpdate", + Type = "Event", + LiteralName = "LFG_UPDATE", + }, + { + Name = "LfgUpdateRandomInfo", + Type = "Event", + LiteralName = "LFG_UPDATE_RANDOM_INFO", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LookingForGroup); diff --git a/APIDocumentation/Documentation/LootConstantsDocumentation.lua b/APIDocumentation/Documentation/LootConstantsDocumentation.lua deleted file mode 100644 index 7064aaf..0000000 --- a/APIDocumentation/Documentation/LootConstantsDocumentation.lua +++ /dev/null @@ -1,30 +0,0 @@ -local LootConstants = -{ - Tables = - { - { - 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/APIDocumentation/Documentation/LootDocumentation.lua b/APIDocumentation/Documentation/LootDocumentation.lua index d4dad4c..813a741 100644 --- a/APIDocumentation/Documentation/LootDocumentation.lua +++ b/APIDocumentation/Documentation/LootDocumentation.lua @@ -2,32 +2,280 @@ local Loot = { Name = "Loot", Type = "System", - Namespace = "C_Loot", + Namespace = "Loot", Functions = { { - Name = "IsLegacyLootModeEnabled", + Name = "CloseLoot", + Type = "Function", + + }, + { + Name = "ConfirmLootRoll", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "rollType", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ConfirmLootSlot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetLootMethod", Type = "Function", Returns = { - { Name = "isLegacyLootModeEnabled", Type = "bool", Nilable = false }, + { Name = "method", Type = "string", Nilable = false }, + { Name = "partyMaster", Type = "number", Nilable = false }, + { Name = "raidMaster", Type = "number", Nilable = false }, }, }, + { + Name = "GetLootRollItemInfo", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "bindOnPickUp", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetLootRollItemLink", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetLootRollTimeLeft", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLootSlotInfo", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "item", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "locked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetLootSlotLink", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetLootThreshold", + Type = "Function", + + Returns = + { + { Name = "threshold", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMasterLootCandidate", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "candidate", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumLootItems", + Type = "Function", + + Returns = + { + { Name = "numItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetOptOutOfLoot", + Type = "Function", + + Returns = + { + { Name = "isOptOut", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GiveMasterLoot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "IsFishingLoot", + Type = "Function", + + Returns = + { + { Name = "isFishing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LootSlot", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "LootSlotIsCoin", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCoin", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LootSlotIsItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isItem", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RollOnLoot", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "rollType", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetLootMethod", + Type = "Function", + + Arguments = + { + { Name = "method", Type = "string", Nilable = false }, + { Name = "master", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SetLootPortrait", + Type = "Function", + + Arguments = + { + { Name = "texture", Type = "table", Nilable = false }, + }, + + }, + { + Name = "SetLootThreshold", + Type = "Function", + + Arguments = + { + { Name = "threshold", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetOptOutOfLoot", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, }, Events = { - { - Name = "AzeriteEmpoweredItemLooted", - Type = "Event", - LiteralName = "AZERITE_EMPOWERED_ITEM_LOOTED", - Payload = - { - { Name = "itemLink", Type = "cstring", Nilable = false }, - }, - }, { Name = "CancelLootRoll", Type = "Event", @@ -43,19 +291,8 @@ local Loot = LiteralName = "CONFIRM_LOOT_ROLL", Payload = { - { Name = "rollID", Type = "number", Nilable = false }, - { Name = "rollType", Type = "number", Nilable = false }, - { Name = "confirmReason", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ItemPush", - Type = "Event", - LiteralName = "ITEM_PUSH", - Payload = - { - { Name = "bagSlot", Type = "luaIndex", Nilable = false }, - { Name = "iconFileID", Type = "number", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "rolltype", Type = "number", Nilable = false }, }, }, { @@ -64,7 +301,7 @@ local Loot = LiteralName = "LOOT_BIND_CONFIRM", Payload = { - { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + { Name = "slotID", Type = "number", Nilable = false }, }, }, { @@ -72,59 +309,6 @@ local Loot = Type = "Event", LiteralName = "LOOT_CLOSED", }, - { - Name = "LootHistoryAutoShow", - Type = "Event", - LiteralName = "LOOT_HISTORY_AUTO_SHOW", - Payload = - { - { Name = "rollID", Type = "number", Nilable = false }, - { Name = "isMasterLoot", Type = "bool", Nilable = false }, - }, - }, - { - Name = "LootHistoryFullUpdate", - Type = "Event", - LiteralName = "LOOT_HISTORY_FULL_UPDATE", - }, - { - Name = "LootHistoryRollChanged", - Type = "Event", - LiteralName = "LOOT_HISTORY_ROLL_CHANGED", - Payload = - { - { Name = "historyIndex", Type = "number", Nilable = false }, - { Name = "playerIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "LootHistoryRollComplete", - Type = "Event", - LiteralName = "LOOT_HISTORY_ROLL_COMPLETE", - }, - { - Name = "LootItemAvailable", - Type = "Event", - LiteralName = "LOOT_ITEM_AVAILABLE", - Payload = - { - { Name = "itemTooltip", Type = "cstring", Nilable = false }, - { Name = "lootHandle", Type = "number", Nilable = false }, - }, - }, - { - Name = "LootItemRollWon", - Type = "Event", - LiteralName = "LOOT_ITEM_ROLL_WON", - 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", @@ -134,32 +318,10 @@ local Loot = { Name = "autoLoot", Type = "bool", Nilable = false }, }, }, - { - Name = "LootReady", - Type = "Event", - LiteralName = "LOOT_READY", - Payload = - { - { Name = "autoloot", Type = "bool", Nilable = false }, - }, - }, - { - Name = "LootRollsComplete", - Type = "Event", - LiteralName = "LOOT_ROLLS_COMPLETE", - Payload = - { - { Name = "lootHandle", Type = "number", Nilable = false }, - }, - }, { Name = "LootSlotChanged", Type = "Event", LiteralName = "LOOT_SLOT_CHANGED", - Payload = - { - { Name = "lootSlot", Type = "luaIndex", Nilable = false }, - }, }, { Name = "LootSlotCleared", @@ -167,7 +329,7 @@ local Loot = LiteralName = "LOOT_SLOT_CLEARED", Payload = { - { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + { Name = "slotID", Type = "number", Nilable = false }, }, }, { @@ -175,76 +337,16 @@ local Loot = Type = "Event", LiteralName = "OPEN_MASTER_LOOT_LIST", }, - { - Name = "ShowLootToastLegendaryLooted", - Type = "Event", - LiteralName = "SHOW_LOOT_TOAST_LEGENDARY_LOOTED", - Payload = - { - { Name = "itemLink", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ShowLootToastUpgrade", - Type = "Event", - LiteralName = "SHOW_LOOT_TOAST_UPGRADE", - 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", - 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", - 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", Payload = { - { Name = "rollID", Type = "number", Nilable = false }, - { Name = "rollTime", Type = "number", Nilable = false }, - { Name = "lootHandle", Type = "number", Nilable = true }, + { Name = "id", Type = "number", Nilable = false }, + { Name = "time", Type = "time_t", Nilable = false }, }, }, - { - Name = "TrialCapReachedMoney", - Type = "Event", - LiteralName = "TRIAL_CAP_REACHED_MONEY", - }, { Name = "UpdateMasterLootList", Type = "Event", @@ -257,4 +359,4 @@ local Loot = }, }; -APIDocumentation:AddDocumentationTable(Loot); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Loot); diff --git a/APIDocumentation/Documentation/LossOfControlDocumentation.lua b/APIDocumentation/Documentation/LossOfControlDocumentation.lua deleted file mode 100644 index 9bd4ef4..0000000 --- a/APIDocumentation/Documentation/LossOfControlDocumentation.lua +++ /dev/null @@ -1,132 +0,0 @@ -local LossOfControl = -{ - Name = "LossOfControl", - Type = "System", - Namespace = "C_LossOfControl", - - Functions = - { - { - Name = "GetActiveLossOfControlData", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "event", Type = "LossOfControlData", Nilable = true }, - }, - }, - { - Name = "GetActiveLossOfControlDataByUnit", - Type = "Function", - - 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", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "count", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "LossOfControlAdded", - Type = "Event", - LiteralName = "LOSS_OF_CONTROL_ADDED", - Payload = - { - { Name = "effectIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "LossOfControlCommentatorAdded", - Type = "Event", - LiteralName = "LOSS_OF_CONTROL_COMMENTATOR_ADDED", - Payload = - { - { Name = "victim", Type = "WOWGUID", Nilable = false }, - { Name = "effectIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "LossOfControlCommentatorUpdate", - Type = "Event", - LiteralName = "LOSS_OF_CONTROL_COMMENTATOR_UPDATE", - Payload = - { - { Name = "victim", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "LossOfControlUpdate", - Type = "Event", - LiteralName = "LOSS_OF_CONTROL_UPDATE", - }, - { - Name = "PlayerControlGained", - Type = "Event", - LiteralName = "PLAYER_CONTROL_GAINED", - }, - { - Name = "PlayerControlLost", - Type = "Event", - LiteralName = "PLAYER_CONTROL_LOST", - }, - }, - - Tables = - { - { - Name = "LossOfControlData", - Type = "Structure", - Fields = - { - { Name = "locType", Type = "cstring", Nilable = false }, - { 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 }, - { Name = "displayType", Type = "number", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(LossOfControl); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LuaLibraryDocumentation.lua b/APIDocumentation/Documentation/LuaLibraryDocumentation.lua new file mode 100644 index 0000000..8ce82f5 --- /dev/null +++ b/APIDocumentation/Documentation/LuaLibraryDocumentation.lua @@ -0,0 +1,750 @@ +local LuaLibrary = +{ + Name = "Lua Library", + Type = "System", + Namespace = "Lua Library", + + Functions = + { + { + Name = "abs", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "absoluteValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "ceil", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "ceiling", Type = "number", Nilable = false }, + }, + }, + { + Name = "collectgarbage", + Type = "Function", + + Arguments = + { + { Name = "option", Type = "string", Nilable = false }, + { Name = "arg", Type = "number", Nilable = true }, + }, + + }, + { + Name = "date", + Type = "Function", + + Arguments = + { + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + }, + + }, + { + Name = "deg", + Type = "Function", + + Arguments = + { + { Name = "radians", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "degrees", Type = "number", Nilable = false }, + }, + }, + { + Name = "difftime", + Type = "Function", + + Arguments = + { + { Name = "time2", Type = "number", Nilable = false }, + { Name = "time1", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "error", + Type = "Function", + + Arguments = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = true }, + }, + + }, + { + Name = "exp", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "exp", Type = "number", Nilable = false }, + }, + }, + { + Name = "floor", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "floor", Type = "number", Nilable = false }, + }, + }, + { + Name = "foreach", + Type = "Function", + + }, + { + Name = "foreachi", + Type = "Function", + + }, + { + Name = "format", + Type = "Function", + + Arguments = + { + { Name = "formatString", Type = "string", Nilable = false }, + { Name = "...", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "formatted", Type = "number", Nilable = false }, + }, + }, + { + Name = "frexp", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "m", Type = "number", Nilable = false }, + { Name = "e", Type = "number", Nilable = false }, + }, + }, + { + Name = "gcinfo", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "getfenv", + Type = "Function", + + Arguments = + { + { Name = "f", Type = "function", Nilable = true }, + { Name = "stackLevel", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "env", Type = "table", Nilable = false }, + }, + }, + { + Name = "getmetatable", + Type = "Function", + + Arguments = + { + { Name = "object", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "metatable", Type = "string", Nilable = false }, + }, + }, + { + Name = "getn", + Type = "Function", + + }, + { + Name = "gmatch", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "pattern", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "iterator", Type = "function", Nilable = false }, + }, + }, + { + Name = "gsub", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = true }, + { Name = "pattern", Type = "string", Nilable = true }, + { Name = "rep", Type = "string", Nilable = true }, + { Name = "repTable", Type = "table", Nilable = true }, + { Name = "repFunc", Type = "function", Nilable = true }, + { Name = "maxReplaced", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "newString", Type = "string", Nilable = false }, + { Name = "numMatched", Type = "number", Nilable = false }, + }, + }, + { + Name = "ipairs", + Type = "Function", + + Arguments = + { + { Name = "t", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "iterator", Type = "function", Nilable = false }, + { Name = "t", Type = "table", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ldexp", + Type = "Function", + + Arguments = + { + { Name = "m", Type = "number", Nilable = false }, + { Name = "e", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "x", Type = "number", Nilable = false }, + }, + }, + { + Name = "loadstring", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "chunkname", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "chunk", Type = "function", Nilable = false }, + { Name = "error", Type = "string", Nilable = false }, + }, + }, + { + Name = "log", + Type = "Function", + + }, + { + Name = "log10", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "base10log", Type = "number", Nilable = false }, + }, + }, + { + Name = "max", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "min", + Type = "Function", + + Arguments = + { + { Name = "team", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "next", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "nextID", Type = "number", Nilable = false }, + { Name = "completed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "pairs", + Type = "Function", + + Arguments = + { + { Name = "t", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "iterator", Type = "function", Nilable = false }, + { Name = "t", Type = "table", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "pcall", + Type = "Function", + + Arguments = + { + { Name = "f", Type = "function", Nilable = false }, + { Name = "...", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "rad", + Type = "Function", + + }, + { + Name = "random", + Type = "Function", + + }, + { + Name = "rawequal", + Type = "Function", + + Arguments = + { + { Name = "v1", Type = "string", Nilable = false }, + { Name = "v2", Type = "function", Nilable = false }, + }, + + Returns = + { + { Name = "isEqual", Type = "bool", Nilable = false }, + }, + }, + { + Name = "rawget", + Type = "Function", + + Arguments = + { + { Name = "t", Type = "table", Nilable = false }, + { Name = "key", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "string", Nilable = false }, + }, + }, + { + Name = "rawset", + Type = "Function", + + Arguments = + { + { Name = "t", Type = "table", Nilable = false }, + { Name = "key", Type = "string", Nilable = false }, + { Name = "value", Type = "string", Nilable = false }, + }, + + }, + { + Name = "select", + Type = "Function", + + }, + { + Name = "setfenv", + Type = "Function", + + Arguments = + { + { Name = "f", Type = "function", Nilable = true }, + { Name = "stackLevel", Type = "number", Nilable = true }, + { Name = "t", Type = "table", Nilable = true }, + }, + + Returns = + { + { Name = "f", Type = "function", Nilable = false }, + }, + }, + { + Name = "setmetatable", + Type = "Function", + + Arguments = + { + { Name = "t", Type = "table", Nilable = false }, + { Name = "metatable", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "t", Type = "table", Nilable = false }, + }, + }, + { + Name = "sort", + Type = "Function", + + Returns = + { + { Name = "criterion", Type = "string", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "sqrt", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "root", Type = "number", Nilable = false }, + }, + }, + { + Name = "strbyte", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "firstChar", Type = "number", Nilable = false }, + { Name = "lastChar", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "value", Type = "number", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "strchar", + Type = "Function", + + Arguments = + { + { Name = "n", Type = "number", Nilable = false }, + { Name = "...", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "s", Type = "number", Nilable = false }, + }, + }, + { + Name = "strfind", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "pattern", Type = "string", Nilable = false }, + { Name = "init", Type = "number", Nilable = false }, + { Name = "plain", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "end", Type = "number", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "strlen", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "length", Type = "number", Nilable = false }, + }, + }, + { + Name = "strlower", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "lowerCase", Type = "string", Nilable = false }, + }, + }, + { + Name = "strmatch", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "pattern", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "match", Type = "string", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "strrep", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "n", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "repeated", Type = "string", Nilable = false }, + }, + }, + { + Name = "strrev", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "s", Type = "string", Nilable = false }, + }, + }, + { + Name = "strsub", + Type = "Function", + + Arguments = + { + { Name = "s", Type = "string", Nilable = false }, + { Name = "firstChar", Type = "number", Nilable = false }, + { Name = "lastChar", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "s", Type = "string", Nilable = false }, + }, + }, + { + Name = "strupper", + Type = "Function", + + Arguments = + { + { Name = "str", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "lowerCase", Type = "string", Nilable = false }, + }, + }, + { + Name = "time", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "weekday", Type = "number", Nilable = false }, + { Name = "month", Type = "number", Nilable = false }, + { Name = "day", Type = "number", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "tinsert", + Type = "Function", + + Arguments = + { + { Name = "table", Type = "table", Nilable = false }, + { Name = "position", Type = "number", Nilable = true }, + { Name = "value", Type = "string", Nilable = false }, + }, + + }, + { + Name = "tonumber", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "string", Nilable = false }, + { Name = "base", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "numValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "tostring", + Type = "Function", + + Arguments = + { + { Name = "value", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "stringValue", Type = "string", Nilable = false }, + }, + }, + { + Name = "unpack", + Type = "Function", + + Arguments = + { + { Name = "location", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "player", Type = "bool", Nilable = false }, + { Name = "bank", Type = "bool", Nilable = false }, + { Name = "bags", Type = "bool", Nilable = false }, + { Name = "location or slot", Type = "number", Nilable = false }, + { Name = "bag", Type = "number", Nilable = false }, + }, + }, + { + Name = "xpcall", + Type = "Function", + + Arguments = + { + { Name = "f", Type = "function", Nilable = false }, + { Name = "err", Type = "function", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(LuaLibrary); diff --git a/APIDocumentation/Documentation/MacClientDocumentation.lua b/APIDocumentation/Documentation/MacClientDocumentation.lua new file mode 100644 index 0000000..378af25 --- /dev/null +++ b/APIDocumentation/Documentation/MacClientDocumentation.lua @@ -0,0 +1,227 @@ +local MacClient = +{ + Name = "Mac Client", + Type = "System", + Namespace = "Mac Client", + + Functions = + { + { + Name = "IsMacClient", + Type = "Function", + + Returns = + { + { Name = "isMac", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MovieRecording_Cancel", + Type = "Function", + + }, + { + Name = "MovieRecording_DataRate", + Type = "Function", + + Arguments = + { + { Name = "width", Type = "number", Nilable = false }, + { Name = "framerate", Type = "number", Nilable = false }, + { Name = "sound", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dataRate", Type = "string", Nilable = false }, + }, + }, + { + Name = "MovieRecording_DeleteMovie", + Type = "Function", + + Arguments = + { + { Name = "filename", Type = "string", Nilable = false }, + }, + + }, + { + Name = "MovieRecording_GetAspectRatio", + Type = "Function", + + Returns = + { + { Name = "ratio", Type = "number", Nilable = false }, + }, + }, + { + Name = "MovieRecording_GetMovieFullPath", + Type = "Function", + + Returns = + { + { Name = "path", Type = "string", Nilable = false }, + }, + }, + { + Name = "MovieRecording_GetProgress", + Type = "Function", + + Returns = + { + { Name = "recovering", Type = "bool", Nilable = false }, + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "MovieRecording_GetTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "string", Nilable = false }, + }, + }, + { + Name = "MovieRecording_GetViewportWidth", + Type = "Function", + + Returns = + { + { Name = "width", Type = "number", Nilable = false }, + }, + }, + { + Name = "MovieRecording_IsCodecSupported", + Type = "Function", + + Arguments = + { + { Name = "codecID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MovieRecording_IsCompressing", + Type = "Function", + + Returns = + { + { Name = "isCompressing", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MovieRecording_IsCursorRecordingSupported", + Type = "Function", + + Returns = + { + { Name = "isSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MovieRecording_IsRecording", + Type = "Function", + + Returns = + { + { Name = "isRecording", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MovieRecording_IsSupported", + Type = "Function", + + Returns = + { + { Name = "isSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MovieRecording_MaxLength", + Type = "Function", + + Arguments = + { + { Name = "width", Type = "number", Nilable = false }, + { Name = "framerate", Type = "number", Nilable = false }, + { Name = "sound", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "time", Type = "string", Nilable = false }, + }, + }, + { + Name = "MovieRecording_QueueMovieToCompress", + Type = "Function", + + Arguments = + { + { Name = "filename", Type = "string", Nilable = false }, + }, + + }, + { + Name = "MovieRecording_SearchUncompressedMovie", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "MovieRecording_Toggle", + Type = "Function", + + }, + { + Name = "MovieRecording_ToggleGUI", + Type = "Function", + + }, + { + Name = "MusicPlayer_BackTrack", + Type = "Function", + + }, + { + Name = "MusicPlayer_NextTrack", + Type = "Function", + + }, + { + Name = "MusicPlayer_PlayPause", + Type = "Function", + + }, + { + Name = "MusicPlayer_VolumeDown", + Type = "Function", + + }, + { + Name = "MusicPlayer_VolumeUp", + Type = "Function", + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(MacClient); diff --git a/APIDocumentation/Documentation/MacroDocumentation.lua b/APIDocumentation/Documentation/MacroDocumentation.lua new file mode 100644 index 0000000..3f7feb0 --- /dev/null +++ b/APIDocumentation/Documentation/MacroDocumentation.lua @@ -0,0 +1,311 @@ +local Macro = +{ + Name = "Macro", + Type = "System", + Namespace = "Macro", + + Functions = + { + { + Name = "CreateMacro", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "number", Nilable = false }, + { Name = "body", Type = "string", Nilable = false }, + { Name = "perCharacter", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CursorHasMacro", + Type = "Function", + + Returns = + { + { Name = "hasMacro", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeleteMacro", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "EditMacro", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconTexture", Type = "string", Nilable = false }, + { Name = "body", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "newIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetMacroBody", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "body", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMacroIconInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMacroIndexByName", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetMacroInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "body", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMacroItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetMacroItemIconInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMacroSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumMacroIcons", + Type = "Function", + + Returns = + { + { Name = "numMacroIcons", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMacroItemIcons", + Type = "Function", + + Returns = + { + { Name = "numIcons", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMacros", + Type = "Function", + + Returns = + { + { Name = "numAccountMacros", Type = "number", Nilable = false }, + { Name = "numCharacterMacros", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRunningMacro", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetRunningMacroButton", + Type = "Function", + + Returns = + { + { Name = "button", Type = "string", Nilable = false }, + }, + }, + { + Name = "PickupMacro", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "RunMacro", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "button", Type = "string", Nilable = true }, + }, + + }, + { + Name = "RunMacroText", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "button", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SecureCmdOptionParse", + Type = "Function", + + Arguments = + { + { Name = "cmd", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "action", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetMacroItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "item", Type = "string", Nilable = true }, + { Name = "target", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SetMacroSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "spell", Type = "string", Nilable = true }, + { Name = "target", Type = "string", Nilable = true }, + }, + + }, + { + Name = "StopMacro", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "UpdateMacros", + Type = "Event", + LiteralName = "UPDATE_MACROS", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Macro); diff --git a/APIDocumentation/Documentation/MailDocumentation.lua b/APIDocumentation/Documentation/MailDocumentation.lua new file mode 100644 index 0000000..7c2da4b --- /dev/null +++ b/APIDocumentation/Documentation/MailDocumentation.lua @@ -0,0 +1,481 @@ +local Mail = +{ + Name = "Mail", + Type = "System", + Namespace = "Mail", + + Functions = + { + { + Name = "AutoLootMailItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CanComplainInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "complain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CheckInbox", + Type = "Function", + + }, + { + Name = "ClearSendMail", + Type = "Function", + + }, + { + Name = "ClickSendMailItemButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "autoReturn", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "CloseMail", + Type = "Function", + + }, + { + Name = "ComplainInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "complain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeleteInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetInboxHeaderInfo", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "packageIcon", Type = "string", Nilable = false }, + { Name = "stationeryIcon", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "subject", Type = "string", Nilable = false }, + { Name = "money", Type = "number", Nilable = false }, + { Name = "CODAmount", Type = "number", Nilable = false }, + { Name = "daysLeft", Type = "number", Nilable = false }, + { Name = "itemCount", Type = "number", Nilable = false }, + { Name = "wasRead", Type = "bool", Nilable = false }, + { Name = "wasReturned", Type = "bool", Nilable = false }, + { Name = "textCreated", Type = "bool", Nilable = false }, + { Name = "canReply", Type = "bool", Nilable = false }, + { Name = "isGM", Type = "bool", Nilable = false }, + { Name = "itemQuantity", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInboxInvoiceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "invoiceType", Type = "string", Nilable = false }, + { Name = "itemName", Type = "string", Nilable = false }, + { Name = "playerName", Type = "string", Nilable = false }, + { Name = "bid", Type = "number", Nilable = false }, + { Name = "buyout", Type = "number", Nilable = false }, + { Name = "deposit", Type = "number", Nilable = false }, + { Name = "consignment", Type = "number", Nilable = false }, + { Name = "moneyDelay", Type = "number", Nilable = false }, + { Name = "etaHour", Type = "number", Nilable = false }, + { Name = "etaMin", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + { Name = "attachmentIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "itemTexture", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "canUse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetInboxItemLink", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + { Name = "attachmentIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "itemlink", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetInboxNumItems", + Type = "Function", + + Returns = + { + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "totalItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInboxText", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "bodyText", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "isTakeable", Type = "bool", Nilable = false }, + { Name = "isInvoice", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetLatestThreeSenders", + Type = "Function", + + Returns = + { + { Name = "sender1", Type = "string", Nilable = false }, + { Name = "sender2", Type = "string", Nilable = false }, + { Name = "sender3", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumPackages", + Type = "Function", + + }, + { + Name = "GetNumStationeries", + Type = "Function", + + Returns = + { + { Name = "numStationeries", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPackageInfo", + Type = "Function", + + }, + { + Name = "GetSelectedStationeryTexture", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetSendMailCOD", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSendMailItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemName", Type = "string", Nilable = false }, + { Name = "itemTexture", Type = "string", Nilable = false }, + { Name = "stackCount", Type = "string", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + }, + }, + { + Name = "GetSendMailItemLink", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemlink", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetSendMailMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSendMailPrice", + Type = "Function", + + Returns = + { + { Name = "price", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStationeryInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasNewMail", + Type = "Function", + + Returns = + { + { Name = "hasMail", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InboxItemCanDelete", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canDelete", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReturnInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SelectPackage", + Type = "Function", + + }, + { + Name = "SelectStationery", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SendMail", + Type = "Function", + + }, + { + Name = "SetSendMailCOD", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetSendMailMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetSendMailShowing", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TakeInboxItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + { Name = "attachmentIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "TakeInboxMoney", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "TakeInboxTextItem", + Type = "Function", + + Arguments = + { + { Name = "mailID", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "MailClosed", + Type = "Event", + LiteralName = "MAIL_CLOSED", + }, + { + Name = "MailFailed", + Type = "Event", + LiteralName = "MAIL_FAILED", + }, + { + Name = "MailInboxUpdate", + Type = "Event", + LiteralName = "MAIL_INBOX_UPDATE", + }, + { + Name = "MailSendInfoUpdate", + Type = "Event", + LiteralName = "MAIL_SEND_INFO_UPDATE", + }, + { + Name = "MailSendSuccess", + Type = "Event", + LiteralName = "MAIL_SEND_SUCCESS", + }, + { + Name = "MailShow", + Type = "Event", + LiteralName = "MAIL_SHOW", + }, + { + Name = "MailSuccess", + Type = "Event", + LiteralName = "MAIL_SUCCESS", + }, + { + Name = "SendMailCodChanged", + Type = "Event", + LiteralName = "SEND_MAIL_COD_CHANGED", + }, + { + Name = "UpdatePendingMail", + Type = "Event", + LiteralName = "UPDATE_PENDING_MAIL", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Mail); diff --git a/APIDocumentation/Documentation/MailInfoDocumentation.lua b/APIDocumentation/Documentation/MailInfoDocumentation.lua deleted file mode 100644 index 26c7052..0000000 --- a/APIDocumentation/Documentation/MailInfoDocumentation.lua +++ /dev/null @@ -1,125 +0,0 @@ -local MailInfo = -{ - Name = "MailInfo", - Type = "System", - Namespace = "C_Mail", - - Functions = - { - { - Name = "HasInboxMoney", - Type = "Function", - - 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 }, - }, - }, - }, - - Events = - { - { - Name = "CloseInboxItem", - Type = "Event", - LiteralName = "CLOSE_INBOX_ITEM", - Payload = - { - { Name = "mailIndex", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "MailClosed", - Type = "Event", - LiteralName = "MAIL_CLOSED", - }, - { - Name = "MailFailed", - Type = "Event", - LiteralName = "MAIL_FAILED", - Payload = - { - { Name = "itemID", Type = "number", Nilable = true }, - }, - }, - { - Name = "MailInboxUpdate", - Type = "Event", - LiteralName = "MAIL_INBOX_UPDATE", - }, - { - Name = "MailLockSendItems", - Type = "Event", - LiteralName = "MAIL_LOCK_SEND_ITEMS", - Payload = - { - { Name = "attachSlot", Type = "luaIndex", Nilable = false }, - { Name = "itemLink", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "MailSendInfoUpdate", - Type = "Event", - LiteralName = "MAIL_SEND_INFO_UPDATE", - }, - { - Name = "MailSendSuccess", - Type = "Event", - LiteralName = "MAIL_SEND_SUCCESS", - }, - { - Name = "MailShow", - Type = "Event", - LiteralName = "MAIL_SHOW", - }, - { - Name = "MailSuccess", - Type = "Event", - LiteralName = "MAIL_SUCCESS", - Payload = - { - { Name = "itemID", Type = "number", Nilable = true }, - }, - }, - { - Name = "MailUnlockSendItems", - Type = "Event", - LiteralName = "MAIL_UNLOCK_SEND_ITEMS", - }, - { - Name = "SendMailCodChanged", - Type = "Event", - LiteralName = "SEND_MAIL_COD_CHANGED", - }, - { - Name = "SendMailMoneyChanged", - Type = "Event", - LiteralName = "SEND_MAIL_MONEY_CHANGED", - }, - { - Name = "UpdatePendingMail", - Type = "Event", - LiteralName = "UPDATE_PENDING_MAIL", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(MailInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/MapConstantsDocumentation.lua b/APIDocumentation/Documentation/MapConstantsDocumentation.lua deleted file mode 100644 index 6e235e6..0000000 --- a/APIDocumentation/Documentation/MapConstantsDocumentation.lua +++ /dev/null @@ -1,82 +0,0 @@ -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 = "UIMapFlag", - Type = "Enumeration", - NumValues = 18, - MinValue = 1, - MaxValue = 131072, - 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 = "Deprecated", 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 = "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/APIDocumentation/Documentation/MapDocumentation.lua b/APIDocumentation/Documentation/MapDocumentation.lua index 8eea464..104b27c 100644 --- a/APIDocumentation/Documentation/MapDocumentation.lua +++ b/APIDocumentation/Documentation/MapDocumentation.lua @@ -1,461 +1,263 @@ local Map = { - Name = "MapUI", + Name = "Map", Type = "System", - Namespace = "C_Map", + Namespace = "Map", Functions = { { - Name = "GetAreaInfo", + Name = "ClickLandmark", Type = "Function", Arguments = + { + { Name = "mapLinkID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetCorpseMapPosition", + Type = "Function", + + Returns = + { + { Name = "corpseX", Type = "number", Nilable = false }, + { Name = "corpseY", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentMapAreaID", + Type = "Function", + + Returns = { { Name = "areaID", Type = "number", Nilable = false }, }, - - Returns = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, }, { - Name = "GetBestMapForUnit", - Type = "Function", - Documentation = { "Only works for the player and party members." }, - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "uiMapID", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetBountySetIDForMap", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "bountySetID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetFallbackWorldMapID", + Name = "GetCurrentMapContinent", Type = "Function", Returns = { - { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "continent", Type = "number", Nilable = false }, }, }, { - Name = "GetMapArtBackgroundAtlas", + Name = "GetCurrentMapDungeonLevel", Type = "Function", - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - Returns = { - { Name = "atlasName", Type = "textureAtlas", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, }, }, { - Name = "GetMapArtHelpTextPosition", + Name = "GetCurrentMapZone", Type = "Function", - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - Returns = { - { Name = "position", Type = "MapCanvasPosition", Nilable = false }, + { Name = "zone", Type = "number", Nilable = false }, }, }, { - Name = "GetMapArtID", + Name = "GetDeathReleasePosition", Type = "Function", - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - Returns = { - { Name = "uiMapArtID", Type = "number", Nilable = false }, + { Name = "graveyardX", Type = "number", Nilable = false }, + { Name = "graveyardY", Type = "number", Nilable = false }, }, }, { - Name = "GetMapArtLayerTextures", + Name = "GetMapContinents", Type = "Function", - 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", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "layerInfo", Type = "table", InnerType = "UiMapLayerInfo", Nilable = false }, - }, - }, - { - Name = "GetMapBannersForMap", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "mapBanners", Type = "table", InnerType = "MapBannerInfo", Nilable = false }, - }, - }, - { - Name = "GetMapChildrenInfo", - Type = "Function", - - 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", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hideIcons", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetMapGroupID", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "uiMapGroupID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetMapGroupMembersInfo", - Type = "Function", - - Arguments = - { - { Name = "uiMapGroupID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "table", InnerType = "UiMapGroupMemberInfo", Nilable = false }, - }, - }, - { - Name = "GetMapHighlightInfoAtPosition", - Type = "Function", - - 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 = "...", Type = "list", Nilable = false }, }, }, { Name = "GetMapInfo", Type = "Function", - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "UiMapDetails", Nilable = false }, - }, }, { - Name = "GetMapInfoAtPosition", + Name = "GetMapLandmarkInfo", Type = "Function", Arguments = { - { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "textureIndex", Type = "luaIndex", 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 = "mapLinkID", Type = "number", Nilable = false }, + { Name = "showInBattleMap", Type = "bool", Nilable = false }, }, }, { - Name = "GetMapLevels", + Name = "GetMapOverlayInfo", Type = "Function", Arguments = { - { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", 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 = "textureName", Type = "string", Nilable = false }, + { 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 = "mapPointX", Type = "number", Nilable = false }, + { Name = "mapPointY", Type = "number", Nilable = false }, }, }, { - Name = "GetMapLinksForMap", + Name = "GetMapZones", Type = "Function", Arguments = { - { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "continentIndex", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "mapLinks", Type = "table", InnerType = "MapLinkInfo", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, }, }, { - Name = "GetMapPosFromWorldPos", + Name = "GetNumBattlefieldVehicles", Type = "Function", - 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 = "numVehicles", Type = "number", Nilable = false }, }, }, { - Name = "GetMapRectOnMap", + Name = "GetNumDungeonMapLevels", Type = "Function", - 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 = "numLevels", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMapLandmarks", + Type = "Function", + + Returns = + { + { Name = "numLandmarks", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumMapOverlays", + Type = "Function", + + Returns = + { + { Name = "numOverlays", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerFacing", + Type = "Function", + + Returns = + { + { Name = "facing", Type = "number", Nilable = false }, }, }, { Name = "GetPlayerMapPosition", Type = "Function", - Documentation = { "Only works for the player and party members." }, Arguments = { - { Name = "uiMapID", Type = "number", Nilable = false }, - { Name = "unitToken", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, }, Returns = { - { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + { Name = "unitX", Type = "UnitToken", Nilable = false }, + { Name = "unitY", Type = "UnitToken", Nilable = false }, }, }, { - Name = "GetWorldPosFromMapPos", + Name = "InitWorldMapPing", + Type = "Function", + + }, + { + Name = "ProcessMapClick", Type = "Function", Arguments = { - { Name = "uiMapID", Type = "number", Nilable = false }, - { Name = "mapPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "clickX", Type = "number", Nilable = false }, + { Name = "clickY", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetDungeonMapLevel", + Type = "Function", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetMapToCurrentZone", + Type = "Function", + + }, + { + Name = "SetMapZoom", + Type = "Function", + + Arguments = + { + { Name = "continentIndex", Type = "luaIndex", Nilable = false }, + { Name = "zoneIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "UpdateMapHighlight", + Type = "Function", + + Arguments = + { + { Name = "cursorX", Type = "number", Nilable = false }, + { Name = "cursorY", Type = "number", Nilable = false }, }, Returns = { - { Name = "continentID", Type = "number", Nilable = false }, - { Name = "worldPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - }, - }, - { - Name = "MapHasArt", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasArt", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RequestPreloadMap", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "NewWmoChunk", - Type = "Event", - LiteralName = "NEW_WMO_CHUNK", - }, - { - Name = "ZoneChanged", - Type = "Event", - LiteralName = "ZONE_CHANGED", - }, - { - Name = "ZoneChangedIndoors", - Type = "Event", - LiteralName = "ZONE_CHANGED_INDOORS", - }, - { - Name = "ZoneChangedNewArea", - Type = "Event", - LiteralName = "ZONE_CHANGED_NEW_AREA", - }, - }, - - 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 = "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 = "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 = "name", Type = "string", Nilable = false }, + { Name = "fileName", Type = "string", Nilable = false }, + { Name = "texCoordX", Type = "number", Nilable = false }, + { Name = "texCoordY", Type = "number", Nilable = false }, { Name = "textureX", Type = "number", Nilable = false }, { Name = "textureY", Type = "number", Nilable = false }, { Name = "scrollChildX", Type = "number", Nilable = false }, @@ -463,20 +265,65 @@ local Map = }, }, { - Name = "UiMapLayerInfo", - Type = "Structure", - Fields = + Name = "ZoomOut", + Type = "Function", + + Arguments = { - { 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 }, + { Name = "distance", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "CloseWorldMap", + Type = "Event", + LiteralName = "CLOSE_WORLD_MAP", + }, + { + Name = "MinimapPing", + Type = "Event", + LiteralName = "MINIMAP_PING", + Payload = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, }, }, + { + Name = "MinimapUpdateZoom", + Type = "Event", + LiteralName = "MINIMAP_UPDATE_ZOOM", + }, + { + Name = "TaximapClosed", + Type = "Event", + LiteralName = "TAXIMAP_CLOSED", + }, + { + Name = "TaximapOpened", + Type = "Event", + LiteralName = "TAXIMAP_OPENED", + }, + { + Name = "WorldMapNameUpdate", + Type = "Event", + LiteralName = "WORLD_MAP_NAME_UPDATE", + }, + { + Name = "WorldMapUpdate", + Type = "Event", + LiteralName = "WORLD_MAP_UPDATE", + }, + }, + + Tables = + { }, }; -APIDocumentation:AddDocumentationTable(Map); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Map); diff --git a/APIDocumentation/Documentation/MapExplorationDocumentation.lua b/APIDocumentation/Documentation/MapExplorationDocumentation.lua deleted file mode 100644 index 1b22bf4..0000000 --- a/APIDocumentation/Documentation/MapExplorationDocumentation.lua +++ /dev/null @@ -1,80 +0,0 @@ -local MapExploration = -{ - Name = "MapExplorationInfo", - Type = "System", - Namespace = "C_MapExplorationInfo", - - Functions = - { - { - Name = "GetExploredAreaIDsAtPosition", - Type = "Function", - - 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", - - 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", - }, - }, - - 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/APIDocumentation/Documentation/MerchantDocumentation.lua b/APIDocumentation/Documentation/MerchantDocumentation.lua new file mode 100644 index 0000000..57fb12a --- /dev/null +++ b/APIDocumentation/Documentation/MerchantDocumentation.lua @@ -0,0 +1,325 @@ +local Merchant = +{ + Name = "Merchant", + Type = "System", + Namespace = "Merchant", + + Functions = + { + { + Name = "BuyMerchantItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + }, + + }, + { + Name = "BuybackItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CanMerchantRepair", + Type = "Function", + + Returns = + { + { Name = "canRepair", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseMerchant", + Type = "Function", + + }, + { + Name = "ContainerRefundItemPurchase", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EndBoundTradeable", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "EndRefund", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetBuybackItemInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "price", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "numAvailable", Type = "number", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetBuybackItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseInfo", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "IsEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + { Name = "itemCount", Type = "number", Nilable = false }, + { Name = "refundSec", Type = "number", Nilable = false }, + { Name = "currecycount", Type = "number", Nilable = false }, + { Name = "hasEnchants", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseItem", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "link", Type = "itemLink", Nilable = false }, + }, + }, + { + Name = "GetMerchantItemCostInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "currencyCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMerchantItemCostItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "currency", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + { Name = "link", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMerchantItemInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "price", Type = "number", Nilable = false }, + { Name = "quantity", Type = "number", Nilable = false }, + { Name = "numAvailable", Type = "number", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "extendedCost", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetMerchantItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetMerchantItemMaxStack", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "maxStack", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMerchantNumItems", + Type = "Function", + + Returns = + { + { Name = "numMerchantItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumBuybackItems", + Type = "Function", + + Returns = + { + { Name = "numBuybackItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRepairAllCost", + Type = "Function", + + Returns = + { + { Name = "repairAllCost", Type = "number", Nilable = false }, + { Name = "canRepair", Type = "bool", Nilable = false }, + }, + }, + { + Name = "InRepairMode", + Type = "Function", + + Returns = + { + { Name = "inRepair", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupMerchantItem", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "RepairAllItems", + Type = "Function", + + Arguments = + { + { Name = "useGuildMoney", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "ShowContainerSellCursor", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ShowRepairCursor", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "MerchantClosed", + Type = "Event", + LiteralName = "MERCHANT_CLOSED", + }, + { + Name = "MerchantShow", + Type = "Event", + LiteralName = "MERCHANT_SHOW", + }, + { + Name = "MerchantUpdate", + Type = "Event", + LiteralName = "MERCHANT_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Merchant); diff --git a/APIDocumentation/Documentation/MerchantFrameDocumentation.lua b/APIDocumentation/Documentation/MerchantFrameDocumentation.lua deleted file mode 100644 index ba2681d..0000000 --- a/APIDocumentation/Documentation/MerchantFrameDocumentation.lua +++ /dev/null @@ -1,58 +0,0 @@ -local MerchantFrame = -{ - Name = "MerchantFrame", - Type = "System", - Namespace = "C_MerchantFrame", - - Functions = - { - { - Name = "GetBuybackItemID", - Type = "Function", - - Arguments = - { - { Name = "buybackSlotIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "buybackItemID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "MerchantClosed", - Type = "Event", - LiteralName = "MERCHANT_CLOSED", - }, - { - Name = "MerchantFilterItemUpdate", - Type = "Event", - LiteralName = "MERCHANT_FILTER_ITEM_UPDATE", - Payload = - { - { Name = "itemID", Type = "number", Nilable = false }, - }, - }, - { - Name = "MerchantShow", - Type = "Event", - LiteralName = "MERCHANT_SHOW", - }, - { - Name = "MerchantUpdate", - Type = "Event", - LiteralName = "MERCHANT_UPDATE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(MerchantFrame); \ No newline at end of file diff --git a/APIDocumentation/Documentation/MinigameDocumentation.lua b/APIDocumentation/Documentation/MinigameDocumentation.lua new file mode 100644 index 0000000..3da8f4b --- /dev/null +++ b/APIDocumentation/Documentation/MinigameDocumentation.lua @@ -0,0 +1,45 @@ +local Minigame = +{ + Name = "Minigame", + Type = "System", + Namespace = "Minigame", + + Functions = + { + { + Name = "GetMinigameState", + Type = "Function", + + }, + { + Name = "GetMinigameType", + Type = "Function", + + }, + { + Name = "MakeMinigameMove", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "MinigameUpdate", + Type = "Event", + LiteralName = "MINIGAME_UPDATE", + }, + { + Name = "StartMinigame", + Type = "Event", + LiteralName = "START_MINIGAME", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Minigame); diff --git a/APIDocumentation/Documentation/MinimapConstantsDocumentation.lua b/APIDocumentation/Documentation/MinimapConstantsDocumentation.lua deleted file mode 100644 index b325630..0000000 --- a/APIDocumentation/Documentation/MinimapConstantsDocumentation.lua +++ /dev/null @@ -1,40 +0,0 @@ -local MinimapConstants = -{ - Tables = - { - { - Name = "MinimapTrackingFilter", - Type = "Enumeration", - NumValues = 22, - MinValue = 0, - MaxValue = 1048576, - 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 = "TrainerClass", Type = "MinimapTrackingFilter", EnumValue = 262144 }, - { Name = "VendorAmmo", Type = "MinimapTrackingFilter", EnumValue = 524288 }, - { Name = "VendorPoison", Type = "MinimapTrackingFilter", EnumValue = 1048576 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(MinimapConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/MinimapDocumentation.lua b/APIDocumentation/Documentation/MinimapDocumentation.lua deleted file mode 100644 index ca07471..0000000 --- a/APIDocumentation/Documentation/MinimapDocumentation.lua +++ /dev/null @@ -1,139 +0,0 @@ -local Minimap = -{ - Name = "Minimap", - Type = "System", - Namespace = "C_Minimap", - - Functions = - { - { - Name = "ClearAllTracking", - Type = "Function", - }, - { - Name = "GetNumTrackingTypes", - Type = "Function", - - Returns = - { - { Name = "numTrackingTypes", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetObjectIconTextureCoords", - Type = "Function", - - 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", - - 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 = "GetTrackingInfo", - Type = "Function", - - Arguments = - { - { Name = "spellIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "textureFileID", 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 }, - }, - }, - { - Name = "SetTracking", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - { Name = "on", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "MinimapPing", - Type = "Event", - LiteralName = "MINIMAP_PING", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "y", Type = "number", Nilable = false }, - { Name = "x", Type = "number", Nilable = false }, - }, - }, - { - Name = "MinimapUpdateTracking", - Type = "Event", - LiteralName = "MINIMAP_UPDATE_TRACKING", - }, - { - Name = "MinimapUpdateZoom", - Type = "Event", - LiteralName = "MINIMAP_UPDATE_ZOOM", - }, - }, - - 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 = "textureFileID", 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/APIDocumentation/Documentation/MinimapFrameAPIDocumentation.lua b/APIDocumentation/Documentation/MinimapFrameAPIDocumentation.lua deleted file mode 100644 index e38561b..0000000 --- a/APIDocumentation/Documentation/MinimapFrameAPIDocumentation.lua +++ /dev/null @@ -1,149 +0,0 @@ -local MinimapFrameAPI = -{ - Name = "MinimapFrameAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "locationX", Type = "number", Nilable = false }, - { Name = "locationY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetBlipTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetCorpsePOIArrowTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetIconTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetMaskTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetPOIArrowTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetPlayerTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetStaticPOIArrowTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetZoom", - Type = "Function", - - 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/APIDocumentation/Documentation/ModelSceneDocumentation.lua b/APIDocumentation/Documentation/ModelSceneDocumentation.lua deleted file mode 100644 index c30a462..0000000 --- a/APIDocumentation/Documentation/ModelSceneDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local ModelScene = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ModelScene); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ModifiedClickDocumentation.lua b/APIDocumentation/Documentation/ModifiedClickDocumentation.lua new file mode 100644 index 0000000..e57a749 --- /dev/null +++ b/APIDocumentation/Documentation/ModifiedClickDocumentation.lua @@ -0,0 +1,82 @@ +local ModifiedClick = +{ + Name = "Modified Click", + Type = "System", + Namespace = "Modified Click", + + Functions = + { + { + Name = "GetModifiedClick", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "binding", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetModifiedClickAction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "action", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumModifiedClickActions", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsModifiedClick", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "modifiedClick", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetModifiedClick", + Type = "Function", + + Arguments = + { + { Name = "action", Type = "string", Nilable = false }, + { Name = "binding", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ModifiedClick); diff --git a/APIDocumentation/Documentation/MoneyDocumentation.lua b/APIDocumentation/Documentation/MoneyDocumentation.lua new file mode 100644 index 0000000..49cb8fb --- /dev/null +++ b/APIDocumentation/Documentation/MoneyDocumentation.lua @@ -0,0 +1,267 @@ +local Money = +{ + Name = "Money", + Type = "System", + Namespace = "Money", + + Functions = + { + { + Name = "AddTradeMoney", + Type = "Function", + + }, + { + Name = "CanWithdrawGuildBankMoney", + Type = "Function", + + Returns = + { + { Name = "canWithdraw", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CursorHasMoney", + Type = "Function", + + Returns = + { + { Name = "hasMoney", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DepositGuildBankMoney", + Type = "Function", + + Arguments = + { + { Name = "money", Type = "number", Nilable = false }, + }, + + }, + { + Name = "DropCursorMoney", + Type = "Function", + + }, + { + Name = "GetCoinIcon", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetCoinText", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + { Name = "separator", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "coinText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetCoinTextureString", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + { Name = "fontSize", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "coinText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetCursorMoney", + Type = "Function", + + Returns = + { + { Name = "cursorMoney", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMoney", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerTradeMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRequiredMoney", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardMoney", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSendMailMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTargetTradeMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "PickupGuildBankMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupPlayerMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "PickupTradeMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetSendMailMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetTradeMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "WithdrawGuildBankMoney", + Type = "Function", + + Returns = + { + { Name = "canWithdraw", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ChatMsgMoney", + Type = "Event", + LiteralName = "CHAT_MSG_MONEY", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerMoney", + Type = "Event", + LiteralName = "PLAYER_MONEY", + }, + { + Name = "PlayerTradeMoney", + Type = "Event", + LiteralName = "PLAYER_TRADE_MONEY", + }, + { + Name = "SendMailMoneyChanged", + Type = "Event", + LiteralName = "SEND_MAIL_MONEY_CHANGED", + }, + { + Name = "TradeMoneyChanged", + Type = "Event", + LiteralName = "TRADE_MONEY_CHANGED", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Money); diff --git a/APIDocumentation/Documentation/MovementDocumentation.lua b/APIDocumentation/Documentation/MovementDocumentation.lua new file mode 100644 index 0000000..47b35cb --- /dev/null +++ b/APIDocumentation/Documentation/MovementDocumentation.lua @@ -0,0 +1,186 @@ +local Movement = +{ + Name = "Movement", + Type = "System", + Namespace = "Movement", + + Functions = + { + { + Name = "AscendStop", + Type = "Function", + + }, + { + Name = "DescendStop", + Type = "Function", + + }, + { + Name = "FollowUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "strict", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "InteractUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + }, + { + Name = "JumpOrAscendStart", + Type = "Function", + + }, + { + Name = "MoveAndSteerStart", + Type = "Function", + + }, + { + Name = "MoveAndSteerStop", + Type = "Function", + + }, + { + Name = "MoveBackwardStart", + Type = "Function", + + }, + { + Name = "MoveBackwardStop", + Type = "Function", + + }, + { + Name = "MoveForwardStart", + Type = "Function", + + }, + { + Name = "MoveForwardStop", + Type = "Function", + + }, + { + Name = "PitchDownStart", + Type = "Function", + + }, + { + Name = "PitchDownStop", + Type = "Function", + + }, + { + Name = "PitchUpStart", + Type = "Function", + + }, + { + Name = "PitchUpStop", + Type = "Function", + + }, + { + Name = "SitStandOrDescendStart", + Type = "Function", + + }, + { + Name = "StrafeLeftStart", + Type = "Function", + + }, + { + Name = "StrafeLeftStop", + Type = "Function", + + }, + { + Name = "StrafeRightStart", + Type = "Function", + + }, + { + Name = "StrafeRightStop", + Type = "Function", + + }, + { + Name = "ToggleAutoRun", + Type = "Function", + + }, + { + Name = "ToggleRun", + Type = "Function", + + }, + { + Name = "TurnLeftStart", + Type = "Function", + + }, + { + Name = "TurnLeftStop", + Type = "Function", + + }, + { + Name = "TurnOrActionStart", + Type = "Function", + + }, + { + Name = "TurnOrActionStop", + Type = "Function", + + }, + { + Name = "TurnRightStart", + Type = "Function", + + }, + { + Name = "TurnRightStop", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "AutofollowBegin", + Type = "Event", + LiteralName = "AUTOFOLLOW_BEGIN", + Payload = + { + { Name = "following", Type = "number", Nilable = false }, + }, + }, + { + Name = "AutofollowEnd", + Type = "Event", + LiteralName = "AUTOFOLLOW_END", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Movement); diff --git a/APIDocumentation/Documentation/MovieDocumentation.lua b/APIDocumentation/Documentation/MovieDocumentation.lua deleted file mode 100644 index 1cd074a..0000000 --- a/APIDocumentation/Documentation/MovieDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Movie = -{ - Name = "Movie", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Movie); \ No newline at end of file diff --git a/APIDocumentation/Documentation/MultiCastActionsDocumentation.lua b/APIDocumentation/Documentation/MultiCastActionsDocumentation.lua new file mode 100644 index 0000000..7b152e9 --- /dev/null +++ b/APIDocumentation/Documentation/MultiCastActionsDocumentation.lua @@ -0,0 +1,31 @@ +local MultiCastActions = +{ + Name = "MultiCast Actions", + Type = "System", + Namespace = "MultiCast Actions", + + Functions = + { + { + Name = "SetMultiCastSpell", + Type = "Function", + + Arguments = + { + { Name = "action", Type = "number", Nilable = false }, + { Name = "spell", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(MultiCastActions); diff --git a/APIDocumentation/Documentation/NamePlateDocumentation.lua b/APIDocumentation/Documentation/NamePlateDocumentation.lua deleted file mode 100644 index d8082ca..0000000 --- a/APIDocumentation/Documentation/NamePlateDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local NamePlate = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(NamePlate); \ No newline at end of file diff --git a/APIDocumentation/Documentation/NamePlateManagerDocumentation.lua b/APIDocumentation/Documentation/NamePlateManagerDocumentation.lua deleted file mode 100644 index 3dda698..0000000 --- a/APIDocumentation/Documentation/NamePlateManagerDocumentation.lua +++ /dev/null @@ -1,74 +0,0 @@ -local NamePlateManager = -{ - Name = "NamePlateManager", - Type = "System", - Namespace = "C_NamePlateManager", - - Functions = - { - }, - - Events = - { - { - Name = "ForbiddenNamePlateCreated", - Type = "Event", - LiteralName = "FORBIDDEN_NAME_PLATE_CREATED", - Payload = - { - { Name = "namePlateFrame", Type = "NamePlateFrame", Nilable = false }, - }, - }, - { - Name = "ForbiddenNamePlateUnitAdded", - Type = "Event", - LiteralName = "FORBIDDEN_NAME_PLATE_UNIT_ADDED", - Payload = - { - { Name = "unitToken", Type = "string", Nilable = false }, - }, - }, - { - Name = "ForbiddenNamePlateUnitRemoved", - Type = "Event", - LiteralName = "FORBIDDEN_NAME_PLATE_UNIT_REMOVED", - Payload = - { - { Name = "unitToken", Type = "string", Nilable = false }, - }, - }, - { - Name = "NamePlateCreated", - Type = "Event", - LiteralName = "NAME_PLATE_CREATED", - Payload = - { - { Name = "namePlateFrame", Type = "NamePlateFrame", Nilable = false }, - }, - }, - { - Name = "NamePlateUnitAdded", - Type = "Event", - LiteralName = "NAME_PLATE_UNIT_ADDED", - Payload = - { - { Name = "unitToken", Type = "string", Nilable = false }, - }, - }, - { - Name = "NamePlateUnitRemoved", - Type = "Event", - LiteralName = "NAME_PLATE_UNIT_REMOVED", - Payload = - { - { Name = "unitToken", Type = "string", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(NamePlateManager); \ No newline at end of file diff --git a/APIDocumentation/Documentation/NewItemsDocumentation.lua b/APIDocumentation/Documentation/NewItemsDocumentation.lua deleted file mode 100644 index 5c6ac52..0000000 --- a/APIDocumentation/Documentation/NewItemsDocumentation.lua +++ /dev/null @@ -1,49 +0,0 @@ -local NewItems = -{ - Name = "NewItems", - Type = "System", - Namespace = "C_NewItems", - - Functions = - { - { - Name = "ClearAll", - Type = "Function", - }, - { - Name = "IsNewItem", - Type = "Function", - - Arguments = - { - { Name = "containerIndex", Type = "BagIndex", Nilable = false }, - { Name = "slotIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isNew", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RemoveNewItem", - Type = "Function", - - 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/APIDocumentation/Documentation/NpcGossipDialogDocumentation.lua b/APIDocumentation/Documentation/NpcGossipDialogDocumentation.lua new file mode 100644 index 0000000..34aa7bf --- /dev/null +++ b/APIDocumentation/Documentation/NpcGossipDialogDocumentation.lua @@ -0,0 +1,165 @@ +local NpcGossipDialog = +{ + Name = "NPC Gossip Dialog", + Type = "System", + Namespace = "NPC Gossip Dialog", + + Functions = + { + { + Name = "CloseGossip", + Type = "Function", + + }, + { + Name = "GetGossipActiveQuests", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "isTrivial", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetGossipAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "isTrivial", Type = "bool", Nilable = false }, + { Name = "isDaily", Type = "bool", Nilable = false }, + { Name = "isRepeatable", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetGossipOptions", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "gossipType", Type = "string", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetGossipText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumGossipActiveQuests", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGossipAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGossipOptions", + Type = "Function", + + Returns = + { + { Name = "numOptions", Type = "number", Nilable = false }, + }, + }, + { + Name = "SelectGossipActiveQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectGossipAvailableQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectGossipOption", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "confirm", Type = "bool", Nilable = true }, + }, + + }, + }, + + Events = + { + { + Name = "GossipClosed", + Type = "Event", + LiteralName = "GOSSIP_CLOSED", + }, + { + Name = "GossipConfirm", + Type = "Event", + LiteralName = "GOSSIP_CONFIRM", + Payload = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "message", Type = "string", Nilable = false }, + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GossipConfirmCancel", + Type = "Event", + LiteralName = "GOSSIP_CONFIRM_CANCEL", + }, + { + Name = "GossipEnterCode", + Type = "Event", + LiteralName = "GOSSIP_ENTER_CODE", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "GossipShow", + Type = "Event", + LiteralName = "GOSSIP_SHOW", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(NpcGossipDialog); diff --git a/APIDocumentation/Documentation/ObjectivesTrackingDocumentation.lua b/APIDocumentation/Documentation/ObjectivesTrackingDocumentation.lua new file mode 100644 index 0000000..0099002 --- /dev/null +++ b/APIDocumentation/Documentation/ObjectivesTrackingDocumentation.lua @@ -0,0 +1,185 @@ +local ObjectivesTracking = +{ + Name = "Objectives Tracking", + Type = "System", + Namespace = "Objectives Tracking", + + Functions = + { + { + Name = "AddQuestWatch", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "AddTrackedAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetNumQuestWatches", + Type = "Function", + + Returns = + { + { Name = "numWatches", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTrackedAchievements", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestIndexForWatch", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSpecialItemCooldown", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSpecialItemInfo", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "charges", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrackedAchievements", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "IsQuestLogSpecialItemInRange", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inRange", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsQuestWatched", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isWatched", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTrackedAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isTracked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveQuestWatch", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "RemoveTrackedAchievement", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "UseQuestLogSpecialItem", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ObjectivesTracking); diff --git a/APIDocumentation/Documentation/OsDocumentation.lua b/APIDocumentation/Documentation/OsDocumentation.lua deleted file mode 100644 index 262b409..0000000 --- a/APIDocumentation/Documentation/OsDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Os = -{ - Name = "Os", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Os); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PVPMgrConstantsDocumentation.lua b/APIDocumentation/Documentation/PVPMgrConstantsDocumentation.lua deleted file mode 100644 index 26bec2a..0000000 --- a/APIDocumentation/Documentation/PVPMgrConstantsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local PVPMgrConstants = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(PVPMgrConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PaperDollInfoDocumentation.lua b/APIDocumentation/Documentation/PaperDollInfoDocumentation.lua deleted file mode 100644 index 34b7f82..0000000 --- a/APIDocumentation/Documentation/PaperDollInfoDocumentation.lua +++ /dev/null @@ -1,229 +0,0 @@ -local PaperDollInfo = -{ - Name = "PaperDollInfo", - Type = "System", - Namespace = "C_PaperDollInfo", - - Functions = - { - { - Name = "GetArmorEffectiveness", - Type = "Function", - - Arguments = - { - { Name = "armor", Type = "number", Nilable = false }, - { Name = "attackerLevel", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "effectiveness", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetArmorEffectivenessAgainstTarget", - Type = "Function", - - Arguments = - { - { Name = "armor", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "effectiveness", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetMinItemLevel", - Type = "Function", - - Returns = - { - { Name = "minItemLevel", Type = "number", Nilable = true }, - }, - }, - { - Name = "OffhandHasShield", - Type = "Function", - - Returns = - { - { Name = "offhandHasShield", Type = "bool", Nilable = false }, - }, - }, - { - Name = "OffhandHasWeapon", - Type = "Function", - - Returns = - { - { Name = "offhandHasWeapon", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "ActiveTalentGroupChanged", - Type = "Event", - LiteralName = "ACTIVE_TALENT_GROUP_CHANGED", - Payload = - { - { Name = "changedTo", Type = "number", Nilable = false }, - { Name = "changedFrom", Type = "number", Nilable = false }, - }, - }, - { - Name = "CharacterPointsChanged", - Type = "Event", - LiteralName = "CHARACTER_POINTS_CHANGED", - Payload = - { - { Name = "change", Type = "number", Nilable = false }, - }, - }, - { - Name = "CombatRatingUpdate", - Type = "Event", - LiteralName = "COMBAT_RATING_UPDATE", - }, - { - Name = "DisableXpGain", - Type = "Event", - LiteralName = "DISABLE_XP_GAIN", - }, - { - Name = "EnableXpGain", - Type = "Event", - LiteralName = "ENABLE_XP_GAIN", - }, - { - Name = "EquipBindConfirm", - Type = "Event", - LiteralName = "EQUIP_BIND_CONFIRM", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, - { - Name = "InspectHonorUpdate", - Type = "Event", - LiteralName = "INSPECT_HONOR_UPDATE", - }, - { - Name = "InspectReady", - Type = "Event", - LiteralName = "INSPECT_READY", - Payload = - { - { Name = "inspecteeGUID", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "PetSpellPowerUpdate", - Type = "Event", - LiteralName = "PET_SPELL_POWER_UPDATE", - }, - { - Name = "PetTalentUpdate", - Type = "Event", - LiteralName = "PET_TALENT_UPDATE", - }, - { - Name = "PlayerAvgItemLevelUpdate", - Type = "Event", - LiteralName = "PLAYER_AVG_ITEM_LEVEL_UPDATE", - }, - { - Name = "PlayerEquipmentChanged", - Type = "Event", - LiteralName = "PLAYER_EQUIPMENT_CHANGED", - Payload = - { - { Name = "equipmentSlot", Type = "number", Nilable = false }, - { Name = "hasCurrent", Type = "bool", Nilable = false }, - }, - }, - { - Name = "PlayerTalentUpdate", - Type = "Event", - LiteralName = "PLAYER_TALENT_UPDATE", - }, - { - Name = "PreviewPetTalentPointsChanged", - Type = "Event", - LiteralName = "PREVIEW_PET_TALENT_POINTS_CHANGED", - Payload = - { - { Name = "talentIndex", Type = "number", Nilable = false }, - { Name = "tabIndex", Type = "number", Nilable = false }, - { Name = "groupIndex", Type = "number", Nilable = false }, - { Name = "points", Type = "number", Nilable = false }, - }, - }, - { - Name = "PreviewTalentPointsChanged", - Type = "Event", - LiteralName = "PREVIEW_TALENT_POINTS_CHANGED", - Payload = - { - { Name = "talentIndex", Type = "number", Nilable = false }, - { Name = "tabIndex", Type = "number", Nilable = false }, - { Name = "groupIndex", Type = "number", Nilable = false }, - { Name = "points", Type = "number", Nilable = false }, - }, - }, - { - Name = "SpellPowerChanged", - Type = "Event", - LiteralName = "SPELL_POWER_CHANGED", - }, - { - Name = "TalentGroupRoleChanged", - Type = "Event", - LiteralName = "TALENT_GROUP_ROLE_CHANGED", - Payload = - { - { Name = "groupIndex", Type = "number", Nilable = false }, - { Name = "newRole", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "UpdateFaction", - Type = "Event", - LiteralName = "UPDATE_FACTION", - }, - { - Name = "UpdateInventoryAlerts", - Type = "Event", - LiteralName = "UPDATE_INVENTORY_ALERTS", - }, - { - Name = "UpdateInventoryDurability", - Type = "Event", - LiteralName = "UPDATE_INVENTORY_DURABILITY", - }, - }, - - Tables = - { - { - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(PaperDollInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ParentalControlsDocumentation.lua b/APIDocumentation/Documentation/ParentalControlsDocumentation.lua deleted file mode 100644 index 0c82020..0000000 --- a/APIDocumentation/Documentation/ParentalControlsDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local ParentalControls = -{ - Name = "ParentalControls", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ParentalControls); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PartyDocumentation.lua b/APIDocumentation/Documentation/PartyDocumentation.lua new file mode 100644 index 0000000..45062a0 --- /dev/null +++ b/APIDocumentation/Documentation/PartyDocumentation.lua @@ -0,0 +1,371 @@ +local Party = +{ + Name = "Party", + Type = "System", + Namespace = "Party", + + Functions = + { + { + Name = "AcceptGroup", + Type = "Function", + + }, + { + Name = "ClearPartyAssignment", + Type = "Function", + + Arguments = + { + { Name = "assignment", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "ConfirmReadyCheck", + Type = "Function", + + Arguments = + { + { Name = "ready", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ConvertToRaid", + Type = "Function", + + }, + { + Name = "DeclineGroup", + Type = "Function", + + }, + { + Name = "DoReadyCheck", + Type = "Function", + + }, + { + Name = "GetNumPartyMembers", + Type = "Function", + + Returns = + { + { Name = "numPartyMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPartyAssignment", + Type = "Function", + + Arguments = + { + { Name = "assignment", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "isAssigned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPartyLeaderIndex", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetPartyMember", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "hasMember", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetReadyCheckStatus", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetReadyCheckTimeLeft", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRealNumPartyMembers", + Type = "Function", + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "InviteUnit", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "IsPartyLeader", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRealPartyLeader", + Type = "Function", + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveParty", + Type = "Function", + + }, + { + Name = "PromoteToLeader", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "SetPartyAssignment", + Type = "Function", + + Arguments = + { + { Name = "assignment", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "UninviteUnit", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "UnitInParty", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPartyLeader", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "leader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPlayerOrPetInParty", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inParty", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ChatMsgMonsterParty", + Type = "Event", + LiteralName = "CHAT_MSG_MONSTER_PARTY", + }, + { + Name = "ChatMsgParty", + Type = "Event", + LiteralName = "CHAT_MSG_PARTY", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "ChatMsgPartyLeader", + Type = "Event", + LiteralName = "CHAT_MSG_PARTY_LEADER", + }, + { + Name = "PartyConvertedToRaid", + Type = "Event", + LiteralName = "PARTY_CONVERTED_TO_RAID", + }, + { + Name = "PartyInviteCancel", + Type = "Event", + LiteralName = "PARTY_INVITE_CANCEL", + }, + { + Name = "PartyInviteRequest", + Type = "Event", + LiteralName = "PARTY_INVITE_REQUEST", + Payload = + { + { Name = "sender", Type = "string", Nilable = false }, + }, + }, + { + Name = "PartyLeaderChanged", + Type = "Event", + LiteralName = "PARTY_LEADER_CHANGED", + }, + { + Name = "PartyLfgRestricted", + Type = "Event", + LiteralName = "PARTY_LFG_RESTRICTED", + }, + { + Name = "PartyLootMethodChanged", + Type = "Event", + LiteralName = "PARTY_LOOT_METHOD_CHANGED", + }, + { + Name = "PartyMembersChanged", + Type = "Event", + LiteralName = "PARTY_MEMBERS_CHANGED", + }, + { + Name = "PartyMemberDisable", + Type = "Event", + LiteralName = "PARTY_MEMBER_DISABLE", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "PartyMemberEnable", + Type = "Event", + LiteralName = "PARTY_MEMBER_ENABLE", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "ReadyCheck", + Type = "Event", + LiteralName = "READY_CHECK", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "ReadyCheckConfirm", + Type = "Event", + LiteralName = "READY_CHECK_CONFIRM", + Payload = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "response", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ReadyCheckFinished", + Type = "Event", + LiteralName = "READY_CHECK_FINISHED", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Party); diff --git a/APIDocumentation/Documentation/PartyInfoDocumentation.lua b/APIDocumentation/Documentation/PartyInfoDocumentation.lua deleted file mode 100644 index cce5322..0000000 --- a/APIDocumentation/Documentation/PartyInfoDocumentation.lua +++ /dev/null @@ -1,240 +0,0 @@ -local PartyInfo = -{ - Name = "PartyInfo", - Type = "System", - Namespace = "C_PartyInfo", - - Functions = - { - { - Name = "ConfirmLeaveParty", - Type = "Function", - Documentation = { "Immediately leave the party with no regard for potentially destructive actions" }, - - Arguments = - { - { Name = "category", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetActiveCategories", - Type = "Function", - - Returns = - { - { Name = "categories", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetInviteConfirmationInvalidQueues", - Type = "Function", - - Arguments = - { - { Name = "inviteGUID", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "invalidQueues", Type = "table", InnerType = "QueueSpecificInfo", Nilable = false }, - }, - }, - { - Name = "IsPartyFull", - Type = "Function", - - Arguments = - { - { Name = "category", Type = "number", Nilable = true, Documentation = { "If not provided, the active party is used" } }, - }, - - Returns = - { - { Name = "isFull", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "EnteredDifferentInstanceFromParty", - Type = "Event", - LiteralName = "ENTERED_DIFFERENT_INSTANCE_FROM_PARTY", - }, - { - Name = "GroupFormed", - Type = "Event", - LiteralName = "GROUP_FORMED", - Payload = - { - { Name = "category", Type = "number", Nilable = false }, - { Name = "partyGUID", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "GroupInviteConfirmation", - Type = "Event", - LiteralName = "GROUP_INVITE_CONFIRMATION", - }, - { - Name = "GroupJoined", - Type = "Event", - LiteralName = "GROUP_JOINED", - Payload = - { - { Name = "category", Type = "number", Nilable = false }, - { Name = "partyGUID", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "GroupLeft", - Type = "Event", - LiteralName = "GROUP_LEFT", - Payload = - { - { Name = "category", Type = "number", Nilable = false }, - { Name = "partyGUID", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "GroupRosterUpdate", - Type = "Event", - LiteralName = "GROUP_ROSTER_UPDATE", - }, - { - Name = "InstanceBootStart", - Type = "Event", - LiteralName = "INSTANCE_BOOT_START", - }, - { - Name = "InstanceBootStop", - Type = "Event", - LiteralName = "INSTANCE_BOOT_STOP", - }, - { - Name = "InstanceGroupSizeChanged", - Type = "Event", - LiteralName = "INSTANCE_GROUP_SIZE_CHANGED", - }, - { - Name = "PartyInviteCancel", - Type = "Event", - LiteralName = "PARTY_INVITE_CANCEL", - }, - { - Name = "PartyInviteRequest", - Type = "Event", - LiteralName = "PARTY_INVITE_REQUEST", - 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 = "PartyLeaderChanged", - Type = "Event", - LiteralName = "PARTY_LEADER_CHANGED", - }, - { - Name = "PartyLootMethodChanged", - Type = "Event", - LiteralName = "PARTY_LOOT_METHOD_CHANGED", - }, - { - Name = "PartyMemberDisable", - Type = "Event", - LiteralName = "PARTY_MEMBER_DISABLE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PartyMemberEnable", - Type = "Event", - LiteralName = "PARTY_MEMBER_ENABLE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerDifficultyChanged", - Type = "Event", - LiteralName = "PLAYER_DIFFICULTY_CHANGED", - }, - { - Name = "PlayerRolesAssigned", - Type = "Event", - LiteralName = "PLAYER_ROLES_ASSIGNED", - }, - { - Name = "RaidRosterUpdate", - Type = "Event", - LiteralName = "RAID_ROSTER_UPDATE", - }, - { - Name = "ReadyCheck", - Type = "Event", - LiteralName = "READY_CHECK", - Payload = - { - { Name = "initiatorName", Type = "cstring", Nilable = false }, - { Name = "readyCheckTimeLeft", Type = "time_t", Nilable = false }, - }, - }, - { - Name = "ReadyCheckConfirm", - Type = "Event", - LiteralName = "READY_CHECK_CONFIRM", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "isReady", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ReadyCheckFinished", - Type = "Event", - LiteralName = "READY_CHECK_FINISHED", - Payload = - { - { Name = "preempted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RoleChangedInform", - Type = "Event", - LiteralName = "ROLE_CHANGED_INFORM", - 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", - Payload = - { - { Name = "fromName", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(PartyInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PartyPoseUIDocumentation.lua b/APIDocumentation/Documentation/PartyPoseUIDocumentation.lua deleted file mode 100644 index eb835df..0000000 --- a/APIDocumentation/Documentation/PartyPoseUIDocumentation.lua +++ /dev/null @@ -1,46 +0,0 @@ -local PartyPoseUI = -{ - Name = "PartyPose", - Type = "System", - Namespace = "C_PartyPose", - - Functions = - { - }, - - Events = - { - { - Name = "ShowPartyPoseUI", - Type = "Event", - LiteralName = "SHOW_PARTY_POSE_UI", - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(PartyPoseUI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PerksVendorConstantsDocumentation.lua b/APIDocumentation/Documentation/PerksVendorConstantsDocumentation.lua deleted file mode 100644 index 474973a..0000000 --- a/APIDocumentation/Documentation/PerksVendorConstantsDocumentation.lua +++ /dev/null @@ -1,24 +0,0 @@ -local PerksVendorConstants = -{ - Tables = - { - { - Name = "PerksVendorCategoryType", - Type = "Enumeration", - NumValues = 6, - MinValue = 1, - MaxValue = 8, - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(PerksVendorConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PetBattleConstantsDocumentation.lua b/APIDocumentation/Documentation/PetBattleConstantsDocumentation.lua deleted file mode 100644 index cec09b6..0000000 --- a/APIDocumentation/Documentation/PetBattleConstantsDocumentation.lua +++ /dev/null @@ -1,354 +0,0 @@ -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/APIDocumentation/Documentation/PetDocumentation.lua b/APIDocumentation/Documentation/PetDocumentation.lua new file mode 100644 index 0000000..4da532f --- /dev/null +++ b/APIDocumentation/Documentation/PetDocumentation.lua @@ -0,0 +1,423 @@ +local Pet = +{ + Name = "Pet", + Type = "System", + Namespace = "Pet", + + Functions = + { + { + Name = "CastPetAction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + }, + { + Name = "DestroyTotem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "DisableSpellAutocast", + Type = "Function", + + Arguments = + { + { Name = "spell", Type = "string", Nilable = false }, + }, + + }, + { + Name = "EnableSpellAutocast", + Type = "Function", + + Arguments = + { + { Name = "spell", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GetPetActionCooldown", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetActionInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subtext", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "isToken", Type = "bool", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "autoCastAllowed", Type = "bool", Nilable = false }, + { Name = "autoCastEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPetActionSlotUsable", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "usable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPetActionsUsable", + Type = "Function", + + Returns = + { + { Name = "petActionsUsable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPetExperience", + Type = "Function", + + Returns = + { + { Name = "currXP", Type = "number", Nilable = false }, + { Name = "nextXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetFoodTypes", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetPetIcon", + Type = "Function", + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPetTalentTree", + Type = "Function", + + Returns = + { + { Name = "talent", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPetTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "petTimeRemaining", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTotemInfo", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "haveTotem", Type = "bool", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTotemTimeLeft", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasPetSpells", + Type = "Function", + + Returns = + { + { Name = "hasPetSpells", Type = "bool", Nilable = false }, + { Name = "petType", Type = "string", Nilable = false }, + }, + }, + { + Name = "HasPetUI", + Type = "Function", + + Returns = + { + { Name = "hasPetUI", Type = "bool", Nilable = false }, + { Name = "isHunterPet", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPetAttackActive", + Type = "Function", + + Returns = + { + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetAbandon", + Type = "Function", + + }, + { + Name = "PetAggressiveMode", + Type = "Function", + + }, + { + Name = "PetAttack", + Type = "Function", + + }, + { + Name = "PetCanBeAbandoned", + Type = "Function", + + Returns = + { + { Name = "canAbandon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetCanBeDismissed", + Type = "Function", + + Returns = + { + { Name = "canDismiss", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetCanBeRenamed", + Type = "Function", + + Returns = + { + { Name = "canRename", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetDefensiveMode", + Type = "Function", + + }, + { + Name = "PetDismiss", + Type = "Function", + + }, + { + Name = "PetFollow", + Type = "Function", + + }, + { + Name = "PetHasActionBar", + Type = "Function", + + Returns = + { + { Name = "hasActionBar", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PetPassiveMode", + Type = "Function", + + }, + { + Name = "PetRename", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "genitive", Type = "string", Nilable = false }, + { Name = "dative", Type = "string", Nilable = false }, + { Name = "accusative", Type = "string", Nilable = false }, + { Name = "instrumental", Type = "string", Nilable = false }, + { Name = "prepositional", Type = "string", Nilable = true }, + }, + + }, + { + Name = "PetStopAttack", + Type = "Function", + + }, + { + Name = "PetWait", + Type = "Function", + + }, + { + Name = "PickupPetAction", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "TargetTotem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "TogglePetAutocast", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "LocalplayerPetRenamed", + Type = "Event", + LiteralName = "LOCALPLAYER_PET_RENAMED", + }, + { + Name = "PetAttackStart", + Type = "Event", + LiteralName = "PET_ATTACK_START", + }, + { + Name = "PetAttackStop", + Type = "Event", + LiteralName = "PET_ATTACK_STOP", + }, + { + Name = "PetBarHide", + Type = "Event", + LiteralName = "PET_BAR_HIDE", + }, + { + Name = "PetBarHidegrid", + Type = "Event", + LiteralName = "PET_BAR_HIDEGRID", + }, + { + Name = "PetBarShowgrid", + Type = "Event", + LiteralName = "PET_BAR_SHOWGRID", + }, + { + Name = "PetBarUpdate", + Type = "Event", + LiteralName = "PET_BAR_UPDATE", + }, + { + Name = "PetBarUpdateCooldown", + Type = "Event", + LiteralName = "PET_BAR_UPDATE_COOLDOWN", + }, + { + Name = "PetBarUpdateUsable", + Type = "Event", + LiteralName = "PET_BAR_UPDATE_USABLE", + }, + { + Name = "PetDismissStart", + Type = "Event", + LiteralName = "PET_DISMISS_START", + }, + { + Name = "PetForceNameDeclension", + Type = "Event", + LiteralName = "PET_FORCE_NAME_DECLENSION", + }, + { + Name = "PetRenameable", + Type = "Event", + LiteralName = "PET_RENAMEABLE", + }, + { + Name = "PetUiClose", + Type = "Event", + LiteralName = "PET_UI_CLOSE", + }, + { + Name = "PetUiUpdate", + Type = "Event", + LiteralName = "PET_UI_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Pet); diff --git a/APIDocumentation/Documentation/PetInfoDocumentation.lua b/APIDocumentation/Documentation/PetInfoDocumentation.lua deleted file mode 100644 index 14b2f47..0000000 --- a/APIDocumentation/Documentation/PetInfoDocumentation.lua +++ /dev/null @@ -1,100 +0,0 @@ -local PetInfo = -{ - Name = "PetInfo", - Type = "System", - Namespace = "C_PetInfo", - - Functions = - { - }, - - Events = - { - { - Name = "PetAttackStart", - Type = "Event", - LiteralName = "PET_ATTACK_START", - }, - { - Name = "PetAttackStop", - Type = "Event", - LiteralName = "PET_ATTACK_STOP", - }, - { - Name = "PetBarHidegrid", - Type = "Event", - LiteralName = "PET_BAR_HIDEGRID", - }, - { - Name = "PetBarShowgrid", - Type = "Event", - LiteralName = "PET_BAR_SHOWGRID", - }, - { - Name = "PetBarUpdateCooldown", - Type = "Event", - LiteralName = "PET_BAR_UPDATE_COOLDOWN", - }, - { - Name = "PetDismissStart", - Type = "Event", - LiteralName = "PET_DISMISS_START", - Payload = - { - { Name = "delay", Type = "number", Nilable = false }, - }, - }, - { - Name = "PetForceNameDeclension", - Type = "Event", - LiteralName = "PET_FORCE_NAME_DECLENSION", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - { 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", - }, - { - Name = "RaisedAsGhoul", - Type = "Event", - LiteralName = "RAISED_AS_GHOUL", - }, - { - Name = "UpdatePossessBar", - Type = "Event", - LiteralName = "UPDATE_POSSESS_BAR", - }, - { - Name = "UpdateVehicleActionbar", - Type = "Event", - LiteralName = "UPDATE_VEHICLE_ACTIONBAR", - }, - }, - - 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/APIDocumentation/Documentation/PetJournalInfoDocumentation.lua b/APIDocumentation/Documentation/PetJournalInfoDocumentation.lua deleted file mode 100644 index c069596..0000000 --- a/APIDocumentation/Documentation/PetJournalInfoDocumentation.lua +++ /dev/null @@ -1,39 +0,0 @@ -local PetJournalInfo = -{ - Name = "PetJournalInfo", - Type = "System", - Namespace = "C_PetJournal", - - Functions = - { - }, - - Events = - { - { - Name = "CompanionLearned", - Type = "Event", - LiteralName = "COMPANION_LEARNED", - }, - { - Name = "CompanionUnlearned", - Type = "Event", - LiteralName = "COMPANION_UNLEARNED", - }, - { - Name = "CompanionUpdate", - Type = "Event", - LiteralName = "COMPANION_UPDATE", - Payload = - { - { Name = "companionType", Type = "cstring", Nilable = true }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(PetJournalInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PetScalingConstantsDocumentation.lua b/APIDocumentation/Documentation/PetScalingConstantsDocumentation.lua deleted file mode 100644 index d900a41..0000000 --- a/APIDocumentation/Documentation/PetScalingConstantsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local PetScalingConstants = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(PetScalingConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PetStableDocumentation.lua b/APIDocumentation/Documentation/PetStableDocumentation.lua new file mode 100644 index 0000000..4de5c04 --- /dev/null +++ b/APIDocumentation/Documentation/PetStableDocumentation.lua @@ -0,0 +1,157 @@ +local PetStable = +{ + Name = "Pet Stable", + Type = "System", + Namespace = "Pet Stable", + + Functions = + { + { + Name = "BuyStableSlot", + Type = "Function", + + }, + { + Name = "ClickStablePet", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "selected", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClosePetStables", + Type = "Function", + + }, + { + Name = "GetNumStablePets", + Type = "Function", + + Returns = + { + { Name = "numPets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedStablePet", + Type = "Function", + + Returns = + { + { Name = "selectedPet", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetStablePetFoodTypes", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetStablePetInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "family", Type = "string", Nilable = false }, + { Name = "talent", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsAtStableMaster", + Type = "Function", + + Returns = + { + { Name = "isAtNPC", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupStablePet", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetPetStablePaperdoll", + Type = "Function", + + Arguments = + { + { Name = "model", Type = "table", Nilable = false }, + }, + + }, + { + Name = "StablePet", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "selected", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "PetStableClosed", + Type = "Event", + LiteralName = "PET_STABLE_CLOSED", + }, + { + Name = "PetStableShow", + Type = "Event", + LiteralName = "PET_STABLE_SHOW", + }, + { + Name = "PetStableUpdate", + Type = "Event", + LiteralName = "PET_STABLE_UPDATE", + }, + { + Name = "PetStableUpdatePaperdoll", + Type = "Event", + LiteralName = "PET_STABLE_UPDATE_PAPERDOLL", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PetStable); diff --git a/APIDocumentation/Documentation/PetitionDocumentation.lua b/APIDocumentation/Documentation/PetitionDocumentation.lua new file mode 100644 index 0000000..397ac1c --- /dev/null +++ b/APIDocumentation/Documentation/PetitionDocumentation.lua @@ -0,0 +1,160 @@ +local Petition = +{ + Name = "Petition", + Type = "System", + Namespace = "Petition", + + Functions = + { + { + Name = "BuyGuildCharter", + Type = "Function", + + Arguments = + { + { Name = "guildName", Type = "string", Nilable = false }, + }, + + }, + { + Name = "CanSignPetition", + Type = "Function", + + Returns = + { + { Name = "canSign", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ClickPetitionButton", + Type = "Function", + + }, + { + Name = "ClosePetition", + Type = "Function", + + }, + { + Name = "GetGuildCharterCost", + Type = "Function", + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumPetitionItems", + Type = "Function", + + }, + { + Name = "GetNumPetitionNames", + Type = "Function", + + Returns = + { + { Name = "numNames", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetitionInfo", + Type = "Function", + + Returns = + { + { Name = "petitionType", Type = "string", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "bodyText", Type = "string", Nilable = false }, + { Name = "maxSignatures", Type = "number", Nilable = false }, + { Name = "originatorName", Type = "string", Nilable = false }, + { Name = "isOriginator", Type = "bool", Nilable = false }, + { Name = "minSignatures", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetitionNameInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "OfferPetition", + Type = "Function", + + }, + { + Name = "RenamePetition", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SignPetition", + Type = "Function", + + Returns = + { + { Name = "canSign", Type = "bool", Nilable = false }, + }, + }, + { + Name = "TurnInGuildCharter", + Type = "Function", + + }, + { + Name = "TurnInPetition", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "PetitionClosed", + Type = "Event", + LiteralName = "PETITION_CLOSED", + }, + { + Name = "PetitionShow", + Type = "Event", + LiteralName = "PETITION_SHOW", + }, + { + Name = "PetitionVendorClosed", + Type = "Event", + LiteralName = "PETITION_VENDOR_CLOSED", + }, + { + Name = "PetitionVendorShow", + Type = "Event", + LiteralName = "PETITION_VENDOR_SHOW", + }, + { + Name = "PetitionVendorUpdate", + Type = "Event", + LiteralName = "PETITION_VENDOR_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Petition); diff --git a/APIDocumentation/Documentation/PingConstantsDocumentation.lua b/APIDocumentation/Documentation/PingConstantsDocumentation.lua deleted file mode 100644 index 148a9cf..0000000 --- a/APIDocumentation/Documentation/PingConstantsDocumentation.lua +++ /dev/null @@ -1,22 +0,0 @@ -local PingConstants = -{ - Tables = - { - { - Name = "PingSubjectType", - Type = "Enumeration", - NumValues = 4, - MinValue = 0, - MaxValue = 3, - Fields = - { - { Name = "Attack", Type = "PingSubjectType", EnumValue = 0 }, - { Name = "Warning", Type = "PingSubjectType", EnumValue = 1 }, - { Name = "Assist", Type = "PingSubjectType", EnumValue = 2 }, - { Name = "GroupHere", Type = "PingSubjectType", EnumValue = 3 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(PingConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlatformDocumentation.lua b/APIDocumentation/Documentation/PlatformDocumentation.lua deleted file mode 100644 index 554701d..0000000 --- a/APIDocumentation/Documentation/PlatformDocumentation.lua +++ /dev/null @@ -1,32 +0,0 @@ -local Platform = -{ - Name = "Platform", - Type = "System", - Namespace = "C_Platform", - - 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/APIDocumentation/Documentation/PlayerDocumentation.lua b/APIDocumentation/Documentation/PlayerDocumentation.lua deleted file mode 100644 index a003b95..0000000 --- a/APIDocumentation/Documentation/PlayerDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local Player = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Player); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlayerInfoDocumentation.lua b/APIDocumentation/Documentation/PlayerInfoDocumentation.lua deleted file mode 100644 index 86ae92d..0000000 --- a/APIDocumentation/Documentation/PlayerInfoDocumentation.lua +++ /dev/null @@ -1,85 +0,0 @@ -local PlayerInfo = -{ - Name = "PlayerInfo", - Type = "System", - Namespace = "C_PlayerInfo", - - Functions = - { - { - Name = "CanUseItem", - Type = "Function", - - 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 = "GetDisplayID", - Type = "Function", - - Returns = - { - { Name = "displayID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetPlayerCharacterData", - Type = "Function", - - Returns = - { - { Name = "characterData", Type = "PlayerInfoCharacterData", Nilable = false }, - }, - }, - { - Name = "HasVisibleInvSlot", - Type = "Function", - - Arguments = - { - { Name = "slot", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "isVisible", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsXPUserDisabled", - Type = "Function", - - Returns = - { - { Name = "isDisabled", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(PlayerInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlayerInfoSharedDocumentation.lua b/APIDocumentation/Documentation/PlayerInfoSharedDocumentation.lua deleted file mode 100644 index 45ffffb..0000000 --- a/APIDocumentation/Documentation/PlayerInfoSharedDocumentation.lua +++ /dev/null @@ -1,31 +0,0 @@ -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/APIDocumentation/Documentation/PlayerInformationDocumentation.lua b/APIDocumentation/Documentation/PlayerInformationDocumentation.lua new file mode 100644 index 0000000..021610a --- /dev/null +++ b/APIDocumentation/Documentation/PlayerInformationDocumentation.lua @@ -0,0 +1,750 @@ +local PlayerInformation = +{ + Name = "Player Information", + Type = "System", + Namespace = "Player Information", + + Functions = + { + { + Name = "AcceptResurrect", + Type = "Function", + + }, + { + Name = "AcceptXPLoss", + Type = "Function", + + }, + { + Name = "CanHearthAndResurrectFromArea", + Type = "Function", + + Returns = + { + { Name = "status", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CheckBinderDist", + Type = "Function", + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CheckSpiritHealerDist", + Type = "Function", + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConfirmBinder", + Type = "Function", + + }, + { + Name = "DeclineResurrect", + Type = "Function", + + }, + { + Name = "Dismount", + Type = "Function", + + }, + { + Name = "GetBindLocation", + Type = "Function", + + Returns = + { + { Name = "location", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetComboPoints", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "target", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "comboPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCorpseRecoveryDelay", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCurrentTitle", + Type = "Function", + + Returns = + { + { Name = "currentTitle", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTitles", + Type = "Function", + + Returns = + { + { Name = "numTitles", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPlayerFacing", + Type = "Function", + + Returns = + { + { Name = "facing", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardTitle", + Type = "Function", + + Returns = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRealmName", + Type = "Function", + + Returns = + { + { Name = "realm", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetReleaseTimeRemaining", + Type = "Function", + + Returns = + { + { Name = "timeleft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetResSicknessDuration", + Type = "Function", + + Returns = + { + { Name = "resSicknessTime", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRestState", + Type = "Function", + + Returns = + { + { Name = "state", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "multiplier", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneCooldown", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "runeReady", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRuneCount", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRuneType", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "runeType", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTimeToWellRested", + Type = "Function", + + }, + { + Name = "GetTitleName", + Type = "Function", + + Arguments = + { + { Name = "titleIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "titleName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetUnitPitch", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "pitch", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitSpeed", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "speed", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetXPExhaustion", + Type = "Function", + + Returns = + { + { Name = "exhaustionXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "HasFullControl", + Type = "Function", + + Returns = + { + { Name = "hasControl", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasKey", + Type = "Function", + + Returns = + { + { Name = "hasKey", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasSoulstone", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "HasWandEquipped", + Type = "Function", + + Returns = + { + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFalling", + Type = "Function", + + Returns = + { + { Name = "falling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFlyableArea", + Type = "Function", + + Returns = + { + { Name = "isFlyable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsFlying", + Type = "Function", + + Returns = + { + { Name = "isFlying", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsInInstance", + Type = "Function", + + Returns = + { + { Name = "isInstance", Type = "bool", Nilable = false }, + { Name = "instanceType", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsIndoors", + Type = "Function", + + Returns = + { + { Name = "inside", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMounted", + Type = "Function", + + Returns = + { + { Name = "mounted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOutOfBounds", + Type = "Function", + + Returns = + { + { Name = "outOfBounds", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsOutdoors", + Type = "Function", + + Returns = + { + { Name = "isOutdoors", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsResting", + Type = "Function", + + Returns = + { + { Name = "resting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStealthed", + Type = "Function", + + Returns = + { + { Name = "stealthed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSwimming", + Type = "Function", + + Returns = + { + { Name = "isSwimming", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTitleKnown", + Type = "Function", + + Arguments = + { + { Name = "titleIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isKnown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsXPUserDisabled", + Type = "Function", + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OffhandHasWeapon", + Type = "Function", + + Returns = + { + { Name = "hasWeapon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpeningCinematic", + Type = "Function", + + }, + { + Name = "RepopMe", + Type = "Function", + + }, + { + Name = "ResurrectGetOfferer", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "ResurrectHasSickness", + Type = "Function", + + Returns = + { + { Name = "hasSickness", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ResurrectHasTimer", + Type = "Function", + + Returns = + { + { Name = "hasTimer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RetrieveCorpse", + Type = "Function", + + }, + { + Name = "SetCurrentTitle", + Type = "Function", + + Arguments = + { + { Name = "titleIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ShowCloak", + Type = "Function", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ShowHelm", + Type = "Function", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ShowingCloak", + Type = "Function", + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowingHelm", + Type = "Function", + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ToggleSheath", + Type = "Function", + + }, + { + Name = "UnitXP", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "currXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitXPMax", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "playerMaxXP", Type = "number", Nilable = false }, + }, + }, + { + Name = "UseSoulstone", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "CharacterPointsChanged", + Type = "Event", + LiteralName = "CHARACTER_POINTS_CHANGED", + Payload = + { + { Name = "count", Type = "number", Nilable = false }, + { Name = "levels", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerAlive", + Type = "Event", + LiteralName = "PLAYER_ALIVE", + }, + { + Name = "PlayerAurasChanged", + Type = "Event", + LiteralName = "PLAYER_AURAS_CHANGED", + }, + { + Name = "PlayerCamping", + Type = "Event", + LiteralName = "PLAYER_CAMPING", + }, + { + Name = "PlayerControlGained", + Type = "Event", + LiteralName = "PLAYER_CONTROL_GAINED", + }, + { + Name = "PlayerControlLost", + Type = "Event", + LiteralName = "PLAYER_CONTROL_LOST", + }, + { + Name = "PlayerDamageDoneMods", + Type = "Event", + LiteralName = "PLAYER_DAMAGE_DONE_MODS", + Payload = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "PlayerDead", + Type = "Event", + LiteralName = "PLAYER_DEAD", + }, + { + Name = "PlayerDifficultyChanged", + Type = "Event", + LiteralName = "PLAYER_DIFFICULTY_CHANGED", + }, + { + Name = "PlayerEnteringBattleground", + Type = "Event", + LiteralName = "PLAYER_ENTERING_BATTLEGROUND", + }, + { + Name = "PlayerEnteringWorld", + Type = "Event", + LiteralName = "PLAYER_ENTERING_WORLD", + }, + { + Name = "PlayerEquipmentChanged", + Type = "Event", + LiteralName = "PLAYER_EQUIPMENT_CHANGED", + Payload = + { + { Name = "slot", Type = "inventoryID", Nilable = false }, + { Name = "hasItem", Type = "1nil", Nilable = false }, + }, + }, + { + Name = "PlayerFarsightFocusChanged", + Type = "Event", + LiteralName = "PLAYER_FARSIGHT_FOCUS_CHANGED", + }, + { + Name = "PlayerFlagsChanged", + Type = "Event", + LiteralName = "PLAYER_FLAGS_CHANGED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "PlayerFocusChanged", + Type = "Event", + LiteralName = "PLAYER_FOCUS_CHANGED", + }, + { + Name = "PlayerLeavingWorld", + Type = "Event", + LiteralName = "PLAYER_LEAVING_WORLD", + }, + { + Name = "PlayerLevelUp", + Type = "Event", + LiteralName = "PLAYER_LEVEL_UP", + Payload = + { + { Name = "level", Type = "string", Nilable = false }, + { Name = "hp", Type = "number", Nilable = false }, + { Name = "mp", Type = "number", Nilable = false }, + { Name = "talentPoints", Type = "number", Nilable = false }, + { Name = "strength", Type = "number", Nilable = false }, + { Name = "agility", Type = "number", Nilable = false }, + { Name = "stamina", Type = "number", Nilable = false }, + { Name = "intellect", Type = "number", Nilable = false }, + { Name = "spirit", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerLogin", + Type = "Event", + LiteralName = "PLAYER_LOGIN", + }, + { + Name = "PlayerLogout", + Type = "Event", + LiteralName = "PLAYER_LOGOUT", + }, + { + Name = "PlayerQuiting", + Type = "Event", + LiteralName = "PLAYER_QUITING", + }, + { + Name = "PlayerRegenDisabled", + Type = "Event", + LiteralName = "PLAYER_REGEN_DISABLED", + }, + { + Name = "PlayerRegenEnabled", + Type = "Event", + LiteralName = "PLAYER_REGEN_ENABLED", + }, + { + Name = "PlayerRolesAssigned", + Type = "Event", + LiteralName = "PLAYER_ROLES_ASSIGNED", + }, + { + Name = "PlayerSkinned", + Type = "Event", + LiteralName = "PLAYER_SKINNED", + }, + { + Name = "PlayerTargetChanged", + Type = "Event", + LiteralName = "PLAYER_TARGET_CHANGED", + }, + { + Name = "PlayerTotemUpdate", + Type = "Event", + LiteralName = "PLAYER_TOTEM_UPDATE", + }, + { + Name = "PlayerUnghost", + Type = "Event", + LiteralName = "PLAYER_UNGHOST", + }, + { + Name = "PlayerUpdateResting", + Type = "Event", + LiteralName = "PLAYER_UPDATE_RESTING", + }, + { + Name = "PlayerXpUpdate", + Type = "Event", + LiteralName = "PLAYER_XP_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerInformation); diff --git a/APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua b/APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua deleted file mode 100644 index 5a49924..0000000 --- a/APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua +++ /dev/null @@ -1,83 +0,0 @@ -local PlayerInteractionManagerConstants = -{ - Tables = - { - { - Name = "PlayerInteractionType", - Type = "Enumeration", - NumValues = 65, - MinValue = 0, - MaxValue = 64, - 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 = "TabardVendor", 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(PlayerInteractionManagerConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlayerInteractionManagerDocumentation.lua b/APIDocumentation/Documentation/PlayerInteractionManagerDocumentation.lua deleted file mode 100644 index 09716f1..0000000 --- a/APIDocumentation/Documentation/PlayerInteractionManagerDocumentation.lua +++ /dev/null @@ -1,113 +0,0 @@ -local PlayerInteractionManager = -{ - Name = "PlayerInteractionManager", - Type = "System", - Namespace = "C_PlayerInteractionManager", - - Functions = - { - { - Name = "ClearInteraction", - Type = "Function", - - Arguments = - { - { Name = "type", Type = "PlayerInteractionType", Nilable = true }, - }, - }, - { - Name = "ConfirmationInteraction", - Type = "Function", - - Arguments = - { - { Name = "type", Type = "PlayerInteractionType", Nilable = true }, - }, - }, - { - Name = "InteractUnit", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "type", Type = "PlayerInteractionType", Nilable = false }, - }, - - Returns = - { - { Name = "isValidInteraction", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ReopenInteraction", - Type = "Function", - }, - }, - - Events = - { - { - Name = "PlayerInteractionManagerFrameHide", - Type = "Event", - LiteralName = "PLAYER_INTERACTION_MANAGER_FRAME_HIDE", - Payload = - { - { Name = "type", Type = "PlayerInteractionType", Nilable = false }, - }, - }, - { - Name = "PlayerInteractionManagerFrameShow", - Type = "Event", - LiteralName = "PLAYER_INTERACTION_MANAGER_FRAME_SHOW", - Payload = - { - { Name = "type", Type = "PlayerInteractionType", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(PlayerInteractionManager); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlayerLocationDocumentation.lua b/APIDocumentation/Documentation/PlayerLocationDocumentation.lua deleted file mode 100644 index 7da9c86..0000000 --- a/APIDocumentation/Documentation/PlayerLocationDocumentation.lua +++ /dev/null @@ -1,120 +0,0 @@ -local PlayerLocation = -{ - Name = "PlayerLocationInfo", - Type = "System", - Namespace = "C_PlayerInfo", - - Functions = - { - { - Name = "GUIDIsPlayer", - Type = "Function", - - Arguments = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "isPlayer", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetClass", - Type = "Function", - - 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", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "name", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetRace", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "raceID", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetSex", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "sex", Type = "number", Nilable = true }, - }, - }, - { - Name = "IsConnected", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = true }, - }, - - Returns = - { - { Name = "isConnected", Type = "bool", Nilable = true }, - }, - }, - { - Name = "UnitIsSameServer", - Type = "Function", - - 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/APIDocumentation/Documentation/PlayerMentorshipConstantsDocumentation.lua b/APIDocumentation/Documentation/PlayerMentorshipConstantsDocumentation.lua deleted file mode 100644 index bc91308..0000000 --- a/APIDocumentation/Documentation/PlayerMentorshipConstantsDocumentation.lua +++ /dev/null @@ -1,34 +0,0 @@ -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/APIDocumentation/Documentation/PortraitDocumentation.lua b/APIDocumentation/Documentation/PortraitDocumentation.lua deleted file mode 100644 index 37ced4e..0000000 --- a/APIDocumentation/Documentation/PortraitDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Portrait = -{ - Name = "Portrait", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Portrait); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ProfessionConstantsDocumentation.lua b/APIDocumentation/Documentation/ProfessionConstantsDocumentation.lua deleted file mode 100644 index 9249abb..0000000 --- a/APIDocumentation/Documentation/ProfessionConstantsDocumentation.lua +++ /dev/null @@ -1,318 +0,0 @@ -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 = 5, - MinValue = 1, - MaxValue = 16, - Fields = - { - { 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 = "CraftingOrderItemType", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Reagent", Type = "CraftingOrderItemType", EnumValue = 0 }, - { Name = "Recraft", Type = "CraftingOrderItemType", EnumValue = 1 }, - { Name = "CraftedResult", Type = "CraftingOrderItemType", EnumValue = 2 }, - }, - }, - { - 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 = 45, - MinValue = 0, - MaxValue = 44, - 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 = "InvalidSort", Type = "CraftingOrderResult", EnumValue = 24 }, - { Name = "InvalidTarget", Type = "CraftingOrderResult", EnumValue = 25 }, - { Name = "InvalidType", Type = "CraftingOrderResult", EnumValue = 26 }, - { Name = "MaxOrdersReached", Type = "CraftingOrderResult", EnumValue = 27 }, - { Name = "MissingCraftingTable", Type = "CraftingOrderResult", EnumValue = 28 }, - { Name = "MissingItem", Type = "CraftingOrderResult", EnumValue = 29 }, - { Name = "MissingNpc", Type = "CraftingOrderResult", EnumValue = 30 }, - { Name = "MissingOrder", Type = "CraftingOrderResult", EnumValue = 31 }, - { Name = "MissingRecraftItem", Type = "CraftingOrderResult", EnumValue = 32 }, - { Name = "NotClaimed", Type = "CraftingOrderResult", EnumValue = 33 }, - { Name = "NotCrafted", Type = "CraftingOrderResult", EnumValue = 34 }, - { Name = "NotInGuild", Type = "CraftingOrderResult", EnumValue = 35 }, - { Name = "NotYetImplemented", Type = "CraftingOrderResult", EnumValue = 36 }, - { Name = "OutOfPublicOrderCapacity", Type = "CraftingOrderResult", EnumValue = 37 }, - { Name = "ServerIsNotAvailable", Type = "CraftingOrderResult", EnumValue = 38 }, - { Name = "ThrottleViolation", Type = "CraftingOrderResult", EnumValue = 39 }, - { Name = "TargetCannotCraft", Type = "CraftingOrderResult", EnumValue = 40 }, - { Name = "TargetLocked", Type = "CraftingOrderResult", EnumValue = 41 }, - { Name = "Timeout", Type = "CraftingOrderResult", EnumValue = 42 }, - { Name = "TooManyItems", Type = "CraftingOrderResult", EnumValue = 43 }, - { Name = "WrongVersion", Type = "CraftingOrderResult", EnumValue = 44 }, - }, - }, - { - 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 = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Public", Type = "CraftingOrderType", EnumValue = 0 }, - { Name = "Guild", Type = "CraftingOrderType", EnumValue = 1 }, - { Name = "Personal", Type = "CraftingOrderType", EnumValue = 2 }, - }, - }, - { - 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 = "ItemRecraftFlagInvalid", Type = "ItemRecraftFlags", EnumValue = 1 }, - }, - }, - { - 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 = 26, - MinValue = 0, - MaxValue = 25, - 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 = "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 = "Unused_1", 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 = "RcoCloseFulfill", Type = "RcoCloseReason", EnumValue = 0 }, - { Name = "RcoCloseExpire", Type = "RcoCloseReason", EnumValue = 1 }, - { Name = "RcoCloseCancel", Type = "RcoCloseReason", EnumValue = 2 }, - { Name = "RcoCloseReject", Type = "RcoCloseReason", EnumValue = 3 }, - { Name = "RcoCloseGmCancel", Type = "RcoCloseReason", EnumValue = 4 }, - { Name = "RcoCloseCrafterFulfill", Type = "RcoCloseReason", EnumValue = 5 }, - { Name = "RcoCloseInvalid", Type = "RcoCloseReason", EnumValue = 6 }, - }, - }, - { - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(ProfessionConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PvPFactionConstantsDocumentation.lua b/APIDocumentation/Documentation/PvPFactionConstantsDocumentation.lua deleted file mode 100644 index 0775a5f..0000000 --- a/APIDocumentation/Documentation/PvPFactionConstantsDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -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/APIDocumentation/Documentation/PvpDocumentation.lua b/APIDocumentation/Documentation/PvpDocumentation.lua new file mode 100644 index 0000000..4e9e680 --- /dev/null +++ b/APIDocumentation/Documentation/PvpDocumentation.lua @@ -0,0 +1,322 @@ +local Pvp = +{ + Name = "PvP", + Type = "System", + Namespace = "PvP", + + Functions = + { + { + Name = "CanHearthAndResurrectFromArea", + Type = "Function", + + Returns = + { + { Name = "status", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanQueueForWintergrasp", + Type = "Function", + + Returns = + { + { Name = "canQueue", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetHolidayBGHonorCurrencyBonuses", + Type = "Function", + + Returns = + { + { Name = "unk", Type = "bool", Nilable = false }, + { Name = "honorWinReward", Type = "number", Nilable = false }, + { Name = "arenaWinReward", Type = "number", Nilable = false }, + { Name = "honorLossReward", Type = "number", Nilable = false }, + { Name = "arenaLossReward", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetHonorCurrency", + Type = "Function", + + Returns = + { + { Name = "honorPoints", Type = "number", Nilable = false }, + { Name = "maxHonor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumWorldStateUI", + Type = "Function", + + Returns = + { + { Name = "numUI", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPDesired", + Type = "Function", + + Returns = + { + { Name = "isPVPDesired", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPLifetimeStats", + Type = "Function", + + Returns = + { + { Name = "hk", Type = "number", Nilable = false }, + { Name = "highestRank", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPRankInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "rankName", Type = "string", Nilable = false }, + { Name = "rankNumber", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPRankProgress", + Type = "Function", + + }, + { + Name = "GetPVPSessionStats", + Type = "Function", + + Returns = + { + { Name = "honorKills", Type = "number", Nilable = false }, + { Name = "honorPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPTimer", + Type = "Function", + + Returns = + { + { Name = "timer", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPVPYesterdayStats", + Type = "Function", + + Returns = + { + { Name = "honorKills", Type = "number", Nilable = false }, + { Name = "honorPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWorldPVPQueueStatus", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "string", Nilable = false }, + { Name = "mapName", Type = "string", Nilable = false }, + { Name = "queueID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetWorldStateUIInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "uiType", Type = "number", Nilable = false }, + { Name = "state", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "dynamicIcon", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "dynamicTooltip", Type = "string", Nilable = false }, + { Name = "extendedUI", Type = "string", Nilable = false }, + { Name = "extendedUIState1", Type = "number", Nilable = false }, + { Name = "extendedUIState2", Type = "number", Nilable = false }, + { Name = "extendedUIState3", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetZonePVPInfo", + Type = "Function", + + Returns = + { + { Name = "pvpType", Type = "string", Nilable = false }, + { Name = "isSubZonePVP", Type = "bool", Nilable = false }, + { Name = "factionName", Type = "string", Nilable = false }, + }, + }, + { + Name = "HearthAndResurrectFromArea", + Type = "Function", + + Returns = + { + { Name = "status", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPVPTimerRunning", + Type = "Function", + + Returns = + { + { Name = "isRunning", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSubZonePVPPOI", + Type = "Function", + + Returns = + { + { Name = "isPVPPOI", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestFlagsPVP", + Type = "Function", + + Returns = + { + { Name = "questFlag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPVP", + Type = "Function", + + Arguments = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TogglePVP", + Type = "Function", + + }, + { + Name = "UnitIsPVPFreeForAll", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isFreeForAll", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVPSanctuary", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPVPName", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitPVPRank", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "NpcPvpqueueAnywhere", + Type = "Event", + LiteralName = "NPC_PVPQUEUE_ANYWHERE", + }, + { + Name = "PlayerPvpKillsChanged", + Type = "Event", + LiteralName = "PLAYER_PVP_KILLS_CHANGED", + }, + { + Name = "PlayerPvpRankChanged", + Type = "Event", + LiteralName = "PLAYER_PVP_RANK_CHANGED", + }, + { + Name = "PvpqueueAnywhereShow", + Type = "Event", + LiteralName = "PVPQUEUE_ANYWHERE_SHOW", + }, + { + Name = "PvpqueueAnywhereUpdateAvailable", + Type = "Event", + LiteralName = "PVPQUEUE_ANYWHERE_UPDATE_AVAILABLE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Pvp); diff --git a/APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua b/APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua deleted file mode 100644 index 7c3619a..0000000 --- a/APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua +++ /dev/null @@ -1,16 +0,0 @@ -local PvpInfoConstants = -{ - Tables = - { - { - Name = "PvpInfoConsts", - Type = "Constants", - Values = - { - { Name = "MaxPlayersPerInstance", Type = "number", Value = 80 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(PvpInfoConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PvpInfoDocumentation.lua b/APIDocumentation/Documentation/PvpInfoDocumentation.lua deleted file mode 100644 index 716f0e4..0000000 --- a/APIDocumentation/Documentation/PvpInfoDocumentation.lua +++ /dev/null @@ -1,461 +0,0 @@ -local PvpInfo = -{ - Name = "PvpInfo", - Type = "System", - Namespace = "C_PvP", - - Functions = - { - { - Name = "GetArenaCrowdControlInfo", - Type = "Function", - - Arguments = - { - { Name = "playerToken", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "spellID", Type = "number", Nilable = false }, - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "startTime", Type = "number", Nilable = false }, - { Name = "duration", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetBattlefieldVehicleInfo", - Type = "Function", - - Arguments = - { - { Name = "vehicleIndex", Type = "luaIndex", Nilable = false }, - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "BattlefieldVehicleInfo", Nilable = false }, - }, - }, - { - Name = "GetBattlefieldVehicles", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "vehicles", Type = "table", InnerType = "BattlefieldVehicleInfo", Nilable = false }, - }, - }, - { - Name = "GetHolidayBGLossRewards", - 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 = "GetHolidayBGRewards", - 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 = "GetRandomBGLossRewards", - 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 = "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 = "IsInBrawl", - Type = "Function", - - Returns = - { - { Name = "isInBrawl", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsPVPMap", - Type = "Function", - - Returns = - { - { Name = "isPVPMap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsRatedMap", - Type = "Function", - - Returns = - { - { Name = "isRatedMap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RequestCrowdControlSpell", - Type = "Function", - - Arguments = - { - { Name = "playerToken", Type = "UnitToken", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "ArenaOpponentUpdate", - Type = "Event", - LiteralName = "ARENA_OPPONENT_UPDATE", - Payload = - { - { Name = "unitToken", Type = "cstring", Nilable = false }, - { Name = "updateReason", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ArenaRegistrarClosed", - Type = "Event", - LiteralName = "ARENA_REGISTRAR_CLOSED", - }, - { - Name = "ArenaRegistrarShow", - Type = "Event", - LiteralName = "ARENA_REGISTRAR_SHOW", - }, - { - Name = "ArenaRegistrarUpdate", - Type = "Event", - LiteralName = "ARENA_REGISTRAR_UPDATE", - }, - { - Name = "ArenaSeasonWorldState", - Type = "Event", - LiteralName = "ARENA_SEASON_WORLD_STATE", - }, - { - Name = "ArenaTeamInviteRequest", - Type = "Event", - LiteralName = "ARENA_TEAM_INVITE_REQUEST", - Payload = - { - { Name = "inviter", Type = "cstring", Nilable = false }, - { Name = "teamName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ArenaTeamRosterUpdate", - Type = "Event", - LiteralName = "ARENA_TEAM_ROSTER_UPDATE", - Payload = - { - { Name = "allowQuery", Type = "bool", Nilable = true }, - }, - }, - { - Name = "ArenaTeamUpdate", - Type = "Event", - LiteralName = "ARENA_TEAM_UPDATE", - }, - { - Name = "BattlefieldAutoQueue", - Type = "Event", - LiteralName = "BATTLEFIELD_AUTO_QUEUE", - }, - { - Name = "BattlefieldAutoQueueEject", - Type = "Event", - LiteralName = "BATTLEFIELD_AUTO_QUEUE_EJECT", - }, - { - Name = "BattlefieldQueueTimeout", - Type = "Event", - LiteralName = "BATTLEFIELD_QUEUE_TIMEOUT", - }, - { - Name = "BattlefieldsClosed", - Type = "Event", - LiteralName = "BATTLEFIELDS_CLOSED", - }, - { - Name = "BattlefieldsShow", - Type = "Event", - LiteralName = "BATTLEFIELDS_SHOW", - Payload = - { - { Name = "isArena", Type = "bool", Nilable = true }, - { Name = "battleMasterListID", Type = "number", Nilable = true }, - }, - }, - { - Name = "BattlegroundObjectivesUpdate", - Type = "Event", - LiteralName = "BATTLEGROUND_OBJECTIVES_UPDATE", - }, - { - Name = "BattlegroundPointsUpdate", - Type = "Event", - LiteralName = "BATTLEGROUND_POINTS_UPDATE", - }, - { - Name = "GdfSimComplete", - Type = "Event", - LiteralName = "GDF_SIM_COMPLETE", - }, - { - Name = "NotifyPvpAfkResult", - Type = "Event", - LiteralName = "NOTIFY_PVP_AFK_RESULT", - 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", - }, - { - Name = "PvpRatedStatsUpdate", - Type = "Event", - LiteralName = "PVP_RATED_STATS_UPDATE", - }, - { - Name = "PvpVehicleInfoUpdated", - Type = "Event", - LiteralName = "PVP_VEHICLE_INFO_UPDATED", - }, - { - Name = "PvpWorldstateUpdate", - Type = "Event", - LiteralName = "PVP_WORLDSTATE_UPDATE", - }, - { - Name = "UpdateActiveBattlefield", - Type = "Event", - LiteralName = "UPDATE_ACTIVE_BATTLEFIELD", - }, - { - Name = "UpdateBattlefieldScore", - Type = "Event", - LiteralName = "UPDATE_BATTLEFIELD_SCORE", - }, - { - Name = "UpdateBattlefieldStatus", - Type = "Event", - LiteralName = "UPDATE_BATTLEFIELD_STATUS", - Payload = - { - { Name = "battleFieldIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "WargameRequested", - Type = "Event", - LiteralName = "WARGAME_REQUESTED", - 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", - }, - }, - - Tables = - { - { - Name = "BrawlType", - Type = "Enumeration", - NumValues = 5, - MinValue = 0, - MaxValue = 4, - 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 = "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 = "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 = "BattlemasterListInfo", - Type = "Structure", - Fields = - { - { Name = "name", Type = "string", Nilable = false }, - { Name = "instanceType", Type = "number", 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 = "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 = "active", Type = "bool", Nilable = false }, - { Name = "minLevel", Type = "number", Nilable = false }, - { Name = "maxLevel", Type = "number", Nilable = false }, - { Name = "groupsAllowed", Type = "bool", Nilable = false }, - { Name = "timeLeftUntilNextChange", Type = "number", Nilable = true }, - { Name = "lfgDungeonID", Type = "number", Nilable = false }, - { Name = "brawlType", Type = "BrawlType", Nilable = false }, - { Name = "mapNames", Type = "table", InnerType = "string", Nilable = false }, - { Name = "includesAllArenas", Type = "bool", Nilable = false, Default = 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 = "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 = "hasRandomWinToday", Type = "bool", 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/APIDocumentation/Documentation/QuestConstantsDocumentation.lua b/APIDocumentation/Documentation/QuestConstantsDocumentation.lua deleted file mode 100644 index 01c0eda..0000000 --- a/APIDocumentation/Documentation/QuestConstantsDocumentation.lua +++ /dev/null @@ -1,78 +0,0 @@ -local QuestConstants = -{ - Tables = - { - { - Name = "QuestCompleteSpellType", - Type = "Enumeration", - NumValues = 8, - MinValue = 0, - MaxValue = 7, - 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 = "QuestTagType", - Type = "Enumeration", - NumValues = 17, - MinValue = 0, - MaxValue = 16, - 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 = "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_Classic", - Type = "Constants", - Values = - { - { Name = "MAX_QUEST_WATCHES", Type = "number", Value = 25 }, - { Name = "MAX_WORLD_QUEST_WATCHES", Type = "number", Value = 1 }, - { Name = "MAX_WORLD_QUEST_HARD_WATCHES", Type = "number", Value = 5 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(QuestConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestConstants_ClassicDocumentation.lua b/APIDocumentation/Documentation/QuestConstants_ClassicDocumentation.lua deleted file mode 100644 index a08eeb9..0000000 --- a/APIDocumentation/Documentation/QuestConstants_ClassicDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local QuestConstants_Classic = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(QuestConstants_Classic); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestDocumentation.lua b/APIDocumentation/Documentation/QuestDocumentation.lua new file mode 100644 index 0000000..c2eb733 --- /dev/null +++ b/APIDocumentation/Documentation/QuestDocumentation.lua @@ -0,0 +1,1182 @@ +local Quest = +{ + Name = "Quest", + Type = "System", + Namespace = "Quest", + + Functions = + { + { + Name = "AbandonQuest", + Type = "Function", + + }, + { + Name = "AcceptQuest", + Type = "Function", + + }, + { + Name = "AddQuestWatch", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CloseQuest", + Type = "Function", + + }, + { + Name = "CollapseQuestHeader", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CompleteQuest", + Type = "Function", + + }, + { + Name = "ConfirmAcceptQuest", + Type = "Function", + + }, + { + Name = "DeclineQuest", + Type = "Function", + + }, + { + Name = "ExpandQuestHeader", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetAbandonQuestItems", + Type = "Function", + + Returns = + { + { Name = "items", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAbandonQuestName", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetActiveLevel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetActiveTitle", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetAvailableLevel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAvailableTitle", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetDailyQuestsCompleted", + Type = "Function", + + Returns = + { + { Name = "dailyQuestsComplete", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGossipActiveQuests", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "isTrivial", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetGossipAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "isTrivial", Type = "bool", Nilable = false }, + { Name = "isDaily", Type = "bool", Nilable = false }, + { Name = "isRepeatable", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetGreetingText", + Type = "Function", + + Returns = + { + { Name = "greetingText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMaxDailyQuests", + Type = "Function", + + Returns = + { + { Name = "max", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumActiveQuests", + Type = "Function", + + Returns = + { + { Name = "numActiveQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "numAvailableQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGossipActiveQuests", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumGossipAvailableQuests", + Type = "Function", + + Returns = + { + { Name = "num", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestChoices", + Type = "Function", + + Returns = + { + { Name = "numQuestChoices", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestItems", + Type = "Function", + + Returns = + { + { Name = "numRequiredItems", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestLeaderBoards", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "numObjectives", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestLogChoices", + Type = "Function", + + Returns = + { + { Name = "numChoices", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestLogEntries", + Type = "Function", + + Returns = + { + { Name = "numEntries", Type = "number", Nilable = false }, + { Name = "numQuests", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestLogRewards", + Type = "Function", + + Returns = + { + { Name = "numRewards", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestRewards", + Type = "Function", + + Returns = + { + { Name = "numQuestRewards", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumQuestWatches", + Type = "Function", + + Returns = + { + { Name = "numWatches", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumWorldStateUI", + Type = "Function", + + Returns = + { + { Name = "numUI", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetObjectiveText", + Type = "Function", + + Returns = + { + { Name = "questObjective", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetProgressText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestBackgroundMaterial", + Type = "Function", + + Returns = + { + { Name = "material", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestDifficultyColor", + Type = "Function", + + Arguments = + { + { Name = "level", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "color", Type = "table", Nilable = false }, + }, + }, + { + Name = "GetQuestGreenRange", + Type = "Function", + + Returns = + { + { Name = "range", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestIndexForTimer", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetQuestIndexForWatch", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetQuestItemInfo", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestItemLink", + Type = "Function", + + Arguments = + { + { Name = "itemType", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestLink", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetQuestLogChoiceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestLogCompletionText", + Type = "Function", + + Returns = + { + { Name = "completionText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestLogGroupNum", + Type = "Function", + + Returns = + { + { Name = "suggestedGroup", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogItemLink", + Type = "Function", + + Arguments = + { + { Name = "itemType", Type = "string", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetQuestLogLeaderBoard", + Type = "Function", + + Arguments = + { + { Name = "objective", Type = "number", Nilable = false }, + { Name = "questIndex", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "type", Type = "string", Nilable = false }, + { Name = "finished", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestLogPushable", + Type = "Function", + + Returns = + { + { Name = "shareable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestLogQuestText", + Type = "Function", + + Returns = + { + { Name = "questDescription", Type = "string", Nilable = false }, + { Name = "questObjectives", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRequiredMoney", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardMoney", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardSpell", + Type = "Function", + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isTradeskillSpell", Type = "bool", Nilable = false }, + { Name = "isSpellLearned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardTalents", + Type = "Function", + + Returns = + { + { Name = "talents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardTitle", + Type = "Function", + + Returns = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSelection", + Type = "Function", + + Returns = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSpecialItemCooldown", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSpecialItemInfo", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "charges", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogSpellLink", + Type = "Function", + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetQuestLogTimeLeft", + Type = "Function", + + Returns = + { + { Name = "questTimer", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogTitle", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questLogTitleText", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "questTag", Type = "string", Nilable = false }, + { Name = "suggestedGroup", Type = "number", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "isCollapsed", Type = "bool", Nilable = false }, + { Name = "isComplete", Type = "number", Nilable = false }, + { Name = "isDaily", Type = "bool", Nilable = false }, + { Name = "questID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestMoneyToGet", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestResetTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GetQuestReward", + Type = "Function", + + Arguments = + { + { Name = "choice", Type = "number", Nilable = false }, + }, + + }, + { + Name = "GetQuestSpellLink", + Type = "Function", + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetQuestText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetQuestTimers", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetQuestsCompleted", + Type = "Function", + + Arguments = + { + { Name = "questTbl", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "completedQuests", Type = "table", Nilable = false }, + }, + }, + { + Name = "GetRewardHonor", + Type = "Function", + + Returns = + { + { Name = "honor", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRewardMoney", + Type = "Function", + + Returns = + { + { Name = "money", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRewardSpell", + Type = "Function", + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isTradeskillSpell", Type = "bool", Nilable = false }, + { Name = "isSpellLearned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRewardTalents", + Type = "Function", + + Returns = + { + { Name = "talents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRewardText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRewardTitle", + Type = "Function", + + Returns = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRewardXP", + Type = "Function", + + }, + { + Name = "GetSuggestedGroupNum", + Type = "Function", + + Returns = + { + { Name = "suggestedGroup", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTitleText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetWorldStateUIInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "uiType", Type = "number", Nilable = false }, + { Name = "state", Type = "number", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "dynamicIcon", Type = "string", Nilable = false }, + { Name = "tooltip", Type = "string", Nilable = false }, + { Name = "dynamicTooltip", Type = "string", Nilable = false }, + { Name = "extendedUI", Type = "string", Nilable = false }, + { Name = "extendedUIState1", Type = "number", Nilable = false }, + { Name = "extendedUIState2", Type = "number", Nilable = false }, + { Name = "extendedUIState3", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsActiveQuestTrivial", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "trivial", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAvailableQuestTrivial", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "trivial", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrentQuestFailed", + Type = "Function", + + Returns = + { + { Name = "isFailed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestCompletable", + Type = "Function", + + Returns = + { + { Name = "isCompletable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsQuestLogSpecialItemInRange", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inRange", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsQuestWatched", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isWatched", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUnitOnQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QueryQuestsCompleted", + Type = "Function", + + }, + { + Name = "QuestChooseRewardError", + Type = "Function", + + }, + { + Name = "QuestFlagsPVP", + Type = "Function", + + Returns = + { + { Name = "questFlag", Type = "bool", Nilable = false }, + }, + }, + { + Name = "QuestGetAutoAccept", + Type = "Function", + + }, + { + Name = "QuestLogPushQuest", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "RemoveQuestWatch", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectActiveQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectAvailableQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectGossipActiveQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectGossipAvailableQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SelectQuestLogEntry", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetAbandonQuest", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "UseQuestLogSpecialItem", + Type = "Function", + + Arguments = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "BnRequestFofFailed", + Type = "Event", + LiteralName = "BN_REQUEST_FOF_FAILED", + }, + { + Name = "BnRequestFofSucceeded", + Type = "Event", + LiteralName = "BN_REQUEST_FOF_SUCCEEDED", + }, + { + Name = "DuelRequested", + Type = "Event", + LiteralName = "DUEL_REQUESTED", + Payload = + { + { Name = "challenger", Type = "string", Nilable = false }, + }, + }, + { + Name = "QuestAccepted", + Type = "Event", + LiteralName = "QUEST_ACCEPTED", + Payload = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "QuestAcceptConfirm", + Type = "Event", + LiteralName = "QUEST_ACCEPT_CONFIRM", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "quest", Type = "string", Nilable = false }, + }, + }, + { + Name = "QuestComplete", + Type = "Event", + LiteralName = "QUEST_COMPLETE", + }, + { + Name = "QuestDetail", + Type = "Event", + LiteralName = "QUEST_DETAIL", + }, + { + Name = "QuestFinished", + Type = "Event", + LiteralName = "QUEST_FINISHED", + }, + { + Name = "QuestGreeting", + Type = "Event", + LiteralName = "QUEST_GREETING", + }, + { + Name = "QuestItemUpdate", + Type = "Event", + LiteralName = "QUEST_ITEM_UPDATE", + }, + { + Name = "QuestLogUpdate", + Type = "Event", + LiteralName = "QUEST_LOG_UPDATE", + }, + { + Name = "QuestPoiUpdate", + Type = "Event", + LiteralName = "QUEST_POI_UPDATE", + }, + { + Name = "QuestProgress", + Type = "Event", + LiteralName = "QUEST_PROGRESS", + }, + { + Name = "QuestQueryComplete", + Type = "Event", + LiteralName = "QUEST_QUERY_COMPLETE", + }, + { + Name = "QuestWatchUpdate", + Type = "Event", + LiteralName = "QUEST_WATCH_UPDATE", + Payload = + { + { Name = "questIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ResurrectRequest", + Type = "Event", + LiteralName = "RESURRECT_REQUEST", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "TradeRequest", + Type = "Event", + LiteralName = "TRADE_REQUEST", + }, + { + Name = "TradeRequestCancel", + Type = "Event", + LiteralName = "TRADE_REQUEST_CANCEL", + }, + { + Name = "UnitQuestLogChanged", + Type = "Event", + LiteralName = "UNIT_QUEST_LOG_CHANGED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Quest); diff --git a/APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua b/APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua deleted file mode 100644 index f46ea39..0000000 --- a/APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua +++ /dev/null @@ -1,93 +0,0 @@ -local QuestInfoSystem = -{ - Name = "QuestInfoSystem", - Type = "System", - Namespace = "C_QuestInfoSystem", - - Functions = - { - { - Name = "GetQuestRewardSpellInfo", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = true }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "QuestRewardSpellInfo", Nilable = true }, - }, - }, - { - Name = "GetQuestRewardSpells", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "spellIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetQuestShouldToastCompletion", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "shouldToast", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HasQuestRewardSpells", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "hasRewardSpells", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - { - 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(QuestInfoSystem); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestLineInfoDocumentation.lua b/APIDocumentation/Documentation/QuestLineInfoDocumentation.lua deleted file mode 100644 index b593944..0000000 --- a/APIDocumentation/Documentation/QuestLineInfoDocumentation.lua +++ /dev/null @@ -1,49 +0,0 @@ -local QuestLineInfo = -{ - Name = "QuestLineUI", - Type = "System", - Namespace = "C_QuestLine", - - Functions = - { - }, - - 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 = "floorLocation", Type = "QuestLineFloorLocation", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(QuestLineInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestLogDocumentation.lua b/APIDocumentation/Documentation/QuestLogDocumentation.lua deleted file mode 100644 index 9080aff..0000000 --- a/APIDocumentation/Documentation/QuestLogDocumentation.lua +++ /dev/null @@ -1,256 +0,0 @@ -local QuestLog = -{ - Name = "QuestLog", - Type = "System", - Namespace = "C_QuestLog", - - Functions = - { - { - 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 = "GetQuestInfo", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "title", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetQuestObjectives", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "objectives", Type = "table", InnerType = "QuestObjectiveInfo", Nilable = false }, - }, - }, - { - Name = "IsOnQuest", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isOnQuest", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsQuestFlaggedCompleted", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isCompleted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ShouldShowQuestRewards", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "shouldShow", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "QuestAccepted", - Type = "Event", - LiteralName = "QUEST_ACCEPTED", - Payload = - { - { Name = "questIndex", Type = "number", Nilable = false }, - { Name = "questId", Type = "number", Nilable = false }, - }, - }, - { - Name = "QuestAutocomplete", - Type = "Event", - LiteralName = "QUEST_AUTOCOMPLETE", - Payload = - { - { Name = "questId", Type = "number", Nilable = false }, - }, - }, - { - Name = "QuestComplete", - Type = "Event", - LiteralName = "QUEST_COMPLETE", - }, - { - Name = "QuestDetail", - Type = "Event", - LiteralName = "QUEST_DETAIL", - Payload = - { - { Name = "questStartItemID", Type = "number", Nilable = true }, - }, - }, - { - Name = "QuestLogUpdate", - Type = "Event", - LiteralName = "QUEST_LOG_UPDATE", - }, - { - Name = "QuestRemoved", - Type = "Event", - LiteralName = "QUEST_REMOVED", - Payload = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - }, - { - Name = "QuestTurnedIn", - Type = "Event", - LiteralName = "QUEST_TURNED_IN", - 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", - Payload = - { - { Name = "questID", Type = "number", Nilable = true }, - { Name = "added", Type = "bool", Nilable = true }, - }, - }, - { - Name = "QuestWatchUpdate", - Type = "Event", - LiteralName = "QUEST_WATCH_UPDATE", - Payload = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SuperTrackedQuestChanged", - Type = "Event", - LiteralName = "SUPER_TRACKED_QUEST_CHANGED", - Payload = - { - { Name = "superTrackedQuestID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TaskProgressUpdate", - Type = "Event", - LiteralName = "TASK_PROGRESS_UPDATE", - }, - }, - - Tables = - { - { - Name = "QuestFrequency", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Default", Type = "QuestFrequency", EnumValue = 0 }, - { Name = "Daily", Type = "QuestFrequency", EnumValue = 1 }, - { Name = "Weekly", Type = "QuestFrequency", EnumValue = 2 }, - }, - }, - { - Name = "QuestTag", - Type = "Enumeration", - NumValues = 10, - MinValue = 1, - MaxValue = 102, - 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 = "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 = "QuestOnMapInfo", - Type = "Structure", - Fields = - { - { Name = "questID", Type = "number", Nilable = false }, - { Name = "x", Type = "number", Nilable = false }, - { Name = "y", Type = "number", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(QuestLog); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestOfferDocumentation.lua b/APIDocumentation/Documentation/QuestOfferDocumentation.lua deleted file mode 100644 index 411d3ac..0000000 --- a/APIDocumentation/Documentation/QuestOfferDocumentation.lua +++ /dev/null @@ -1,50 +0,0 @@ -local QuestOffer = -{ - Name = "QuestOffer", - Type = "System", - Namespace = "C_QuestOffer", - - Functions = - { - }, - - Events = - { - { - Name = "QuestAcceptConfirm", - Type = "Event", - LiteralName = "QUEST_ACCEPT_CONFIRM", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "questTitle", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "QuestFinished", - Type = "Event", - LiteralName = "QUEST_FINISHED", - }, - { - Name = "QuestGreeting", - Type = "Event", - LiteralName = "QUEST_GREETING", - }, - { - Name = "QuestItemUpdate", - Type = "Event", - LiteralName = "QUEST_ITEM_UPDATE", - }, - { - Name = "QuestProgress", - Type = "Event", - LiteralName = "QUEST_PROGRESS", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(QuestOffer); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestRewardsDocumentation.lua b/APIDocumentation/Documentation/QuestRewardsDocumentation.lua deleted file mode 100644 index 45d1dac..0000000 --- a/APIDocumentation/Documentation/QuestRewardsDocumentation.lua +++ /dev/null @@ -1,17 +0,0 @@ -local QuestRewards = -{ - Tables = - { - { - Name = "QuestReputationRewardInfo", - Type = "Structure", - Fields = - { - { Name = "factionID", Type = "number", Nilable = false }, - { Name = "rewardAmount", Type = "number", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(QuestRewards); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestSessionConstantsDocumentation.lua b/APIDocumentation/Documentation/QuestSessionConstantsDocumentation.lua deleted file mode 100644 index 433d536..0000000 --- a/APIDocumentation/Documentation/QuestSessionConstantsDocumentation.lua +++ /dev/null @@ -1,67 +0,0 @@ -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/APIDocumentation/Documentation/QuestSessionDocumentation.lua b/APIDocumentation/Documentation/QuestSessionDocumentation.lua deleted file mode 100644 index 7dad579..0000000 --- a/APIDocumentation/Documentation/QuestSessionDocumentation.lua +++ /dev/null @@ -1,200 +0,0 @@ -local QuestSession = -{ - Name = "QuestSession", - Type = "System", - Namespace = "C_QuestSession", - - 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", - - Arguments = - { - { Name = "beginSession", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetQuestIsSuperTracked", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - { Name = "superTrack", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "QuestSessionCreated", - Type = "Event", - LiteralName = "QUEST_SESSION_CREATED", - }, - { - Name = "QuestSessionDestroyed", - Type = "Event", - LiteralName = "QUEST_SESSION_DESTROYED", - }, - { - Name = "QuestSessionEnabledStateChanged", - Type = "Event", - LiteralName = "QUEST_SESSION_ENABLED_STATE_CHANGED", - Payload = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "QuestSessionJoined", - Type = "Event", - LiteralName = "QUEST_SESSION_JOINED", - }, - { - Name = "QuestSessionLeft", - Type = "Event", - LiteralName = "QUEST_SESSION_LEFT", - }, - { - Name = "QuestSessionMemberConfirm", - Type = "Event", - LiteralName = "QUEST_SESSION_MEMBER_CONFIRM", - }, - { - Name = "QuestSessionMemberStartResponse", - Type = "Event", - LiteralName = "QUEST_SESSION_MEMBER_START_RESPONSE", - Payload = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - { Name = "response", Type = "bool", Nilable = false }, - }, - }, - { - Name = "QuestSessionNotification", - Type = "Event", - LiteralName = "QUEST_SESSION_NOTIFICATION", - 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/APIDocumentation/Documentation/QuestTaskInfoDocumentation.lua b/APIDocumentation/Documentation/QuestTaskInfoDocumentation.lua deleted file mode 100644 index 02d4add..0000000 --- a/APIDocumentation/Documentation/QuestTaskInfoDocumentation.lua +++ /dev/null @@ -1,200 +0,0 @@ -local QuestTaskInfo = -{ - Name = "QuestTaskInfo", - Type = "System", - Namespace = "C_TaskQuest", - - Functions = - { - { - Name = "DoesMapShowTaskQuestObjectives", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "showsTaskQuestObjectives", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetQuestInfoByQuestID", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "progress", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetQuestTimeLeftMinutes", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "minutesLeft", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetQuestTimeLeftSeconds", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "secondsLeft", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetQuestZoneID", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetQuestsForPlayerByMapID", - Type = "Function", - - Arguments = - { - { Name = "uiMapID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "taskPOIs", Type = "table", InnerType = "TaskPOIData", Nilable = false }, - }, - }, - { - Name = "GetThreatQuests", - Type = "Function", - - Returns = - { - { Name = "quests", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetUIWidgetSetIDFromQuestID", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "UiWidgetSetID", Type = "number", Nilable = false }, - }, - }, - { - Name = "IsActive", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "active", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RequestPreloadRewardData", - Type = "Function", - - Arguments = - { - { Name = "questID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - { - Name = "TaskPOIData", - Type = "Structure", - Fields = - { - { Name = "questId", Type = "number", Nilable = false }, - { Name = "x", Type = "number", Nilable = false }, - { Name = "y", Type = "number", Nilable = false }, - { Name = "inProgress", Type = "bool", Nilable = false }, - { Name = "numObjectives", Type = "number", Nilable = false }, - { Name = "mapID", Type = "number", Nilable = false }, - { Name = "isQuestStart", Type = "bool", Nilable = false }, - { Name = "isDaily", Type = "bool", Nilable = false }, - { Name = "isCombatAllyQuest", Type = "bool", Nilable = false }, - { Name = "childDepth", Type = "number", Nilable = true }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(QuestTaskInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QueueSpecificDocumentation.lua b/APIDocumentation/Documentation/QueueSpecificDocumentation.lua deleted file mode 100644 index e1baf4a..0000000 --- a/APIDocumentation/Documentation/QueueSpecificDocumentation.lua +++ /dev/null @@ -1,25 +0,0 @@ -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/APIDocumentation/Documentation/RaidDocumentation.lua b/APIDocumentation/Documentation/RaidDocumentation.lua new file mode 100644 index 0000000..fb2f38c --- /dev/null +++ b/APIDocumentation/Documentation/RaidDocumentation.lua @@ -0,0 +1,407 @@ +local Raid = +{ + Name = "Raid", + Type = "System", + Namespace = "Raid", + + Functions = + { + { + Name = "AcceptGroup", + Type = "Function", + + }, + { + Name = "ClearPartyAssignment", + Type = "Function", + + Arguments = + { + { Name = "assignment", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "ConfirmReadyCheck", + Type = "Function", + + Arguments = + { + { Name = "ready", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ConvertToRaid", + Type = "Function", + + }, + { + Name = "DeclineGroup", + Type = "Function", + + }, + { + Name = "DemoteAssistant", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "DoReadyCheck", + Type = "Function", + + }, + { + Name = "GetNumRaidMembers", + Type = "Function", + + Returns = + { + { Name = "numRaidMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPartyAssignment", + Type = "Function", + + Arguments = + { + { Name = "assignment", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "isAssigned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRaidRosterInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "subgroup", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "fileName", Type = "string", Nilable = false }, + { Name = "zone", Type = "string", Nilable = false }, + { Name = "online", Type = "bool", Nilable = false }, + { Name = "isDead", Type = "bool", Nilable = false }, + { Name = "role", Type = "string", Nilable = false }, + { Name = "isML", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRaidRosterSelection", + Type = "Function", + + Returns = + { + { Name = "raidIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetRaidTargetIndex", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetReadyCheckStatus", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "status", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetReadyCheckTimeLeft", + Type = "Function", + + Returns = + { + { Name = "timeLeft", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRealNumRaidMembers", + Type = "Function", + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "InviteUnit", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "IsRaidLeader", + Type = "Function", + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRaidOfficer", + Type = "Function", + + Returns = + { + { Name = "isRaidOfficer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsRealRaidLeader", + Type = "Function", + + Returns = + { + { Name = "isLeader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LeaveParty", + Type = "Function", + + }, + { + Name = "PromoteToAssistant", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "PromoteToLeader", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "SetPartyAssignment", + Type = "Function", + + Arguments = + { + { Name = "assignment", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "exactMatch", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "SetRaidRosterSelection", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetRaidSubgroup", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "subgroup", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetRaidTarget", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "SwapRaidSubgroup", + Type = "Function", + + Arguments = + { + { Name = "index1", Type = "luaIndex", Nilable = false }, + { Name = "index2", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "UninviteUnit", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "UnitInRaid", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inRaid", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitIsPartyLeader", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "leader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsRaidOfficer", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "leader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPlayerOrPetInRaid", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitTargetsVehicleInRaidUI", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "targetVehicle", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "DisableLowLevelRaid", + Type = "Event", + LiteralName = "DISABLE_LOW_LEVEL_RAID", + }, + { + Name = "EnableLowLevelRaid", + Type = "Event", + LiteralName = "ENABLE_LOW_LEVEL_RAID", + }, + { + Name = "RaidRosterUpdate", + Type = "Event", + LiteralName = "RAID_ROSTER_UPDATE", + }, + { + Name = "RaidTargetUpdate", + Type = "Event", + LiteralName = "RAID_TARGET_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Raid); diff --git a/APIDocumentation/Documentation/RaidLocksDocumentation.lua b/APIDocumentation/Documentation/RaidLocksDocumentation.lua deleted file mode 100644 index 87740c5..0000000 --- a/APIDocumentation/Documentation/RaidLocksDocumentation.lua +++ /dev/null @@ -1,36 +0,0 @@ -local RaidLocks = -{ - Name = "RaidLocks", - Type = "System", - Namespace = "C_RaidLocks", - - Functions = - { - { - Name = "IsEncounterComplete", - Type = "Function", - - 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 }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(RaidLocks); \ No newline at end of file diff --git a/APIDocumentation/Documentation/RecruitAFriendDocumentation.lua b/APIDocumentation/Documentation/RecruitAFriendDocumentation.lua new file mode 100644 index 0000000..7a255ba --- /dev/null +++ b/APIDocumentation/Documentation/RecruitAFriendDocumentation.lua @@ -0,0 +1,112 @@ +local RecruitAFriend = +{ + Name = "Recruit Friend", + Type = "System", + Namespace = "Recruit Friend", + + Functions = + { + { + Name = "AcceptLevelGrant", + Type = "Function", + + }, + { + Name = "CanGrantLevel", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "canGrant", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSummonFriend", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "canSummon", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DeclineLevelGrant", + Type = "Function", + + }, + { + Name = "GetSummonFriendCooldown", + Type = "Function", + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "GrantLevel", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "canGrant", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsReferAFriendLinked", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isLinked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SummonFriend", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "canSummon", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(RecruitAFriend); diff --git a/APIDocumentation/Documentation/RecruitAFriendSharedDocumentation.lua b/APIDocumentation/Documentation/RecruitAFriendSharedDocumentation.lua deleted file mode 100644 index 78f28a3..0000000 --- a/APIDocumentation/Documentation/RecruitAFriendSharedDocumentation.lua +++ /dev/null @@ -1,36 +0,0 @@ -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/APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua b/APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua deleted file mode 100644 index 6bfdb03..0000000 --- a/APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua +++ /dev/null @@ -1,73 +0,0 @@ -local ReportSystemConstants = -{ - Tables = - { - { - Name = "ReportMajorCategory", - Type = "Enumeration", - NumValues = 4, - MinValue = 0, - MaxValue = 3, - 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 = "ReportMinorCategory", - Type = "Enumeration", - NumValues = 15, - MinValue = 1, - MaxValue = 16384, - 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 = "ReportType", - Type = "Enumeration", - NumValues = 16, - MinValue = 0, - MaxValue = 15, - 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(ReportSystemConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ReportSystemDocumentation.lua b/APIDocumentation/Documentation/ReportSystemDocumentation.lua deleted file mode 100644 index 746abcd..0000000 --- a/APIDocumentation/Documentation/ReportSystemDocumentation.lua +++ /dev/null @@ -1,134 +0,0 @@ -local ReportSystem = -{ - Name = "ReportSystem", - Type = "System", - Namespace = "C_ReportSystem", - - Functions = - { - { - Name = "CanReportPlayer", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "canReport", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CanReportPlayerForLanguage", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "canReport", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetMajorCategoriesForReportType", - Type = "Function", - - Arguments = - { - { Name = "reportType", Type = "ReportType", Nilable = false }, - }, - - Returns = - { - { Name = "majorCategories", Type = "table", InnerType = "ReportMajorCategory", Nilable = false }, - }, - }, - { - Name = "GetMajorCategoryString", - Type = "Function", - - Arguments = - { - { Name = "majorCategory", Type = "ReportMajorCategory", Nilable = false }, - }, - - Returns = - { - { Name = "majorCategoryString", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetMinorCategoriesForReportTypeAndMajorCategory", - Type = "Function", - - 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", - - Arguments = - { - { Name = "minorCategory", Type = "ReportMinorCategory", Nilable = false }, - }, - - Returns = - { - { Name = "minorCategoryString", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ReportServerLag", - Type = "Function", - }, - { - Name = "ReportStuckInCombat", - Type = "Function", - }, - { - Name = "SendReport", - Type = "Function", - 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 }, - }, - }, - }, - - Events = - { - { - Name = "ReportPlayerResult", - Type = "Event", - LiteralName = "REPORT_PLAYER_RESULT", - Payload = - { - { Name = "success", Type = "bool", Nilable = false }, - { Name = "reportType", Type = "ReportType", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ReportSystem); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ReputationInfoDocumentation.lua b/APIDocumentation/Documentation/ReputationInfoDocumentation.lua deleted file mode 100644 index eb391e0..0000000 --- a/APIDocumentation/Documentation/ReputationInfoDocumentation.lua +++ /dev/null @@ -1,70 +0,0 @@ -local ReputationInfo = -{ - Name = "ReputationInfo", - Type = "System", - Namespace = "C_Reputation", - - Functions = - { - { - Name = "GetFactionParagonInfo", - Type = "Function", - - 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 = "IsFactionParagon", - Type = "Function", - - Arguments = - { - { Name = "factionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasParagon", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RequestFactionParagonPreloadRewardData", - Type = "Function", - - Arguments = - { - { Name = "factionID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetWatchedFaction", - Type = "Function", - - Arguments = - { - { Name = "factionID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ReputationInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/RestrictedActionsDocumentation.lua b/APIDocumentation/Documentation/RestrictedActionsDocumentation.lua deleted file mode 100644 index 6974657..0000000 --- a/APIDocumentation/Documentation/RestrictedActionsDocumentation.lua +++ /dev/null @@ -1,58 +0,0 @@ -local RestrictedActions = -{ - Name = "RestrictedActions", - Type = "System", - Namespace = "C_RestrictedActions", - - Functions = - { - }, - - Events = - { - { - Name = "AddonActionBlocked", - Type = "Event", - LiteralName = "ADDON_ACTION_BLOCKED", - Payload = - { - { Name = "isTainted", Type = "cstring", Nilable = false }, - { Name = "function", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "AddonActionForbidden", - Type = "Event", - LiteralName = "ADDON_ACTION_FORBIDDEN", - Payload = - { - { Name = "isTainted", Type = "cstring", Nilable = false }, - { Name = "function", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "MacroActionBlocked", - Type = "Event", - LiteralName = "MACRO_ACTION_BLOCKED", - Payload = - { - { Name = "function", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "MacroActionForbidden", - Type = "Event", - LiteralName = "MACRO_ACTION_FORBIDDEN", - Payload = - { - { Name = "function", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(RestrictedActions); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ScreenDocumentation.lua b/APIDocumentation/Documentation/ScreenDocumentation.lua deleted file mode 100644 index c396b87..0000000 --- a/APIDocumentation/Documentation/ScreenDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local Screen = -{ - Name = "Screen", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Screen); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ScriptRegionSharedDocumentation.lua b/APIDocumentation/Documentation/ScriptRegionSharedDocumentation.lua deleted file mode 100644 index 0aa577a..0000000 --- a/APIDocumentation/Documentation/ScriptRegionSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local ScriptRegionShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ScriptRegionShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ScriptWarningsDocumentation.lua b/APIDocumentation/Documentation/ScriptWarningsDocumentation.lua deleted file mode 100644 index e3fb029..0000000 --- a/APIDocumentation/Documentation/ScriptWarningsDocumentation.lua +++ /dev/null @@ -1,30 +0,0 @@ -local ScriptWarnings = -{ - Name = "ScriptWarnings", - Type = "System", - Namespace = "C_ScriptWarnings", - - Functions = - { - }, - - Events = - { - { - Name = "LuaWarning", - Type = "Event", - LiteralName = "LUA_WARNING", - Payload = - { - { Name = "warnType", Type = "number", Nilable = false }, - { Name = "warningText", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(ScriptWarnings); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ScriptedAnimationsDocumentation.lua b/APIDocumentation/Documentation/ScriptedAnimationsDocumentation.lua deleted file mode 100644 index 84b34e5..0000000 --- a/APIDocumentation/Documentation/ScriptedAnimationsDocumentation.lua +++ /dev/null @@ -1,107 +0,0 @@ -local ScriptedAnimations = -{ - Name = "ScriptedAnimations", - Type = "System", - Namespace = "C_ScriptedAnimations", - - Functions = - { - { - Name = "GetAllScriptedAnimationEffects", - Type = "Function", - - Returns = - { - { Name = "scriptedAnimationEffects", Type = "table", InnerType = "ScriptedAnimationEffect", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - 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/APIDocumentation/Documentation/SeasonsConstantsDocumentation.lua b/APIDocumentation/Documentation/SeasonsConstantsDocumentation.lua deleted file mode 100644 index c2fa4c2..0000000 --- a/APIDocumentation/Documentation/SeasonsConstantsDocumentation.lua +++ /dev/null @@ -1,21 +0,0 @@ -local SeasonsConstants = -{ - Tables = - { - { - Name = "SeasonID", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "NoSeason", Type = "SeasonID", EnumValue = 0 }, - { Name = "SeasonOfMastery", Type = "SeasonID", EnumValue = 1 }, - { Name = "Placeholder", Type = "SeasonID", EnumValue = 2 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(SeasonsConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SeasonsDocumentation.lua b/APIDocumentation/Documentation/SeasonsDocumentation.lua deleted file mode 100644 index 03e9e24..0000000 --- a/APIDocumentation/Documentation/SeasonsDocumentation.lua +++ /dev/null @@ -1,38 +0,0 @@ -local Seasons = -{ - Name = "SeasonsScripts", - Type = "System", - Namespace = "C_Seasons", - - Functions = - { - { - Name = "GetActiveSeason", - Type = "Function", - - Returns = - { - { Name = "seasonID", Type = "number", Nilable = true }, - }, - }, - { - Name = "HasActiveSeason", - Type = "Function", - - Returns = - { - { Name = "value", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(Seasons); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SecureExecutionUtilityDocumentation.lua b/APIDocumentation/Documentation/SecureExecutionUtilityDocumentation.lua new file mode 100644 index 0000000..ae524b5 --- /dev/null +++ b/APIDocumentation/Documentation/SecureExecutionUtilityDocumentation.lua @@ -0,0 +1,101 @@ +local SecureExecutionUtility = +{ + Name = "Secure Execution Utility", + Type = "System", + Namespace = "Secure Execution Utility", + + Functions = + { + { + Name = "InCombatLockdown", + Type = "Function", + + Returns = + { + { Name = "inLockdown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "forceinsecure", + Type = "Function", + + }, + { + Name = "hooksecurefunc", + Type = "Function", + + Arguments = + { + { Name = "table", Type = "table", Nilable = true }, + { Name = "function", Type = "string", Nilable = false }, + { Name = "hookfunc", Type = "function", Nilable = false }, + }, + + }, + { + Name = "issecure", + Type = "Function", + + Returns = + { + { Name = "secure", Type = "bool", Nilable = false }, + }, + }, + { + Name = "issecurevariable", + Type = "Function", + + Arguments = + { + { Name = "table", Type = "table", Nilable = true }, + { Name = "variable", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "issecure", Type = "bool", Nilable = false }, + { Name = "taint", Type = "string", Nilable = false }, + }, + }, + { + Name = "newproxy", + Type = "Function", + + Arguments = + { + { Name = "boolean", Type = "bool", Nilable = true }, + { Name = "userdata", Type = "userdata", Nilable = true }, + }, + + Returns = + { + { Name = "userdata", Type = "userdata", Nilable = false }, + }, + }, + { + Name = "securecall", + Type = "Function", + + Arguments = + { + { Name = "function", Type = "function", Nilable = false }, + { Name = "...", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SecureExecutionUtility); diff --git a/APIDocumentation/Documentation/SecureTransferDocumentation.lua b/APIDocumentation/Documentation/SecureTransferDocumentation.lua deleted file mode 100644 index bf40fe4..0000000 --- a/APIDocumentation/Documentation/SecureTransferDocumentation.lua +++ /dev/null @@ -1,35 +0,0 @@ -local SecureTransfer = -{ - Name = "SecureTransfer", - Type = "System", - Namespace = "C_SecureTransfer", - - Functions = - { - }, - - Events = - { - { - Name = "SecureTransferCancel", - Type = "Event", - LiteralName = "SECURE_TRANSFER_CANCEL", - }, - { - Name = "SecureTransferConfirmSendMail", - Type = "Event", - LiteralName = "SECURE_TRANSFER_CONFIRM_SEND_MAIL", - }, - { - Name = "SecureTransferConfirmTradeAccept", - Type = "Event", - LiteralName = "SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SecureTransfer); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SharedScriptObjectModelLightDocumentation.lua b/APIDocumentation/Documentation/SharedScriptObjectModelLightDocumentation.lua deleted file mode 100644 index b271b9b..0000000 --- a/APIDocumentation/Documentation/SharedScriptObjectModelLightDocumentation.lua +++ /dev/null @@ -1,21 +0,0 @@ -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/APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua b/APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua deleted file mode 100644 index ac17963..0000000 --- a/APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua +++ /dev/null @@ -1,21 +0,0 @@ -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/APIDocumentation/Documentation/SharedTraitsDocumentation.lua b/APIDocumentation/Documentation/SharedTraitsDocumentation.lua deleted file mode 100644 index dbfe11d..0000000 --- a/APIDocumentation/Documentation/SharedTraitsDocumentation.lua +++ /dev/null @@ -1,822 +0,0 @@ -local SharedTraits = -{ - Name = "SharedTraits", - Type = "System", - Namespace = "C_Traits", - - Functions = - { - { - Name = "CanPurchaseRank", - Type = "Function", - - 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", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "canRefund", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CascadeRepurchaseRanks", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ClearCascadeRepurchaseHistory", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - }, - { - Name = "CloseTraitSystemInteraction", - Type = "Function", - }, - { - Name = "CommitConfig", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ConfigHasStagedChanges", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasChanges", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GenerateInspectImportString", - Type = "Function", - - Arguments = - { - { Name = "target", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "importString", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetConditionInfo", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "condID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "condInfo", Type = "TraitCondInfo", Nilable = false }, - }, - }, - { - Name = "GetConfigIDBySystemID", - Type = "Function", - - Arguments = - { - { Name = "systemID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetConfigIDByTreeID", - Type = "Function", - - Arguments = - { - { Name = "treeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetConfigInfo", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "configInfo", Type = "TraitConfigInfo", Nilable = false }, - }, - }, - { - Name = "GetConfigsByType", - Type = "Function", - - Arguments = - { - { Name = "configType", Type = "TraitConfigType", Nilable = false }, - }, - - Returns = - { - { Name = "configIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetDefinitionInfo", - Type = "Function", - - Arguments = - { - { Name = "definitionID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "definitionInfo", Type = "TraitDefinitionInfo", Nilable = false }, - }, - }, - { - Name = "GetEntryInfo", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "entryID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "entryInfo", Type = "TraitEntryInfo", Nilable = false }, - }, - }, - { - Name = "GetLoadoutSerializationVersion", - Type = "Function", - - Returns = - { - { Name = "serializationVersion", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNodeCost", - Type = "Function", - - 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", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "nodeInfo", Type = "TraitNodeInfo", Nilable = false }, - }, - }, - { - Name = "GetStagedChangesCost", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "costs", Type = "table", InnerType = "TraitCurrencyCost", Nilable = false }, - }, - }, - { - Name = "GetStagedPurchases", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "nodeIDsWithPurchases", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetTraitCurrencyInfo", - Type = "Function", - - 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", - - Arguments = - { - { Name = "entryID", Type = "number", Nilable = false }, - { Name = "rank", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "description", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetTraitSystemFlags", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "flags", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetTraitSystemWidgetSetID", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "uiWidgetSetID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetTreeCurrencyInfo", - Type = "Function", - - 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", - - Arguments = - { - { Name = "treeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "result", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - { - Name = "GetTreeInfo", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "treeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "treeInfo", Type = "TraitTreeInfo", Nilable = false }, - }, - }, - { - Name = "GetTreeNodes", - Type = "Function", - 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 = "PurchaseRank", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RefundAllRanks", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RefundRank", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ResetTree", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "treeID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ResetTreeByCurrency", - Type = "Function", - - 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", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetSelection", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - { Name = "nodeID", Type = "number", Nilable = false }, - { Name = "nodeEntryID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "StageConfig", - Type = "Function", - - Arguments = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "TalentTestUnlearnSpells", - Type = "Function", - }, - }, - - Events = - { - { - Name = "ConfigCommitFailed", - Type = "Event", - LiteralName = "CONFIG_COMMIT_FAILED", - Payload = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitCondInfoChanged", - Type = "Event", - LiteralName = "TRAIT_COND_INFO_CHANGED", - Payload = - { - { Name = "condID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitConfigCreated", - Type = "Event", - LiteralName = "TRAIT_CONFIG_CREATED", - Payload = - { - { Name = "configInfo", Type = "TraitConfigInfo", Nilable = false }, - }, - }, - { - Name = "TraitConfigDeleted", - Type = "Event", - LiteralName = "TRAIT_CONFIG_DELETED", - Payload = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitConfigListUpdated", - Type = "Event", - LiteralName = "TRAIT_CONFIG_LIST_UPDATED", - }, - { - Name = "TraitConfigUpdated", - Type = "Event", - LiteralName = "TRAIT_CONFIG_UPDATED", - Payload = - { - { Name = "configID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitNodeChanged", - Type = "Event", - LiteralName = "TRAIT_NODE_CHANGED", - Payload = - { - { Name = "nodeID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitNodeChangedPartial", - Type = "Event", - LiteralName = "TRAIT_NODE_CHANGED_PARTIAL", - Payload = - { - { Name = "ID", Type = "number", Nilable = false }, - { Name = "info", Type = "TraitNodeInfoPartial", Nilable = false }, - }, - }, - { - Name = "TraitNodeEntryUpdated", - Type = "Event", - LiteralName = "TRAIT_NODE_ENTRY_UPDATED", - Payload = - { - { Name = "nodeEntryID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitSystemInteractionStarted", - Type = "Event", - LiteralName = "TRAIT_SYSTEM_INTERACTION_STARTED", - Payload = - { - { Name = "treeID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitSystemNpcClosed", - Type = "Event", - LiteralName = "TRAIT_SYSTEM_NPC_CLOSED", - }, - { - Name = "TraitTreeChanged", - Type = "Event", - LiteralName = "TRAIT_TREE_CHANGED", - Payload = - { - { Name = "treeID", Type = "number", Nilable = false }, - }, - }, - { - Name = "TraitTreeCurrencyInfoUpdated", - Type = "Event", - LiteralName = "TRAIT_TREE_CURRENCY_INFO_UPDATED", - Payload = - { - { Name = "treeID", Type = "number", Nilable = false }, - }, - }, - }, - - Tables = - { - { - 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 }, - { Name = "isGate", Type = "bool", Nilable = false }, - { 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 = "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 = false }, - { Name = "type", Type = "TraitNodeEntryType", Nilable = false }, - { Name = "maxRanks", Type = "number", Nilable = false }, - { Name = "isAvailable", Type = "bool", Nilable = false }, - { 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 = "ranksPurchased", Type = "number", Nilable = false }, - { 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 = "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 = "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 = "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 = "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 = "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/APIDocumentation/Documentation/SharedTraitsEnumsDocumentation.lua b/APIDocumentation/Documentation/SharedTraitsEnumsDocumentation.lua deleted file mode 100644 index e8ea08d..0000000 --- a/APIDocumentation/Documentation/SharedTraitsEnumsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local SharedTraitsEnums = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SharedTraitsEnums); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua deleted file mode 100644 index d30f8c4..0000000 --- a/APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua +++ /dev/null @@ -1,441 +0,0 @@ -local SimpleAnimAPI = -{ - Name = "SimpleAnimAPI", - Type = "ScriptObject", - - 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", - - 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", - - Arguments = - { - { Name = "scriptName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "hasScript", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HookScript", - Type = "Function", - - 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", - - Arguments = - { - { Name = "childKey", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetDuration", - Type = "Function", - - Arguments = - { - { Name = "durationSec", Type = "number", Nilable = false }, - { Name = "recomputeGroupDuration", Type = "bool", Nilable = false, Default = true }, - }, - }, - { - Name = "SetEndDelay", - Type = "Function", - - Arguments = - { - { Name = "delaySec", Type = "number", Nilable = false }, - { Name = "recomputeGroupDuration", Type = "bool", Nilable = false, Default = true }, - }, - }, - { - Name = "SetOrder", - Type = "Function", - - Arguments = - { - { Name = "newOrder", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetParent", - Type = "Function", - - Arguments = - { - { Name = "parent", Type = "SimpleAnimGroup", Nilable = false }, - { Name = "order", Type = "number", Nilable = true }, - }, - }, - { - Name = "SetPlaying", - Type = "Function", - - Arguments = - { - { Name = "play", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetScript", - Type = "Function", - - Arguments = - { - { Name = "scriptTypeName", Type = "cstring", Nilable = false }, - { Name = "script", Type = "luaFunction", Nilable = true }, - }, - }, - { - Name = "SetSmoothProgress", - Type = "Function", - - Arguments = - { - { Name = "durationSec", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSmoothing", - Type = "Function", - - Arguments = - { - { Name = "weights", Type = "SmoothingType", Nilable = false }, - }, - }, - { - Name = "SetStartDelay", - Type = "Function", - - Arguments = - { - { Name = "delaySec", Type = "number", Nilable = false }, - { Name = "recomputeGroupDuration", Type = "bool", Nilable = false, Default = true }, - }, - }, - { - Name = "SetTarget", - Type = "Function", - - Arguments = - { - { Name = "target", Type = "CScriptObject", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetTargetKey", - Type = "Function", - - Arguments = - { - { Name = "key", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetTargetName", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleAnimAlphaAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimAlphaAPIDocumentation.lua deleted file mode 100644 index 77c882a..0000000 --- a/APIDocumentation/Documentation/SimpleAnimAlphaAPIDocumentation.lua +++ /dev/null @@ -1,63 +0,0 @@ -local SimpleAnimAlphaAPI = -{ - Name = "SimpleAnimAlphaAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "normalizedAlpha", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetToAlpha", - Type = "Function", - - Arguments = - { - { Name = "normalizedAlpha", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimAlphaAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimFlipBookAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimFlipBookAPIDocumentation.lua deleted file mode 100644 index 0cd6180..0000000 --- a/APIDocumentation/Documentation/SimpleAnimFlipBookAPIDocumentation.lua +++ /dev/null @@ -1,129 +0,0 @@ -local SimpleAnimFlipBookAPI = -{ - Name = "SimpleAnimFlipBookAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "columns", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFlipBookFrameHeight", - Type = "Function", - - Arguments = - { - { Name = "height", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFlipBookFrameWidth", - Type = "Function", - - Arguments = - { - { Name = "width", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFlipBookFrames", - Type = "Function", - - Arguments = - { - { Name = "frames", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFlipBookRows", - Type = "Function", - - Arguments = - { - { Name = "rows", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimFlipBookAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimGroupAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimGroupAPIDocumentation.lua deleted file mode 100644 index 90ea8c5..0000000 --- a/APIDocumentation/Documentation/SimpleAnimGroupAPIDocumentation.lua +++ /dev/null @@ -1,342 +0,0 @@ -local SimpleAnimGroupAPI = -{ - Name = "SimpleAnimGroupAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CreateAnimation", - Type = "Function", - - 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 = "scriptObject", Type = "ScriptObject", 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", - - Arguments = - { - { Name = "scriptTypeName", Type = "cstring", Nilable = false }, - { Name = "bindingType", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "script", Type = "luaFunction", Nilable = false }, - }, - }, - { - Name = "HasScript", - Type = "Function", - - Arguments = - { - { Name = "scriptName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "hasScript", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HookScript", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "reverse", Type = "bool", Nilable = false, Default = false }, - { Name = "offset", Type = "number", Nilable = false, Default = 0 }, - }, - }, - { - Name = "SetAnimationSpeedMultiplier", - Type = "Function", - - Arguments = - { - { Name = "animationSpeedMultiplier", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLooping", - Type = "Function", - - Arguments = - { - { Name = "loopType", Type = "LoopType", Nilable = false }, - }, - }, - { - Name = "SetPlaying", - Type = "Function", - - Arguments = - { - { Name = "play", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetScript", - Type = "Function", - - Arguments = - { - { Name = "scriptTypeName", Type = "cstring", Nilable = false }, - { Name = "script", Type = "luaFunction", Nilable = true }, - }, - }, - { - Name = "SetToFinalAlpha", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleAnimPathAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimPathAPIDocumentation.lua deleted file mode 100644 index 32f1d65..0000000 --- a/APIDocumentation/Documentation/SimpleAnimPathAPIDocumentation.lua +++ /dev/null @@ -1,83 +0,0 @@ -local SimpleAnimPathAPI = -{ - Name = "SimpleAnimPathAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CreateControlPoint", - Type = "Function", - - 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 = "scriptObject", Type = "ScriptObject", 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", - - Arguments = - { - { Name = "curveType", Type = "CurveType", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimPathAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimRotationAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimRotationAPIDocumentation.lua deleted file mode 100644 index 966ec88..0000000 --- a/APIDocumentation/Documentation/SimpleAnimRotationAPIDocumentation.lua +++ /dev/null @@ -1,89 +0,0 @@ -local SimpleAnimRotationAPI = -{ - Name = "SimpleAnimRotationAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "angle", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetOrigin", - Type = "Function", - - Arguments = - { - { Name = "point", Type = "FramePoint", Nilable = false }, - { Name = "originX", Type = "number", Nilable = false }, - { Name = "originY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetRadians", - Type = "Function", - - Arguments = - { - { Name = "angle", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimRotationAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimScaleAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimScaleAPIDocumentation.lua deleted file mode 100644 index 9872adb..0000000 --- a/APIDocumentation/Documentation/SimpleAnimScaleAPIDocumentation.lua +++ /dev/null @@ -1,117 +0,0 @@ -local SimpleAnimScaleAPI = -{ - Name = "SimpleAnimScaleAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "point", Type = "FramePoint", Nilable = false }, - { Name = "originX", Type = "number", Nilable = false }, - { Name = "originY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetScale", - Type = "Function", - - Arguments = - { - { Name = "scaleX", Type = "number", Nilable = false }, - { Name = "scaleY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetScaleFrom", - Type = "Function", - - Arguments = - { - { Name = "scaleX", Type = "number", Nilable = false }, - { Name = "scaleY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetScaleTo", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleAnimScaleLineAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimScaleLineAPIDocumentation.lua deleted file mode 100644 index e1054b2..0000000 --- a/APIDocumentation/Documentation/SimpleAnimScaleLineAPIDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local SimpleAnimScaleLineAPI = -{ - Name = "SimpleAnimScaleLineAPI", - Type = "ScriptObject", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimScaleLineAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimTextureCoordTranslationAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimTextureCoordTranslationAPIDocumentation.lua deleted file mode 100644 index bf50085..0000000 --- a/APIDocumentation/Documentation/SimpleAnimTextureCoordTranslationAPIDocumentation.lua +++ /dev/null @@ -1,43 +0,0 @@ -local SimpleAnimTextureCoordTranslationAPI = -{ - Name = "SimpleAnimTextureCoordTranslationAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetOffset", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "offsetU", Type = "number", Nilable = false }, - { Name = "offsetV", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetOffset", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleAnimTranslationAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimTranslationAPIDocumentation.lua deleted file mode 100644 index 78e8d3e..0000000 --- a/APIDocumentation/Documentation/SimpleAnimTranslationAPIDocumentation.lua +++ /dev/null @@ -1,43 +0,0 @@ -local SimpleAnimTranslationAPI = -{ - Name = "SimpleAnimTranslationAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetOffset", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "offsetX", Type = "uiUnit", Nilable = false }, - { Name = "offsetY", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetOffset", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleAnimTranslationLineAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimTranslationLineAPIDocumentation.lua deleted file mode 100644 index 54219bb..0000000 --- a/APIDocumentation/Documentation/SimpleAnimTranslationLineAPIDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local SimpleAnimTranslationLineAPI = -{ - Name = "SimpleAnimTranslationLineAPI", - Type = "ScriptObject", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimTranslationLineAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimatableObjectAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimatableObjectAPIDocumentation.lua deleted file mode 100644 index 2dc3585..0000000 --- a/APIDocumentation/Documentation/SimpleAnimatableObjectAPIDocumentation.lua +++ /dev/null @@ -1,55 +0,0 @@ -local SimpleAnimatableObjectAPI = -{ - Name = "SimpleAnimatableObjectAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CreateAnimationGroup", - Type = "Function", - - 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 = "scriptObject", Type = "ScriptObject", Nilable = false, StrideIndex = 1 }, - }, - }, - { - Name = "StopAnimating", - Type = "Function", - - Arguments = - { - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleAnimatableObjectAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleBrowserAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleBrowserAPIDocumentation.lua deleted file mode 100644 index 2215c7e..0000000 --- a/APIDocumentation/Documentation/SimpleBrowserAPIDocumentation.lua +++ /dev/null @@ -1,128 +0,0 @@ -local SimpleBrowserAPI = -{ - Name = "SimpleBrowserAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "urlType", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "NavigateReload", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "NavigateStop", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "NavigateTo", - Type = "Function", - Documentation = { "Not functional in public builds" }, - - Arguments = - { - { Name = "url", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "OpenExternalLink", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "OpenTicket", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFocus", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "SetZoom", - Type = "Function", - - Arguments = - { - { Name = "zoom", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleBrowserAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleButtonAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleButtonAPIDocumentation.lua deleted file mode 100644 index 02b042c..0000000 --- a/APIDocumentation/Documentation/SimpleButtonAPIDocumentation.lua +++ /dev/null @@ -1,482 +0,0 @@ -local SimpleButtonAPI = -{ - Name = "SimpleButtonAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "button", Type = "cstring", Nilable = false, Default = "LeftButton" }, - { Name = "isDown", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "Disable", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "Enable", - Type = "Function", - - 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", - - 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 = "LockHighlight", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "RegisterForClicks", - Type = "Function", - - Arguments = - { - { Name = "unpackedPrimitiveType", Type = "number", Nilable = false, StrideIndex = 1 }, - }, - }, - { - Name = "RegisterForMouse", - Type = "Function", - - Arguments = - { - { Name = "unpackedPrimitiveType", Type = "number", Nilable = false, StrideIndex = 1 }, - }, - }, - { - Name = "SetButtonState", - Type = "Function", - - Arguments = - { - { Name = "buttonState", Type = "SimpleButtonStateToken", Nilable = false }, - { Name = "lock", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDisabledAtlas", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - }, - }, - { - Name = "SetDisabledFontObject", - Type = "Function", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetDisabledTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetEnabled", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetFontString", - Type = "Function", - - Arguments = - { - { Name = "fontString", Type = "SimpleFontString", Nilable = false }, - }, - }, - { - Name = "SetFormattedText", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetHighlightAtlas", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - { Name = "blendMode", Type = "BlendMode", Nilable = true }, - }, - }, - { - Name = "SetHighlightFontObject", - Type = "Function", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetHighlightLocked", - Type = "Function", - - Arguments = - { - { Name = "locked", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetHighlightTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - { Name = "blendMode", Type = "BlendMode", Nilable = true }, - }, - }, - { - Name = "SetMotionScriptsWhileDisabled", - Type = "Function", - - Arguments = - { - { Name = "motionScriptsWhileDisabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetNormalAtlas", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - }, - }, - { - Name = "SetNormalFontObject", - Type = "Function", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetNormalTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetPushedAtlas", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - }, - }, - { - Name = "SetPushedTextOffset", - Type = "Function", - - Arguments = - { - { Name = "offsetX", Type = "uiUnit", Nilable = false }, - { Name = "offsetY", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetPushedTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetText", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false, Default = "" }, - }, - }, - { - Name = "UnlockHighlight", - Type = "Function", - - Arguments = - { - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleButtonAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleCheckboxAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleCheckboxAPIDocumentation.lua deleted file mode 100644 index aa659fa..0000000 --- a/APIDocumentation/Documentation/SimpleCheckboxAPIDocumentation.lua +++ /dev/null @@ -1,85 +0,0 @@ -local SimpleCheckboxAPI = -{ - Name = "SimpleCheckboxAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "checked", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetCheckedTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetDisabledCheckedTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleCheckboxAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleColorSelectAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleColorSelectAPIDocumentation.lua deleted file mode 100644 index 0a1f5ab..0000000 --- a/APIDocumentation/Documentation/SimpleColorSelectAPIDocumentation.lua +++ /dev/null @@ -1,167 +0,0 @@ -local SimpleColorSelectAPI = -{ - Name = "SimpleColorSelectAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "ClearColorWheelTexture", - Type = "Function", - - Arguments = - { - }, - }, - { - 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 = "SetColorHSV", - Type = "Function", - - Arguments = - { - { Name = "hsvX", Type = "number", Nilable = false }, - { Name = "hsvY", Type = "number", Nilable = false }, - { Name = "hsvZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetColorRGB", - Type = "Function", - - Arguments = - { - { Name = "rgbR", Type = "number", Nilable = false }, - { Name = "rgbG", Type = "number", Nilable = false }, - { Name = "rgbB", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetColorValueTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - }, - }, - { - Name = "SetColorValueThumbTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetColorWheelTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - }, - }, - { - Name = "SetColorWheelThumbTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "TextureAsset", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleColorSelectAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleControlPointAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleControlPointAPIDocumentation.lua deleted file mode 100644 index d29c36a..0000000 --- a/APIDocumentation/Documentation/SimpleControlPointAPIDocumentation.lua +++ /dev/null @@ -1,75 +0,0 @@ -local SimpleControlPointAPI = -{ - Name = "SimpleControlPointAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "offsetX", Type = "uiUnit", Nilable = false }, - { Name = "offsetY", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetOrder", - Type = "Function", - - Arguments = - { - { Name = "order", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetParent", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleEditBoxAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleEditBoxAPIDocumentation.lua deleted file mode 100644 index 6634a8d..0000000 --- a/APIDocumentation/Documentation/SimpleEditBoxAPIDocumentation.lua +++ /dev/null @@ -1,839 +0,0 @@ -local SimpleEditBoxAPI = -{ - Name = "SimpleEditBoxAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "AddHistoryLine", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "cursorPosition", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetDisplayText", - Type = "Function", - - 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 = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "GetJustifyV", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "justifyV", Type = "TBFStyleFlags", 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", - - Arguments = - { - }, - - Returns = - { - { Name = "numLetters", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumber", - Type = "Function", - - 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", - - 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", - - 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", - - Arguments = - { - { Name = "start", Type = "number", Nilable = false, Default = 0 }, - { Name = "stop", Type = "number", Nilable = false, Default = -1 }, - }, - }, - { - Name = "Insert", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", 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 = "IsPassword", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isPassword", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsSecureText", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isSecure", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetAltArrowKeyMode", - Type = "Function", - - Arguments = - { - { Name = "altMode", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetAutoFocus", - Type = "Function", - - Arguments = - { - { Name = "autoFocus", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetBlinkSpeed", - Type = "Function", - - Arguments = - { - { Name = "cursorBlinkSpeedSec", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCountInvisibleLetters", - Type = "Function", - - Arguments = - { - { Name = "countInvisibleLetters", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetCursorPosition", - Type = "Function", - - Arguments = - { - { Name = "cursorPosition", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetEnabled", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetFocus", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "SetFont", - Type = "Function", - - 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", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetHighlightColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "numHistoryLines", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetIndentedWordWrap", - Type = "Function", - - Arguments = - { - { Name = "isIndented", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetJustifyH", - Type = "Function", - - Arguments = - { - { Name = "justifyH", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetJustifyV", - Type = "Function", - - Arguments = - { - { Name = "justifyV", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetMaxBytes", - Type = "Function", - - Arguments = - { - { Name = "maxBytes", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMaxLetters", - Type = "Function", - - Arguments = - { - { Name = "maxLetters", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMultiLine", - Type = "Function", - - Arguments = - { - { Name = "multiline", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetNumber", - Type = "Function", - - Arguments = - { - { Name = "number", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetNumeric", - Type = "Function", - - Arguments = - { - { Name = "isNumeric", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetPassword", - Type = "Function", - - Arguments = - { - { Name = "isPassword", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetSecureText", - Type = "Function", - - Arguments = - { - { Name = "isSecure", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetSecurityDisablePaste", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "SetSecurityDisableSetText", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "SetShadowColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "offsetX", Type = "number", Nilable = false }, - { Name = "offsetY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpacing", - Type = "Function", - - Arguments = - { - { Name = "fontHeight", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetText", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetTextColor", - Type = "Function", - - 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", - - 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", - - 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/APIDocumentation/Documentation/SimpleFontAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleFontAPIDocumentation.lua deleted file mode 100644 index fc94384..0000000 --- a/APIDocumentation/Documentation/SimpleFontAPIDocumentation.lua +++ /dev/null @@ -1,266 +0,0 @@ -local SimpleFontAPI = -{ - Name = "SimpleFontAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CopyFontObject", - Type = "Function", - - 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 = "GetFontObject", - Type = "Function", - - Arguments = - { - }, - - 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 = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "GetJustifyV", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "justifyV", Type = "TBFStyleFlags", 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", - - Arguments = - { - { Name = "alpha", Type = "SingleColorValue", Nilable = false }, - }, - }, - { - Name = "SetFont", - Type = "Function", - - Arguments = - { - { Name = "fontFile", Type = "cstring", Nilable = false }, - { Name = "height", Type = "uiFontHeight", Nilable = false }, - { Name = "flags", Type = "TBFFlags", Nilable = false }, - }, - }, - { - Name = "SetFontObject", - Type = "Function", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetIndentedWordWrap", - Type = "Function", - - Arguments = - { - { Name = "wordWrap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetJustifyH", - Type = "Function", - - Arguments = - { - { Name = "justifyH", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetJustifyV", - Type = "Function", - - Arguments = - { - { Name = "justifyV", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetShadowColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "offsetX", Type = "number", Nilable = false }, - { Name = "offsetY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpacing", - Type = "Function", - - Arguments = - { - { Name = "spacing", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetTextColor", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleFontStringAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleFontStringAPIDocumentation.lua deleted file mode 100644 index 2b8184f..0000000 --- a/APIDocumentation/Documentation/SimpleFontStringAPIDocumentation.lua +++ /dev/null @@ -1,544 +0,0 @@ -local SimpleFontStringAPI = -{ - Name = "SimpleFontStringAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CalculateScreenAreaFromCharacterSpan", - Type = "Function", - - Arguments = - { - { Name = "leftIndex", Type = "luaIndex", Nilable = false }, - { Name = "rightIndex", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "areas", Type = "table", InnerType = "uiRect", 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 = "FindCharacterIndexAtCoordinate", - Type = "Function", - - 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 = "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 = "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 = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "GetJustifyV", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "justifyH", Type = "TBFStyleFlags", 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", - - Arguments = - { - }, - - Returns = - { - { Name = "numLines", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetRotation", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "radians", Type = "number", 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", - - Arguments = - { - }, - - Returns = - { - { Name = "height", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetStringWidth", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "width", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetText", - Type = "Function", - - 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 = "GetTextScale", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "textScale", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetUnboundedStringWidth", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "width", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetWrappedWidth", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "width", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "IsTruncated", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isTruncated", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetAlphaGradient", - Type = "Function", - - Arguments = - { - { Name = "start", Type = "number", Nilable = false }, - { Name = "length", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isWithinText", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFixedColor", - Type = "Function", - - Arguments = - { - { Name = "fixedColor", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFont", - Type = "Function", - - Arguments = - { - { Name = "fontFile", Type = "cstring", Nilable = false }, - { Name = "fontHeight", Type = "uiUnit", Nilable = false }, - { Name = "flags", Type = "TBFFlags", Nilable = false }, - }, - }, - { - Name = "SetFontObject", - Type = "Function", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetFormattedText", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetIndentedWordWrap", - Type = "Function", - - Arguments = - { - { Name = "wrap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetJustifyH", - Type = "Function", - - Arguments = - { - { Name = "justifyH", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetJustifyV", - Type = "Function", - - Arguments = - { - { Name = "justifyV", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetMaxLines", - Type = "Function", - - Arguments = - { - { Name = "maxLines", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetNonSpaceWrap", - Type = "Function", - - Arguments = - { - { Name = "wrap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetRotation", - Type = "Function", - - Arguments = - { - { Name = "radians", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetShadowColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "offsetX", Type = "number", Nilable = false }, - { Name = "offsetY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpacing", - Type = "Function", - - Arguments = - { - { Name = "spacing", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetText", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false, Default = "" }, - }, - }, - { - Name = "SetTextColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "height", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetTextScale", - Type = "Function", - - Arguments = - { - { Name = "textScale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetWordWrap", - Type = "Function", - - Arguments = - { - { Name = "wrap", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleFontStringAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleFrameAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleFrameAPIDocumentation.lua deleted file mode 100644 index afc53a7..0000000 --- a/APIDocumentation/Documentation/SimpleFrameAPIDocumentation.lua +++ /dev/null @@ -1,1072 +0,0 @@ -local SimpleFrameAPI = -{ - Name = "SimpleFrameAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CanChangeAttribute", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "canChangeAttributes", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CreateFontString", - Type = "Function", - - 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", - - 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", - - 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", - - 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", - - Arguments = - { - { Name = "desaturation", Type = "number", Nilable = false }, - { Name = "excludeRoot", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "DisableDrawLayer", - Type = "Function", - - Arguments = - { - { Name = "layer", Type = "DrawLayer", Nilable = false }, - }, - }, - { - Name = "DoesClipChildren", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "clipsChildren", Type = "bool", Nilable = false }, - }, - }, - { - Name = "EnableDrawLayer", - Type = "Function", - - Arguments = - { - { Name = "layer", Type = "DrawLayer", Nilable = false }, - }, - }, - { - Name = "EnableGamePadButton", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "EnableGamePadStick", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "EnableKeyboard", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "ExecuteAttribute", - Type = "Function", - - Arguments = - { - { Name = "attributeName", Type = "cstring", Nilable = false }, - { Name = "unpackedPrimitiveType", Type = "string", Nilable = false, StrideIndex = 1 }, - }, - - Returns = - { - { Name = "success", Type = "bool", Nilable = false }, - { Name = "unpackedPrimitiveType", Type = "string", Nilable = false, StrideIndex = 1 }, - }, - }, - { - Name = "GetAlpha", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "alpha", Type = "SingleColorValue", Nilable = false }, - }, - }, - { - Name = "GetAttribute", - Type = "Function", - - 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 }, - { Name = "bottom", Type = "uiUnit", Nilable = false }, - { Name = "width", Type = "uiUnit", Nilable = false }, - { Name = "height", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetChildren", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "scriptObject", Type = "ScriptObject", 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", - - Arguments = - { - }, - - Returns = - { - { Name = "effectiveAlpha", Type = "SingleColorValue", Nilable = false }, - }, - }, - { - Name = "GetEffectiveScale", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "frameLevel", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetFrameStrata", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "strata", Type = "FrameStrata", Nilable = false }, - }, - }, - { - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "id", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumChildren", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "numChildren", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumRegions", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "numRegions", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetPropagateKeyboardInput", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "propagate", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetRegions", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "scriptObject", Type = "ScriptObject", 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", - - Arguments = - { - }, - - Returns = - { - { Name = "frameScale", Type = "number", 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", - - Arguments = - { - }, - }, - { - Name = "IsClampedToScreen", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "clampedToScreen", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsEventRegistered", - Type = "Function", - - Arguments = - { - { Name = "eventName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "isRegistered", Type = "bool", Nilable = false }, - { Name = "units", Type = "string", Nilable = true, StrideIndex = 1 }, - }, - }, - { - 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 = "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", - - Arguments = - { - }, - - Returns = - { - { Name = "isShown", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsToplevel", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isTopLevel", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsUserPlaced", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isUserPlaced", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsVisible", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isVisible", Type = "bool", Nilable = false }, - }, - }, - { - Name = "Lower", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "Raise", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "RegisterAllEvents", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "RegisterEvent", - Type = "Function", - - Arguments = - { - { Name = "eventName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "registered", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RegisterForDrag", - Type = "Function", - - Arguments = - { - { Name = "unpackedPrimitiveType", Type = "number", Nilable = false, StrideIndex = 1 }, - }, - }, - { - Name = "RegisterUnitEvent", - Type = "Function", - - Arguments = - { - { Name = "eventName", Type = "cstring", Nilable = false }, - { Name = "units", Type = "string", Nilable = false, StrideIndex = 1 }, - }, - - Returns = - { - { Name = "registered", Type = "bool", Nilable = false }, - }, - }, - { - Name = "RotateTextures", - Type = "Function", - - 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", - - Arguments = - { - { Name = "alpha", Type = "SingleColorValue", Nilable = false }, - }, - }, - { - Name = "SetAttribute", - Type = "Function", - - Arguments = - { - { Name = "attributeName", Type = "cstring", Nilable = false }, - { Name = "value", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetAttributeNoHandler", - Type = "Function", - - Arguments = - { - { Name = "attributeName", Type = "cstring", Nilable = false }, - { Name = "value", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetClampRectInsets", - Type = "Function", - - 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", - - Arguments = - { - { Name = "clampedToScreen", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetClipsChildren", - Type = "Function", - - Arguments = - { - { Name = "clipsChildren", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetDontSavePosition", - Type = "Function", - - Arguments = - { - { Name = "dontSave", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetDrawLayerEnabled", - Type = "Function", - - Arguments = - { - { Name = "layer", Type = "DrawLayer", Nilable = false }, - { Name = "isEnabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetFixedFrameLevel", - Type = "Function", - - Arguments = - { - { Name = "isFixed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFixedFrameStrata", - Type = "Function", - - Arguments = - { - { Name = "isFixed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFlattensRenderLayers", - Type = "Function", - - Arguments = - { - { Name = "flatten", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFrameLevel", - Type = "Function", - - Arguments = - { - { Name = "frameLevel", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFrameStrata", - Type = "Function", - - Arguments = - { - { Name = "strata", Type = "FrameStrata", Nilable = false }, - }, - }, - { - Name = "SetHitRectInsets", - Type = "Function", - - 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 = "SetHyperlinksEnabled", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetID", - Type = "Function", - - Arguments = - { - { Name = "id", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetIgnoreParentAlpha", - Type = "Function", - - Arguments = - { - { Name = "ignore", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetIgnoreParentScale", - Type = "Function", - - Arguments = - { - { Name = "ignore", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetIsFrameBuffer", - Type = "Function", - - Arguments = - { - { Name = "isFrameBuffer", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetMovable", - Type = "Function", - - Arguments = - { - { Name = "movable", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetPropagateKeyboardInput", - Type = "Function", - - Arguments = - { - { Name = "propagate", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetResizable", - Type = "Function", - - Arguments = - { - { Name = "resizable", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetResizeBounds", - Type = "Function", - - 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", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetShown", - Type = "Function", - - Arguments = - { - { Name = "shown", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetToplevel", - Type = "Function", - - Arguments = - { - { Name = "topLevel", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetUserPlaced", - Type = "Function", - - Arguments = - { - { Name = "userPlaced", Type = "bool", Nilable = false }, - }, - }, - { - Name = "Show", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "StartMoving", - Type = "Function", - - Arguments = - { - { Name = "alwaysStartFromMouse", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "StartSizing", - Type = "Function", - - Arguments = - { - { Name = "resizePoint", Type = "FramePoint", Nilable = true }, - { Name = "alwaysStartFromMouse", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "StopMovingOrSizing", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "UnregisterAllEvents", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "UnregisterEvent", - Type = "Function", - - Arguments = - { - { Name = "eventName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "registered", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleFrameAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleFrameScriptObjectAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleFrameScriptObjectAPIDocumentation.lua deleted file mode 100644 index 64cbccf..0000000 --- a/APIDocumentation/Documentation/SimpleFrameScriptObjectAPIDocumentation.lua +++ /dev/null @@ -1,80 +0,0 @@ -local SimpleFrameScriptObjectAPI = -{ - Name = "SimpleFrameScriptObjectAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetName", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GetObjectType", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "objectType", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "IsForbidden", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isForbidden", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsObjectType", - Type = "Function", - - Arguments = - { - { Name = "objectType", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "isType", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetForbidden", - Type = "Function", - - Arguments = - { - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleFrameScriptObjectAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleHTMLAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleHTMLAPIDocumentation.lua deleted file mode 100644 index 5c7a76f..0000000 --- a/APIDocumentation/Documentation/SimpleHTMLAPIDocumentation.lua +++ /dev/null @@ -1,311 +0,0 @@ -local SimpleHTMLAPI = -{ - Name = "SimpleHTMLAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetContentHeight", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "height", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetFont", - Type = "Function", - - 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", - - 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", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - }, - - Returns = - { - { Name = "wordWrap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetJustifyH", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - }, - - Returns = - { - { Name = "justifyH", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "GetJustifyV", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - }, - - Returns = - { - { Name = "justifyV", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "GetShadowColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - }, - - Returns = - { - { Name = "offsetX", Type = "number", Nilable = false }, - { Name = "offsetY", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetSpacing", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - }, - - Returns = - { - { Name = "spacing", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetTextColor", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "content", Type = "table", InnerType = "HTMLContentNode", Nilable = false }, - }, - }, - { - Name = "SetFont", - Type = "Function", - - 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", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetHyperlinkFormat", - Type = "Function", - - Arguments = - { - { Name = "format", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetIndentedWordWrap", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - { Name = "wordWrap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetJustifyH", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - { Name = "justifyH", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetJustifyV", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - { Name = "justifyV", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetShadowColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - { Name = "offsetX", Type = "number", Nilable = false }, - { Name = "offsetY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpacing", - Type = "Function", - - Arguments = - { - { Name = "textType", Type = "HTMLTextType", Nilable = false }, - { Name = "spacing", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetText", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "ignoreMarkup", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetTextColor", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleHTMLSharedDocumentation.lua b/APIDocumentation/Documentation/SimpleHTMLSharedDocumentation.lua deleted file mode 100644 index c043fe7..0000000 --- a/APIDocumentation/Documentation/SimpleHTMLSharedDocumentation.lua +++ /dev/null @@ -1,18 +0,0 @@ -local SimpleHTMLShared = -{ - Tables = - { - { - Name = "HTMLContentNode", - Type = "Structure", - Fields = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "type", Type = "HTMLTextType", Nilable = false }, - { Name = "align", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleHTMLShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua deleted file mode 100644 index add9288..0000000 --- a/APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua +++ /dev/null @@ -1,105 +0,0 @@ -local SimpleLineAPI = -{ - Name = "SimpleLineAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "ClearAllPoints", - Type = "Function", - - 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 = "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", - - 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 = "SetStartPoint", - Type = "Function", - - 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", - - Arguments = - { - { Name = "thickness", Type = "uiUnit", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleLineAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleMaskTextureAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleMaskTextureAPIDocumentation.lua deleted file mode 100644 index 0a1eb72..0000000 --- a/APIDocumentation/Documentation/SimpleMaskTextureAPIDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local SimpleMaskTextureAPI = -{ - Name = "SimpleMaskTextureAPI", - Type = "ScriptObject", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleMaskTextureAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleMessageFrameAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleMessageFrameAPIDocumentation.lua deleted file mode 100644 index 8a7ef04..0000000 --- a/APIDocumentation/Documentation/SimpleMessageFrameAPIDocumentation.lua +++ /dev/null @@ -1,404 +0,0 @@ -local SimpleMessageFrameAPI = -{ - Name = "SimpleMessageFrameAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "AddMessage", - Type = "Function", - - 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", - - 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 = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "GetJustifyV", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "justifyV", Type = "TBFStyleFlags", 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", - - Arguments = - { - { Name = "messageID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasMessage", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ResetMessageFadeByID", - Type = "Function", - - Arguments = - { - { Name = "messageID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFadeDuration", - Type = "Function", - - Arguments = - { - { Name = "fadeDurationSeconds", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFadePower", - Type = "Function", - - Arguments = - { - { Name = "fadePower", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFading", - Type = "Function", - - Arguments = - { - { Name = "fading", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetFont", - Type = "Function", - - Arguments = - { - { Name = "fontFile", Type = "cstring", Nilable = false }, - { Name = "height", Type = "uiFontHeight", Nilable = false }, - { Name = "flags", Type = "TBFFlags", Nilable = false }, - }, - }, - { - Name = "SetFontObject", - Type = "Function", - - Arguments = - { - { Name = "font", Type = "SimpleFont", Nilable = false }, - }, - }, - { - Name = "SetIndentedWordWrap", - Type = "Function", - - Arguments = - { - { Name = "wordWrap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetInsertMode", - Type = "Function", - - Arguments = - { - { Name = "mode", Type = "InsertMode", Nilable = false }, - }, - }, - { - Name = "SetJustifyH", - Type = "Function", - - Arguments = - { - { Name = "justifyH", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetJustifyV", - Type = "Function", - - Arguments = - { - { Name = "justifyV", Type = "TBFStyleFlags", Nilable = false }, - }, - }, - { - Name = "SetShadowColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "offsetX", Type = "number", Nilable = false }, - { Name = "offsetY", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpacing", - Type = "Function", - - Arguments = - { - { Name = "spacing", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetTextColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "timeVisibleSeconds", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleMessageFrameAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleModelAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleModelAPIDocumentation.lua deleted file mode 100644 index 611aa84..0000000 --- a/APIDocumentation/Documentation/SimpleModelAPIDocumentation.lua +++ /dev/null @@ -1,723 +0,0 @@ -local SimpleModelAPI = -{ - Name = "SimpleModelAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "asset", Type = "FileAsset", Nilable = false }, - }, - }, - { - Name = "SetCamera", - Type = "Function", - - Arguments = - { - { Name = "cameraIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraDistance", - Type = "Function", - - Arguments = - { - { Name = "distance", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraFacing", - Type = "Function", - - Arguments = - { - { Name = "radians", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraPosition", - Type = "Function", - - Arguments = - { - { Name = "positionX", Type = "number", Nilable = false }, - { Name = "positionY", Type = "number", Nilable = false }, - { Name = "positionZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraRoll", - Type = "Function", - - Arguments = - { - { Name = "radians", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCameraTarget", - Type = "Function", - - Arguments = - { - { Name = "targetX", Type = "number", Nilable = false }, - { Name = "targetY", Type = "number", Nilable = false }, - { Name = "targetZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetCustomCamera", - Type = "Function", - - Arguments = - { - { Name = "cameraIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetDesaturation", - Type = "Function", - - Arguments = - { - { Name = "strength", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFacing", - Type = "Function", - - Arguments = - { - { Name = "facing", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFogColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "fogFar", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetFogNear", - Type = "Function", - - Arguments = - { - { Name = "fogNear", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetGlow", - Type = "Function", - - Arguments = - { - { Name = "glow", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetLight", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false }, - { Name = "light", Type = "ModelLight", Nilable = false }, - }, - }, - { - Name = "SetModel", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "ModelAsset", Nilable = false }, - { Name = "noMip", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetModelAlpha", - Type = "Function", - - Arguments = - { - { Name = "alpha", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetModelDrawLayer", - Type = "Function", - - Arguments = - { - { Name = "layer", Type = "DrawLayer", Nilable = false }, - }, - }, - { - Name = "SetModelScale", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetParticlesEnabled", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetPaused", - Type = "Function", - - Arguments = - { - { Name = "paused", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetPitch", - Type = "Function", - - Arguments = - { - { Name = "pitch", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetPosition", - Type = "Function", - - Arguments = - { - { Name = "positionX", Type = "number", Nilable = false }, - { Name = "positionY", Type = "number", Nilable = false }, - { Name = "positionZ", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetRoll", - Type = "Function", - - Arguments = - { - { Name = "roll", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSequence", - Type = "Function", - - Arguments = - { - { Name = "sequence", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSequenceTime", - Type = "Function", - - Arguments = - { - { Name = "sequence", Type = "number", Nilable = false }, - { Name = "timeOffset", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetShadowEffect", - Type = "Function", - - Arguments = - { - { Name = "strength", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetTransform", - Type = "Function", - - Arguments = - { - { Name = "translation", Type = "vector3", Mixin = "Vector3DMixin", Nilable = true }, - { Name = "rotation", Type = "vector3", Mixin = "Vector3DMixin", Nilable = true }, - { Name = "scale", Type = "number", Nilable = true }, - }, - }, - { - Name = "SetViewInsets", - Type = "Function", - - 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", - - Arguments = - { - { Name = "x", Type = "uiUnit", Nilable = false }, - { Name = "y", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "TransformCameraSpaceToModelSpace", - Type = "Function", - - Arguments = - { - { Name = "cameraPosition", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, - }, - - Returns = - { - { Name = "modelPosition", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false }, - }, - }, - { - Name = "UseModelCenterToTransform", - Type = "Function", - - Arguments = - { - { Name = "useCenter", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleModelAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleModelFFXAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleModelFFXAPIDocumentation.lua deleted file mode 100644 index 1451df3..0000000 --- a/APIDocumentation/Documentation/SimpleModelFFXAPIDocumentation.lua +++ /dev/null @@ -1,57 +0,0 @@ -local SimpleModelFFXAPI = -{ - Name = "SimpleModelFFXAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "AddCharacterLight", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "number", Nilable = true }, - { Name = "light", Type = "ModelLight", Nilable = false }, - }, - }, - { - Name = "AddLight", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "number", Nilable = true }, - { Name = "light", Type = "ModelLight", Nilable = false }, - }, - }, - { - Name = "AddPetLight", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleMovieAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleMovieAPIDocumentation.lua deleted file mode 100644 index 5c91a0f..0000000 --- a/APIDocumentation/Documentation/SimpleMovieAPIDocumentation.lua +++ /dev/null @@ -1,69 +0,0 @@ -local SimpleMovieAPI = -{ - Name = "SimpleMovieAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "EnableSubtitles", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false }, - }, - }, - { - Name = "StartMovie", - Type = "Function", - - 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", - - 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/APIDocumentation/Documentation/SimpleObjectAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleObjectAPIDocumentation.lua deleted file mode 100644 index 30b0f92..0000000 --- a/APIDocumentation/Documentation/SimpleObjectAPIDocumentation.lua +++ /dev/null @@ -1,68 +0,0 @@ -local SimpleObjectAPI = -{ - Name = "SimpleObjectAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetDebugName", - Type = "Function", - - Arguments = - { - { Name = "preferParentKey", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "debugName", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetParent", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "parent", Type = "CScriptObject", Nilable = false }, - }, - }, - { - Name = "GetParentKey", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "parentKey", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetParentKey", - Type = "Function", - - Arguments = - { - { Name = "parentKey", Type = "cstring", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleObjectAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleOffScreenFrameAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleOffScreenFrameAPIDocumentation.lua deleted file mode 100644 index d4a0fe4..0000000 --- a/APIDocumentation/Documentation/SimpleOffScreenFrameAPIDocumentation.lua +++ /dev/null @@ -1,120 +0,0 @@ -local SimpleOffScreenFrameAPI = -{ - Name = "SimpleOffScreenFrameAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "ApplySnapshot", - Type = "Function", - - 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", - - Arguments = - { - { Name = "snapshotID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isValid", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetMaxSnapshots", - Type = "Function", - - Arguments = - { - { Name = "maxSnapshots", Type = "number", Nilable = false }, - }, - }, - { - Name = "TakeSnapshot", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "snapshotID", Type = "number", Nilable = true }, - }, - }, - { - Name = "TestPrintToFile", - Type = "Function", - 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/APIDocumentation/Documentation/SimpleRegionAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleRegionAPIDocumentation.lua deleted file mode 100644 index 720e661..0000000 --- a/APIDocumentation/Documentation/SimpleRegionAPIDocumentation.lua +++ /dev/null @@ -1,185 +0,0 @@ -local SimpleRegionAPI = -{ - Name = "SimpleRegionAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetAlpha", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "effectiveScale", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetScale", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetVertexColor", - 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 = "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", - - Arguments = - { - { Name = "alpha", Type = "SingleColorValue", Nilable = false }, - }, - }, - { - Name = "SetDrawLayer", - Type = "Function", - - Arguments = - { - { Name = "layer", Type = "DrawLayer", Nilable = false }, - { Name = "sublevel", Type = "number", Nilable = false, Default = 0 }, - }, - }, - { - Name = "SetIgnoreParentAlpha", - Type = "Function", - - Arguments = - { - { Name = "ignore", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetIgnoreParentScale", - Type = "Function", - - Arguments = - { - { Name = "ignore", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetScale", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetVertexColor", - Type = "Function", - - 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(SimpleRegionAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleScriptRegionAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleScriptRegionAPIDocumentation.lua deleted file mode 100644 index 4fb1258..0000000 --- a/APIDocumentation/Documentation/SimpleScriptRegionAPIDocumentation.lua +++ /dev/null @@ -1,485 +0,0 @@ -local SimpleScriptRegionAPI = -{ - Name = "SimpleScriptRegionAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "CanChangeProtectedState", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "canChange", Type = "bool", Nilable = false }, - }, - }, - { - Name = "EnableMouse", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "EnableMouseMotion", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "EnableMouseWheel", - Type = "Function", - - Arguments = - { - { Name = "enable", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "GetBottom", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "bottom", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetCenter", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "x", Type = "uiUnit", Nilable = false }, - { Name = "y", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetHeight", - Type = "Function", - - Arguments = - { - { Name = "ignoreRect", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "height", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetLeft", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "left", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetRect", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "right", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetScaledRect", - Type = "Function", - - 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", - - Arguments = - { - { Name = "scriptTypeName", Type = "cstring", Nilable = false }, - { Name = "bindingType", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "script", Type = "luaFunction", Nilable = false }, - }, - }, - { - Name = "GetSize", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "location", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetTop", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "top", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetWidth", - Type = "Function", - - Arguments = - { - { Name = "ignoreRect", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "width", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "HasScript", - Type = "Function", - - Arguments = - { - { Name = "scriptName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "hasScript", Type = "bool", Nilable = false }, - }, - }, - { - Name = "Hide", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "HookScript", - Type = "Function", - - Arguments = - { - { Name = "scriptTypeName", Type = "cstring", Nilable = false }, - { Name = "script", Type = "luaFunction", Nilable = false }, - { Name = "bindingType", Type = "number", Nilable = true }, - }, - }, - { - Name = "IsAnchoringRestricted", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isRestricted", 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", - - 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", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "isShown", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsVisible", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "isVisible", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetMouseClickEnabled", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetMouseMotionEnabled", - Type = "Function", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetParent", - Type = "Function", - - Arguments = - { - { Name = "parent", Type = "SimpleFrame", Nilable = true }, - }, - }, - { - Name = "SetPassThroughButtons", - Type = "Function", - - Arguments = - { - { Name = "unpackedPrimitiveType", Type = "number", Nilable = false, StrideIndex = 1 }, - }, - }, - { - Name = "SetScript", - Type = "Function", - - Arguments = - { - { Name = "scriptTypeName", Type = "cstring", Nilable = false }, - { Name = "script", Type = "luaFunction", Nilable = true }, - }, - }, - { - Name = "SetShown", - Type = "Function", - - Arguments = - { - { Name = "show", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "Show", - Type = "Function", - - Arguments = - { - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleScriptRegionAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleScriptRegionResizingAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleScriptRegionResizingAPIDocumentation.lua deleted file mode 100644 index 45fffe0..0000000 --- a/APIDocumentation/Documentation/SimpleScriptRegionResizingAPIDocumentation.lua +++ /dev/null @@ -1,154 +0,0 @@ -local SimpleScriptRegionResizingAPI = -{ - Name = "SimpleScriptRegionResizingAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "AdjustPointsOffset", - Type = "Function", - - Arguments = - { - { Name = "x", Type = "uiUnit", Nilable = false }, - { Name = "y", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "ClearAllPoints", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "ClearPoint", - Type = "Function", - - Arguments = - { - { Name = "point", Type = "FramePoint", Nilable = false }, - }, - }, - { - Name = "ClearPointsOffset", - Type = "Function", - - Arguments = - { - }, - }, - { - Name = "GetNumPoints", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "numPoints", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetPoint", - Type = "Function", - - Arguments = - { - { Name = "anchorIndex", Type = "luaIndex", Nilable = false, Default = 0 }, - }, - - 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", - - Arguments = - { - { Name = "point", Type = "FramePoint", Nilable = 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", - - Arguments = - { - { Name = "relativeTo", Type = "ScriptRegion", Nilable = false }, - { Name = "doResize", Type = "bool", Nilable = false, Default = true }, - }, - }, - { - Name = "SetHeight", - Type = "Function", - - Arguments = - { - { Name = "height", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetPoint", - Type = "Function", - - 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 = "SetSize", - Type = "Function", - - Arguments = - { - { Name = "x", Type = "uiUnit", Nilable = false }, - { Name = "y", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetWidth", - Type = "Function", - - Arguments = - { - { Name = "width", Type = "uiUnit", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleScriptRegionResizingAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleScrollFrameAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleScrollFrameAPIDocumentation.lua deleted file mode 100644 index a425d89..0000000 --- a/APIDocumentation/Documentation/SimpleScrollFrameAPIDocumentation.lua +++ /dev/null @@ -1,119 +0,0 @@ -local SimpleScrollFrameAPI = -{ - Name = "SimpleScrollFrameAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetHorizontalScroll", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "offset", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "GetHorizontalScrollRange", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "range", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetHorizontalScroll", - Type = "Function", - - Arguments = - { - { Name = "offset", Type = "uiUnit", Nilable = false }, - }, - }, - { - Name = "SetScrollChild", - Type = "Function", - - Arguments = - { - { Name = "scrollChild", Type = "SimpleFrame", Nilable = false }, - }, - }, - { - Name = "SetVerticalScroll", - Type = "Function", - - 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/APIDocumentation/Documentation/SimpleSliderAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleSliderAPIDocumentation.lua deleted file mode 100644 index 62ddee4..0000000 --- a/APIDocumentation/Documentation/SimpleSliderAPIDocumentation.lua +++ /dev/null @@ -1,227 +0,0 @@ -local SimpleSliderAPI = -{ - Name = "SimpleSliderAPI", - Type = "ScriptObject", - - 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", - - Arguments = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetMinMaxValues", - Type = "Function", - - Arguments = - { - { Name = "minValue", Type = "number", Nilable = false }, - { Name = "maxValue", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetObeyStepOnDrag", - Type = "Function", - - Arguments = - { - { Name = "obeyStepOnDrag", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetOrientation", - Type = "Function", - - Arguments = - { - { Name = "orientation", Type = "Orientation", Nilable = false }, - }, - }, - { - Name = "SetStepsPerPage", - Type = "Function", - - Arguments = - { - { Name = "stepsPerPage", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetThumbTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetValue", - Type = "Function", - - Arguments = - { - { Name = "value", Type = "number", Nilable = false }, - { Name = "treatAsMouseEvent", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetValueStep", - Type = "Function", - - Arguments = - { - { Name = "valueStep", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleSliderAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleStatusBarAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleStatusBarAPIDocumentation.lua deleted file mode 100644 index 8ff757c..0000000 --- a/APIDocumentation/Documentation/SimpleStatusBarAPIDocumentation.lua +++ /dev/null @@ -1,259 +0,0 @@ -local SimpleStatusBarAPI = -{ - Name = "SimpleStatusBarAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "GetFillStyle", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "fillStyle", Type = "StatusBarFillStyle", Nilable = false }, - }, - }, - { - Name = "GetMinMaxValues", - Type = "Function", - - 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", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "desaturation", Type = "normalizedValue", Nilable = false }, - }, - }, - { - Name = "GetStatusBarTexture", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - }, - }, - { - Name = "GetValue", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "value", Type = "number", Nilable = false }, - }, - }, - { - Name = "IsStatusBarDesaturated", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "desaturated", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetColorFill", - Type = "Function", - - 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", - - Arguments = - { - { Name = "fillStyle", Type = "StatusBarFillStyle", Nilable = false }, - }, - }, - { - Name = "SetMinMaxValues", - Type = "Function", - - Arguments = - { - { Name = "minValue", Type = "number", Nilable = false }, - { Name = "maxValue", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetOrientation", - Type = "Function", - - Arguments = - { - { Name = "orientation", Type = "Orientation", Nilable = false }, - }, - }, - { - Name = "SetReverseFill", - Type = "Function", - - Arguments = - { - { Name = "isReverseFill", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetRotatesTexture", - Type = "Function", - - Arguments = - { - { Name = "rotatesTexture", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetStatusBarColor", - Type = "Function", - - 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", - - Arguments = - { - { Name = "desaturated", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetStatusBarDesaturation", - Type = "Function", - - Arguments = - { - { Name = "desaturation", Type = "normalizedValue", Nilable = false }, - }, - }, - { - Name = "SetStatusBarTexture", - Type = "Function", - - Arguments = - { - { Name = "asset", Type = "TextureAsset", Nilable = false }, - }, - }, - { - Name = "SetValue", - Type = "Function", - - Arguments = - { - { Name = "value", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleStatusBarAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleTextureAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleTextureAPIDocumentation.lua deleted file mode 100644 index bdbb124..0000000 --- a/APIDocumentation/Documentation/SimpleTextureAPIDocumentation.lua +++ /dev/null @@ -1,64 +0,0 @@ -local SimpleTextureAPI = -{ - Name = "SimpleTextureAPI", - Type = "ScriptObject", - - Functions = - { - { - Name = "AddMaskTexture", - Type = "Function", - - Arguments = - { - { Name = "mask", Type = "SimpleMaskTexture", Nilable = false }, - }, - }, - { - Name = "GetMaskTexture", - Type = "Function", - - Arguments = - { - { Name = "index", Type = "luaIndex", Nilable = false }, - }, - - Returns = - { - { Name = "mask", Type = "SimpleMaskTexture", Nilable = false }, - }, - }, - { - Name = "GetNumMaskTextures", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "count", Type = "size", Nilable = false }, - }, - }, - { - Name = "RemoveMaskTexture", - Type = "Function", - - Arguments = - { - { Name = "mask", Type = "SimpleMaskTexture", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SimpleTextureAPI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleTextureBaseAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleTextureBaseAPIDocumentation.lua deleted file mode 100644 index d06fc6f..0000000 --- a/APIDocumentation/Documentation/SimpleTextureBaseAPIDocumentation.lua +++ /dev/null @@ -1,384 +0,0 @@ -local SimpleTextureBaseAPI = -{ - Name = "SimpleTextureBaseAPI", - Type = "ScriptObject", - - Functions = - { - { - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "desaturation", Type = "normalizedValue", Nilable = false }, - }, - }, - { - Name = "GetHorizTile", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "tiling", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetRotation", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "radians", Type = "number", Nilable = false }, - { Name = "normalizedRotationPoint", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - }, - }, - { - Name = "GetTexCoord", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "x", Type = "number", Nilable = false, StrideIndex = 1 }, - { Name = "y", Type = "number", Nilable = false, StrideIndex = 2 }, - }, - }, - { - 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 = "GetVertTile", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "tiling", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetVertexOffset", - Type = "Function", - - 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", - - Arguments = - { - }, - - Returns = - { - { Name = "desaturated", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsSnappingToPixelGrid", - Type = "Function", - - Arguments = - { - }, - - Returns = - { - { Name = "snap", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetAtlas", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - { Name = "useAtlasSize", Type = "bool", Nilable = false, Default = false }, - { Name = "filterMode", Type = "FilterMode", Nilable = true }, - { Name = "resetTexCoords", Type = "bool", Nilable = true }, - }, - }, - { - Name = "SetBlendMode", - Type = "Function", - - Arguments = - { - { Name = "blendMode", Type = "BlendMode", Nilable = false }, - }, - }, - { - Name = "SetBlockingLoadsRequested", - Type = "Function", - - Arguments = - { - { Name = "blocking", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetColorTexture", - Type = "Function", - - 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", - - Arguments = - { - { Name = "desaturated", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDesaturation", - Type = "Function", - - Arguments = - { - { Name = "desaturation", Type = "normalizedValue", Nilable = false }, - }, - }, - { - Name = "SetGradient", - Type = "Function", - - 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", - - Arguments = - { - { Name = "tiling", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetMask", - Type = "Function", - - Arguments = - { - { Name = "file", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "SetRotation", - Type = "Function", - - Arguments = - { - { Name = "radians", Type = "number", Nilable = false }, - { Name = "normalizedRotationPoint", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, - }, - }, - { - Name = "SetSnapToPixelGrid", - Type = "Function", - - Arguments = - { - { Name = "snap", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetTexCoord", - Type = "Function", - - 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", - - Arguments = - { - { Name = "bias", Type = "normalizedValue", Nilable = false }, - }, - }, - { - Name = "SetTexture", - Type = "Function", - - 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 = "SetVertTile", - Type = "Function", - - Arguments = - { - { Name = "tiling", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetVertexOffset", - Type = "Function", - - 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/APIDocumentation/Documentation/SkillDocumentation.lua b/APIDocumentation/Documentation/SkillDocumentation.lua new file mode 100644 index 0000000..ee39a93 --- /dev/null +++ b/APIDocumentation/Documentation/SkillDocumentation.lua @@ -0,0 +1,99 @@ +local Skill = +{ + Name = "Skill", + Type = "System", + Namespace = "Skill", + + Functions = + { + { + Name = "AbandonSkill", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ExpandSkillHeader", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetNumSkillLines", + Type = "Function", + + Returns = + { + { Name = "numSkills", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSkillLineInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "skillName", Type = "string", Nilable = false }, + { Name = "header", Type = "bool", Nilable = false }, + { Name = "isExpanded", Type = "bool", Nilable = false }, + { Name = "skillRank", Type = "number", Nilable = false }, + { Name = "numTempPoints", Type = "number", Nilable = false }, + { Name = "skillModifier", Type = "number", Nilable = false }, + { Name = "skillMaxRank", Type = "number", Nilable = false }, + { Name = "isAbandonable", Type = "bool", Nilable = false }, + { Name = "stepCost", Type = "number", Nilable = false }, + { Name = "rankCost", Type = "number", Nilable = false }, + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "skillCostType", Type = "number", Nilable = false }, + { Name = "skillDescription", Type = "string", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ChatMsgSkill", + Type = "Event", + LiteralName = "CHAT_MSG_SKILL", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + { Name = "sender", Type = "string", Nilable = false }, + { Name = "language", Type = "string", Nilable = false }, + { Name = "channelString", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "flags", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "channelNumber", Type = "number", Nilable = false }, + { Name = "channelName", Type = "string", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "counter", Type = "number", Nilable = false }, + }, + }, + { + Name = "SkillLinesChanged", + Type = "Event", + LiteralName = "SKILL_LINES_CHANGED", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Skill); diff --git a/APIDocumentation/Documentation/SkillInfoDocumentation.lua b/APIDocumentation/Documentation/SkillInfoDocumentation.lua deleted file mode 100644 index 5db428d..0000000 --- a/APIDocumentation/Documentation/SkillInfoDocumentation.lua +++ /dev/null @@ -1,25 +0,0 @@ -local SkillInfo = -{ - Name = "SkillInfo", - Type = "System", - Namespace = "C_SkillInfo", - - Functions = - { - }, - - Events = - { - { - Name = "SkillLinesChanged", - Type = "Event", - LiteralName = "SKILL_LINES_CHANGED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SkillInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SocialDocumentation.lua b/APIDocumentation/Documentation/SocialDocumentation.lua new file mode 100644 index 0000000..9bd5ada --- /dev/null +++ b/APIDocumentation/Documentation/SocialDocumentation.lua @@ -0,0 +1,255 @@ +local Social = +{ + Name = "Social", + Type = "System", + Namespace = "Social", + + Functions = + { + { + Name = "AddFriend", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "AddIgnore", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "AddOrDelIgnore", + Type = "Function", + + Arguments = + { + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "AddOrRemoveFriend", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + }, + + }, + { + Name = "DelIgnore", + Type = "Function", + + Arguments = + { + { Name = "fullname", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GetFriendInfo", + Type = "Function", + + Arguments = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "givenName", Type = "Kstring", Nilable = false }, + { Name = "surname", Type = "Kstring", Nilable = false }, + { Name = "toonName", Type = "string", Nilable = false }, + { Name = "toonID", Type = "number", Nilable = false }, + { Name = "client", Type = "string", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "lastOnline", Type = "number", Nilable = false }, + { Name = "isAFK", Type = "bool", Nilable = false }, + { Name = "isDND", Type = "bool", Nilable = false }, + { Name = "messageText", Type = "string", Nilable = false }, + { Name = "noteText", Type = "string", Nilable = false }, + { Name = "isFriend", Type = "bool", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIgnoreName", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumFriends", + Type = "Function", + + Returns = + { + { Name = "totalBNet", Type = "number", Nilable = false }, + { Name = "numBNetOnline", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumIgnores", + Type = "Function", + + Returns = + { + { Name = "numIgnores", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumWhoResults", + Type = "Function", + + Returns = + { + { Name = "numResults", Type = "number", Nilable = false }, + { Name = "totalCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedFriend", + Type = "Function", + + Returns = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetSelectedIgnore", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetWhoInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "guild", Type = "string", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "race", Type = "string", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "zone", Type = "string", Nilable = false }, + { Name = "filename", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsIgnored", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isIgnored", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RemoveFriend", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SendWho", + Type = "Function", + + Arguments = + { + { Name = "filter", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetSelectedFriend", + Type = "Function", + + }, + { + Name = "SetSelectedIgnore", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetWhoToUI", + Type = "Function", + + Arguments = + { + { Name = "state", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ShowFriends", + Type = "Function", + + }, + { + Name = "SortWho", + Type = "Function", + + Arguments = + { + { Name = "sortType", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Social); diff --git a/APIDocumentation/Documentation/SocialInfoDocumentation.lua b/APIDocumentation/Documentation/SocialInfoDocumentation.lua deleted file mode 100644 index 1b764d7..0000000 --- a/APIDocumentation/Documentation/SocialInfoDocumentation.lua +++ /dev/null @@ -1,56 +0,0 @@ -local SocialInfo = -{ - Name = "SocialInfo", - Type = "System", - Namespace = "C_Social", - - Functions = - { - }, - - Events = - { - { - Name = "SocialItemReceived", - Type = "Event", - LiteralName = "SOCIAL_ITEM_RECEIVED", - }, - { - Name = "TwitterLinkResult", - Type = "Event", - LiteralName = "TWITTER_LINK_RESULT", - Payload = - { - { Name = "isLinked", Type = "bool", Nilable = false }, - { Name = "screenName", Type = "cstring", Nilable = false }, - { Name = "error", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "TwitterPostResult", - Type = "Event", - LiteralName = "TWITTER_POST_RESULT", - Payload = - { - { Name = "result", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "TwitterStatusUpdate", - Type = "Event", - LiteralName = "TWITTER_STATUS_UPDATE", - Payload = - { - { Name = "isTwitterEnabled", Type = "bool", Nilable = false }, - { Name = "isLinked", Type = "bool", Nilable = false }, - { Name = "screenName", Type = "cstring", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SocialInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SocialQueueDocumentation.lua b/APIDocumentation/Documentation/SocialQueueDocumentation.lua deleted file mode 100644 index 58bad1e..0000000 --- a/APIDocumentation/Documentation/SocialQueueDocumentation.lua +++ /dev/null @@ -1,87 +0,0 @@ -local SocialQueue = -{ - Name = "SocialQueue", - Type = "System", - Namespace = "C_SocialQueue", - - Functions = - { - }, - - Events = - { - }, - - 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 = "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/APIDocumentation/Documentation/SocialRestrictionsDocumentation.lua b/APIDocumentation/Documentation/SocialRestrictionsDocumentation.lua deleted file mode 100644 index 2fe74db..0000000 --- a/APIDocumentation/Documentation/SocialRestrictionsDocumentation.lua +++ /dev/null @@ -1,92 +0,0 @@ -local SocialRestrictions = -{ - Name = "SocialRestrictions", - Type = "System", - Namespace = "C_SocialRestrictions", - - Functions = - { - { - Name = "AcknowledgeRegionalChatDisabled", - Type = "Function", - }, - { - Name = "IsChatDisabled", - Type = "Function", - - Returns = - { - { Name = "isDisabled", 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", - - Arguments = - { - { Name = "disabled", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "AlertRegionalChatDisabled", - Type = "Event", - LiteralName = "ALERT_REGIONAL_CHAT_DISABLED", - }, - { - Name = "ChatDisabledChangeFailed", - Type = "Event", - LiteralName = "CHAT_DISABLED_CHANGE_FAILED", - Payload = - { - { Name = "disabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "ChatDisabledChanged", - Type = "Event", - LiteralName = "CHAT_DISABLED_CHANGED", - Payload = - { - { Name = "disabled", Type = "bool", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SocialRestrictions); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SocketingDocumentation.lua b/APIDocumentation/Documentation/SocketingDocumentation.lua new file mode 100644 index 0000000..49c58f7 --- /dev/null +++ b/APIDocumentation/Documentation/SocketingDocumentation.lua @@ -0,0 +1,201 @@ +local Socketing = +{ + Name = "Socketing", + Type = "System", + Namespace = "Socketing", + + Functions = + { + { + Name = "AcceptSockets", + Type = "Function", + + }, + { + Name = "ClickSocketButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CloseSocketInfo", + Type = "Function", + + }, + { + Name = "GetExistingSocketInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetExistingSocketLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetItemGem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetNewSocketInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "matches", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNewSocketLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetNumSockets", + Type = "Function", + + Returns = + { + { Name = "numSockets", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSocketItemBoundTradeable", + Type = "Function", + + Returns = + { + { Name = "tradeable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSocketItemInfo", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + }, + }, + { + Name = "GetSocketItemRefundable", + Type = "Function", + + Returns = + { + { Name = "refundable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSocketTypes", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "gemColor", Type = "string", Nilable = false }, + }, + }, + { + Name = "SocketContainerItem", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SocketInventoryItem", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "SocketInfoClose", + Type = "Event", + LiteralName = "SOCKET_INFO_CLOSE", + }, + { + Name = "SocketInfoUpdate", + Type = "Event", + LiteralName = "SOCKET_INFO_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Socketing); diff --git a/APIDocumentation/Documentation/SoftTargetConstantsDocumentation.lua b/APIDocumentation/Documentation/SoftTargetConstantsDocumentation.lua deleted file mode 100644 index ac20d70..0000000 --- a/APIDocumentation/Documentation/SoftTargetConstantsDocumentation.lua +++ /dev/null @@ -1,22 +0,0 @@ -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/APIDocumentation/Documentation/SoundDocumentation.lua b/APIDocumentation/Documentation/SoundDocumentation.lua index 2f4a1d8..6246d13 100644 --- a/APIDocumentation/Documentation/SoundDocumentation.lua +++ b/APIDocumentation/Documentation/SoundDocumentation.lua @@ -2,47 +2,175 @@ local Sound = { Name = "Sound", Type = "System", - Namespace = "C_Sound", + Namespace = "Sound", Functions = { { - Name = "GetSoundScaledVolume", + Name = "PlayMusic", Type = "Function", Arguments = { - { Name = "soundHandle", Type = "number", Nilable = false }, + { Name = "musicfile", Type = "string", Nilable = false }, + }, + + }, + { + Name = "PlaySound", + Type = "Function", + + Arguments = + { + { Name = "sound", Type = "string", Nilable = false }, + }, + + }, + { + Name = "PlaySoundFile", + Type = "Function", + + Arguments = + { + { Name = "soundFile", Type = "string", Nilable = false }, + }, + + }, + { + Name = "Sound_ChatSystem_GetInputDriverNameByIndex", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "Sound_ChatSystem_GetNumInputDrivers", + Type = "Function", + + }, + { + Name = "Sound_ChatSystem_GetNumOutputDrivers", + Type = "Function", + + }, + { + Name = "Sound_ChatSystem_GetOutputDriverNameByIndex", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "Sound_GameSystem_GetInputDriverNameByIndex", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "Sound_GameSystem_GetNumInputDrivers", + Type = "Function", + + }, + { + Name = "Sound_GameSystem_GetNumOutputDrivers", + Type = "Function", + + }, + { + Name = "Sound_GameSystem_GetOutputDriverNameByIndex", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "Sound_GameSystem_RestartSoundSystem", + Type = "Function", + + }, + { + Name = "StopMusic", + Type = "Function", + + }, + { + Name = "VoiceEnumerateCaptureDevices", + Type = "Function", + + Arguments = + { + { Name = "deviceIndex", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "scaledVolume", Type = "number", Nilable = false }, + { Name = "deviceName", Type = "string", Nilable = false }, }, }, { - Name = "IsPlaying", + Name = "VoiceEnumerateOutputDevices", Type = "Function", Arguments = { - { Name = "soundHandle", Type = "number", Nilable = false }, + { Name = "deviceIndex", Type = "luaIndex", Nilable = false }, }, Returns = { - { Name = "isPlaying", Type = "bool", Nilable = false }, + { Name = "device", Type = "string", Nilable = false }, }, }, { - Name = "PlayItemSound", + Name = "VoiceGetCurrentCaptureDevice", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "VoiceGetCurrentOutputDevice", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "VoiceSelectCaptureDevice", Type = "Function", Arguments = { - { Name = "soundType", Type = "ItemSoundType", Nilable = false }, - { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + { Name = "deviceName", Type = "string", Nilable = false }, }, + + }, + { + Name = "VoiceSelectOutputDevice", + Type = "Function", + + Arguments = + { + { Name = "deviceName", Type = "string", Nilable = false }, + }, + }, }, @@ -53,15 +181,6 @@ local Sound = Type = "Event", LiteralName = "SOUND_DEVICE_UPDATE", }, - { - Name = "SoundkitFinished", - Type = "Event", - LiteralName = "SOUNDKIT_FINISHED", - Payload = - { - { Name = "soundHandle", Type = "number", Nilable = false }, - }, - }, }, Tables = @@ -69,4 +188,4 @@ local Sound = }, }; -APIDocumentation:AddDocumentationTable(Sound); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Sound); diff --git a/APIDocumentation/Documentation/SpecializationInfoDocumentation.lua b/APIDocumentation/Documentation/SpecializationInfoDocumentation.lua deleted file mode 100644 index c75f3d5..0000000 --- a/APIDocumentation/Documentation/SpecializationInfoDocumentation.lua +++ /dev/null @@ -1,76 +0,0 @@ -local SpecializationInfo = -{ - Name = "SpecializationInfo", - Type = "System", - Namespace = "C_SpecializationInfo", - - Functions = - { - }, - - Events = - { - { - Name = "ConfirmPetUnlearn", - Type = "Event", - LiteralName = "CONFIRM_PET_UNLEARN", - Payload = - { - { Name = "cost", Type = "number", Nilable = false }, - }, - }, - { - Name = "ConfirmTalentWipe", - Type = "Event", - LiteralName = "CONFIRM_TALENT_WIPE", - Payload = - { - { Name = "cost", Type = "number", Nilable = false }, - { Name = "respecType", Type = "number", Nilable = false }, - }, - }, - { - Name = "TalentsInvoluntarilyReset", - Type = "Event", - LiteralName = "TALENTS_INVOLUNTARILY_RESET", - 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 = "selectedTalentID", Type = "number", Nilable = true }, - { Name = "availableTalentIDs", Type = "table", InnerType = "number", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(SpecializationInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SpecializationSharedDocumentation.lua b/APIDocumentation/Documentation/SpecializationSharedDocumentation.lua deleted file mode 100644 index f298249..0000000 --- a/APIDocumentation/Documentation/SpecializationSharedDocumentation.lua +++ /dev/null @@ -1,35 +0,0 @@ -local SpecializationShared = -{ - Name = "SpecializationShared", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - { - 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/APIDocumentation/Documentation/SpellActivationOverlayDocumentation.lua b/APIDocumentation/Documentation/SpellActivationOverlayDocumentation.lua deleted file mode 100644 index 34b5e87..0000000 --- a/APIDocumentation/Documentation/SpellActivationOverlayDocumentation.lua +++ /dev/null @@ -1,62 +0,0 @@ -local SpellActivationOverlay = -{ - Name = "SpellActivationOverlay", - Type = "System", - Namespace = "C_SpellActivationOverlay", - - Functions = - { - }, - - Events = - { - { - Name = "SpellActivationOverlayGlowHide", - Type = "Event", - LiteralName = "SPELL_ACTIVATION_OVERLAY_GLOW_HIDE", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SpellActivationOverlayGlowShow", - Type = "Event", - LiteralName = "SPELL_ACTIVATION_OVERLAY_GLOW_SHOW", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SpellActivationOverlayHide", - Type = "Event", - LiteralName = "SPELL_ACTIVATION_OVERLAY_HIDE", - Payload = - { - { Name = "spellID", Type = "number", Nilable = true }, - }, - }, - { - Name = "SpellActivationOverlayShow", - Type = "Event", - LiteralName = "SPELL_ACTIVATION_OVERLAY_SHOW", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - { Name = "overlayFileDataID", Type = "number", Nilable = false }, - { Name = "locationName", Type = "cstring", 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/APIDocumentation/Documentation/SpellBookDocumentation.lua b/APIDocumentation/Documentation/SpellBookDocumentation.lua deleted file mode 100644 index db87653..0000000 --- a/APIDocumentation/Documentation/SpellBookDocumentation.lua +++ /dev/null @@ -1,149 +0,0 @@ -local SpellBook = -{ - Name = "SpellBook", - Type = "System", - Namespace = "C_SpellBook", - - Functions = - { - { - Name = "GetSpellLinkFromSpellID", - Type = "Function", - - Arguments = - { - { Name = "spellID", Type = "number", Nilable = false }, - { Name = "glyphID", Type = "number", Nilable = true }, - }, - - Returns = - { - { Name = "spellLink", Type = "string", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "CurrentSpellCastChanged", - Type = "Event", - LiteralName = "CURRENT_SPELL_CAST_CHANGED", - Payload = - { - { Name = "cancelledCast", Type = "bool", Nilable = false }, - }, - }, - { - Name = "LearnedSpellInTab", - Type = "Event", - LiteralName = "LEARNED_SPELL_IN_TAB", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - { Name = "skillInfoIndex", Type = "number", Nilable = false }, - { Name = "isGuildPerkSpell", Type = "bool", Nilable = false }, - }, - }, - { - Name = "MaxSpellStartRecoveryOffsetChanged", - Type = "Event", - LiteralName = "MAX_SPELL_START_RECOVERY_OFFSET_CHANGED", - Payload = - { - { Name = "clampedNewQueueWindowMs", Type = "number", Nilable = false }, - }, - }, - { - Name = "PlayerTotemUpdate", - Type = "Event", - LiteralName = "PLAYER_TOTEM_UPDATE", - Payload = - { - { Name = "totemSlot", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "SpellTextUpdate", - Type = "Event", - LiteralName = "SPELL_TEXT_UPDATE", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SpellUpdateCharges", - Type = "Event", - LiteralName = "SPELL_UPDATE_CHARGES", - }, - { - Name = "SpellUpdateCooldown", - Type = "Event", - LiteralName = "SPELL_UPDATE_COOLDOWN", - }, - { - Name = "SpellUpdateIcon", - Type = "Event", - LiteralName = "SPELL_UPDATE_ICON", - }, - { - Name = "SpellUpdateUsable", - Type = "Event", - LiteralName = "SPELL_UPDATE_USABLE", - }, - { - Name = "SpellsChanged", - Type = "Event", - LiteralName = "SPELLS_CHANGED", - }, - { - Name = "StartAutorepeatSpell", - Type = "Event", - LiteralName = "START_AUTOREPEAT_SPELL", - }, - { - Name = "StopAutorepeatSpell", - Type = "Event", - LiteralName = "STOP_AUTOREPEAT_SPELL", - }, - { - Name = "UnitSpellcastSent", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_SENT", - Payload = - { - { Name = "unit", Type = "cstring", Nilable = false }, - { Name = "target", Type = "cstring", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UpdateShapeshiftCooldown", - Type = "Event", - LiteralName = "UPDATE_SHAPESHIFT_COOLDOWN", - }, - { - Name = "UpdateShapeshiftForm", - Type = "Event", - LiteralName = "UPDATE_SHAPESHIFT_FORM", - }, - { - Name = "UpdateShapeshiftForms", - Type = "Event", - LiteralName = "UPDATE_SHAPESHIFT_FORMS", - }, - { - Name = "UpdateShapeshiftUsable", - Type = "Event", - LiteralName = "UPDATE_SHAPESHIFT_USABLE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SpellBook); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SpellDocumentation.lua b/APIDocumentation/Documentation/SpellDocumentation.lua index f736f1f..05f127c 100644 --- a/APIDocumentation/Documentation/SpellDocumentation.lua +++ b/APIDocumentation/Documentation/SpellDocumentation.lua @@ -2,45 +2,614 @@ local Spell = { Name = "Spell", Type = "System", - Namespace = "C_Spell", + Namespace = "Spell", Functions = { { - Name = "DoesSpellExist", + Name = "CastSpell", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "bookType", Type = "string", Nilable = false }, + }, + + }, + { + Name = "CastSpellByID", Type = "Function", Arguments = { { Name = "spellID", Type = "number", Nilable = false }, + { Name = "target", Type = "string", Nilable = true }, + }, + + }, + { + Name = "CastSpellByName", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = true }, + }, + + }, + { + Name = "CursorHasSpell", + Type = "Function", + + Returns = + { + { Name = "hasSpell", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DisableSpellAutocast", + Type = "Function", + + Arguments = + { + { Name = "spell", Type = "string", Nilable = false }, + }, + + }, + { + Name = "EnableSpellAutocast", + Type = "Function", + + Arguments = + { + { Name = "spell", Type = "string", Nilable = false }, + }, + + }, + { + Name = "GetItemSpell", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, }, Returns = { - { Name = "spellExists", Type = "bool", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, }, }, { - Name = "IsSpellDataCached", + Name = "GetKnownSlotFromHighestRankSlot", Type = "Function", Arguments = { - { Name = "spellID", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, }, Returns = { - { Name = "isCached", Type = "bool", Nilable = false }, + { Name = "maxRankSlot", Type = "number", Nilable = false }, }, }, { - Name = "RequestLoadSpellData", + Name = "GetNumSpellTabs", + Type = "Function", + + Returns = + { + { Name = "numTabs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestLogRewardSpell", + Type = "Function", + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isTradeskillSpell", Type = "bool", Nilable = false }, + { Name = "isSpellLearned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetRewardSpell", + Type = "Function", + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isTradeskillSpell", Type = "bool", Nilable = false }, + { Name = "isSpellLearned", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSpellAutocast", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "bookType", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "autocastAllowed", Type = "bool", Nilable = false }, + { Name = "autocastEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetSpellCooldown", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "id", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellCount", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "numCasts", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "id", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "powerCost", Type = "number", Nilable = false }, + { Name = "isFunnel", Type = "bool", Nilable = false }, + { Name = "powerType", Type = "number", Nilable = false }, + { Name = "castingTime", Type = "time_t", Nilable = false }, + { Name = "minRange", Type = "number", Nilable = false }, + { Name = "maxRange", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "id", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + { Name = "tradeLink", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellName", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "bookType", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "spellName", Type = "string", Nilable = false }, + { Name = "subSpellName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSpellTabInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "offset", Type = "number", Nilable = false }, + { Name = "numSpells", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellTexture", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + }, + }, + { + Name = "HasPetSpells", + Type = "Function", + + Returns = + { + { Name = "hasPetSpells", Type = "bool", Nilable = false }, + { Name = "petType", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsAttackSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsAutoRepeatSpell", + Type = "Function", + + Arguments = + { + { Name = "spellName", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isAutoRepeat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsConsumableSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isConsumable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsCurrentSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isCurrent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHarmfulSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsHelpfulSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isHarmful", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPassiveSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isPassive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellInRange", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellKnown", Type = "Function", Arguments = { { Name = "spellID", Type = "number", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "isKnown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsableSpell", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "notEnoughMana", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PickupSpell", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "bookType", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetMultiCastSpell", + Type = "Function", + + Arguments = + { + { Name = "action", Type = "number", Nilable = false }, + { Name = "spell", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SpellCanTargetGlyph", + Type = "Function", + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellCanTargetItem", + Type = "Function", + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellCanTargetUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellHasRange", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "hasRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellIsTargeting", + Type = "Function", + + Returns = + { + { Name = "isTargeting", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellStopCasting", + Type = "Function", + + }, + { + Name = "SpellStopTargeting", + Type = "Function", + + }, + { + Name = "SpellTargetItem", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = true }, + { Name = "itemName", Type = "string", Nilable = true }, + { Name = "itemLink", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SpellTargetUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ToggleSpellAutocast", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "bookType", Type = "string", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "UnitCastingInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subText", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "endTime", Type = "time_t", Nilable = false }, + { Name = "isTradeSkill", Type = "bool", Nilable = false }, + { Name = "castID", Type = "number", Nilable = false }, + { Name = "notInterruptible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitChannelInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subText", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "endTime", Type = "time_t", Nilable = false }, + { Name = "isTradeSkill", Type = "bool", Nilable = false }, + { Name = "notInterruptible", Type = "bool", Nilable = false }, }, }, }, @@ -48,13 +617,166 @@ local Spell = Events = { { - Name = "SpellDataLoadResult", + Name = "CurrentSpellCastChanged", Type = "Event", - LiteralName = "SPELL_DATA_LOAD_RESULT", + LiteralName = "CURRENT_SPELL_CAST_CHANGED", + }, + { + Name = "LearnedSpellInTab", + Type = "Event", + LiteralName = "LEARNED_SPELL_IN_TAB", Payload = { { Name = "spellID", Type = "number", Nilable = false }, - { Name = "success", Type = "bool", Nilable = false }, + { Name = "tabID", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetSpellPowerUpdate", + Type = "Event", + LiteralName = "PET_SPELL_POWER_UPDATE", + }, + { + Name = "SpellsChanged", + Type = "Event", + LiteralName = "SPELLS_CHANGED", + }, + { + Name = "SpellUpdateCooldown", + Type = "Event", + LiteralName = "SPELL_UPDATE_COOLDOWN", + }, + { + Name = "SpellUpdateUsable", + Type = "Event", + LiteralName = "SPELL_UPDATE_USABLE", + }, + { + Name = "StartAutorepeatSpell", + Type = "Event", + LiteralName = "START_AUTOREPEAT_SPELL", + }, + { + Name = "StopAutorepeatSpell", + Type = "Event", + LiteralName = "STOP_AUTOREPEAT_SPELL", + }, + { + Name = "UnitSpellcastDelayed", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_DELAYED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastFailed", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_FAILED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "unknownid", Type = "number", Nilable = false }, + { Name = "spellid", Type = "blizzid", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastFailedQuiet", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_FAILED_QUIET", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastInterrupted", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_INTERRUPTED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "lineID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "spellID", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastInterruptible", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_INTERRUPTIBLE", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastNotInterruptible", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_NOT_INTERRUPTIBLE", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastSent", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_SENT", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "target", Type = "string", Nilable = false }, + { Name = "lineID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastStart", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_START", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "lineID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "spellID", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastStop", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_STOP", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "lineID", Type = "number", Nilable = false }, + { Name = "spellID", Type = "spellID", Nilable = false }, + }, + }, + { + Name = "UnitSpellcastSucceeded", + Type = "Event", + LiteralName = "UNIT_SPELLCAST_SUCCEEDED", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "spell", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "?", Type = "number", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, }, }, }, @@ -64,4 +786,4 @@ local Spell = }, }; -APIDocumentation:AddDocumentationTable(Spell); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Spell); diff --git a/APIDocumentation/Documentation/StableInfoDocumentation.lua b/APIDocumentation/Documentation/StableInfoDocumentation.lua deleted file mode 100644 index e71c0e1..0000000 --- a/APIDocumentation/Documentation/StableInfoDocumentation.lua +++ /dev/null @@ -1,58 +0,0 @@ -local StableInfo = -{ - Name = "StableInfo", - Type = "System", - Namespace = "C_StableInfo", - - Functions = - { - { - Name = "GetNumActivePets", - Type = "Function", - - Returns = - { - { Name = "numActivePets", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetNumStablePets", - Type = "Function", - - Returns = - { - { Name = "numStablePets", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "PetStableClosed", - Type = "Event", - LiteralName = "PET_STABLE_CLOSED", - }, - { - Name = "PetStableShow", - Type = "Event", - LiteralName = "PET_STABLE_SHOW", - }, - { - Name = "PetStableUpdate", - Type = "Event", - LiteralName = "PET_STABLE_UPDATE", - }, - { - Name = "PetStableUpdatePaperdoll", - Type = "Event", - LiteralName = "PET_STABLE_UPDATE_PAPERDOLL", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(StableInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/StanceshapeshiftDocumentation.lua b/APIDocumentation/Documentation/StanceshapeshiftDocumentation.lua new file mode 100644 index 0000000..ee3d5b9 --- /dev/null +++ b/APIDocumentation/Documentation/StanceshapeshiftDocumentation.lua @@ -0,0 +1,86 @@ +local Stanceshapeshift = +{ + Name = "StanceShapeshift", + Type = "System", + Namespace = "StanceShapeshift", + + Functions = + { + { + Name = "CancelShapeshiftForm", + Type = "Function", + + }, + { + Name = "CastShapeshiftForm", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetNumShapeshiftForms", + Type = "Function", + + Returns = + { + { Name = "numForms", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShapeshiftForm", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetShapeshiftFormCooldown", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "start", Type = "number", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShapeshiftFormInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texture", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + { Name = "isCastable", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Stanceshapeshift); diff --git a/APIDocumentation/Documentation/StatInformationDocumentation.lua b/APIDocumentation/Documentation/StatInformationDocumentation.lua new file mode 100644 index 0000000..6da7f90 --- /dev/null +++ b/APIDocumentation/Documentation/StatInformationDocumentation.lua @@ -0,0 +1,519 @@ +local StatInformation = +{ + Name = "Stat Information", + Type = "System", + Namespace = "Stat Information", + + Functions = + { + { + Name = "GetArmorPenetration", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetAttackPowerForStat", + Type = "Function", + + Arguments = + { + { Name = "statIndex", Type = "luaIndex", Nilable = false }, + { Name = "effectiveStat", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "attackPower", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetBlockChance", + Type = "Function", + + Returns = + { + { Name = "chance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCombatRating", + Type = "Function", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "rating", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCombatRatingBonus", + Type = "Function", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "ratingBonus", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCritChance", + Type = "Function", + + Returns = + { + { Name = "critChance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetCritChanceFromAgility", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "critChance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDamageBonusStat", + Type = "Function", + + Returns = + { + { Name = "bonusStat", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetDodgeChance", + Type = "Function", + + Returns = + { + { Name = "chance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExpertise", + Type = "Function", + + Returns = + { + { Name = "expertise", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetExpertisePercent", + Type = "Function", + + Returns = + { + { Name = "expertisePerc", Type = "number", Nilable = false }, + { Name = "offhandExpertisePercent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetManaRegen", + Type = "Function", + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "casting", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMaxCombatRatingBonus", + Type = "Function", + + Arguments = + { + { Name = "ratingIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "max", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetParryChance", + Type = "Function", + + Returns = + { + { Name = "chance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPowerRegen", + Type = "Function", + + Returns = + { + { Name = "inactiveRegen", Type = "number", Nilable = false }, + { Name = "activeRegen", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetRangedCritChance", + Type = "Function", + + Returns = + { + { Name = "critChance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetShieldBlock", + Type = "Function", + + Returns = + { + { Name = "damage", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBonusDamage", + Type = "Function", + + Arguments = + { + { Name = "school", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "minModifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellBonusHealing", + Type = "Function", + + Returns = + { + { Name = "bonusHealing", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellCritChance", + Type = "Function", + + Arguments = + { + { Name = "school", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "minCrit", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellCritChanceFromIntellect", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "critChance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSpellPenetration", + Type = "Function", + + Returns = + { + { Name = "penetration", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitHealthModifier", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "modifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitHealthRegenRateFromSpirit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "regen", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitManaRegenRateFromSpirit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "regen", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitMaxHealthModifier", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "modifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetUnitPowerModifier", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "modifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitArmor", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "effectiveArmor", Type = "number", Nilable = false }, + { Name = "armor", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAttackBothHands", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "mainHandAttackBase", Type = "number", Nilable = false }, + { Name = "mainHandAttackMod", Type = "number", Nilable = false }, + { Name = "offHandHandAttackBase", Type = "number", Nilable = false }, + { Name = "offHandAttackMod", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAttackPower", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitAttackSpeed", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "speed", Type = "number", Nilable = false }, + { Name = "offhandSpeed", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitDamage", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "minDamage", Type = "number", Nilable = false }, + { Name = "maxDamage", Type = "number", Nilable = false }, + { Name = "minOffHandDamage", Type = "number", Nilable = false }, + { Name = "maxOffHandDamage", Type = "number", Nilable = false }, + { Name = "physicalBonusPos", Type = "number", Nilable = false }, + { Name = "physicalBonusNeg", Type = "number", Nilable = false }, + { Name = "percent", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitDefense", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "modifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRangedAttack", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "rangedAttackBase", Type = "number", Nilable = false }, + { Name = "rangedAttackMod", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRangedAttackPower", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRangedDamage", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "rangedAttackSpeed", Type = "number", Nilable = false }, + { Name = "minDamage", Type = "number", Nilable = false }, + { Name = "maxDamage", Type = "number", Nilable = false }, + { Name = "physicalBonusPos", Type = "number", Nilable = false }, + { Name = "physicalBonusNeg", Type = "number", Nilable = false }, + { Name = "percent", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitResistance", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "resistanceIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "base", Type = "number", Nilable = false }, + { Name = "resistance", Type = "number", Nilable = false }, + { Name = "positive", Type = "number", Nilable = false }, + { Name = "negative", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitStat", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "statIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "stat", Type = "number", Nilable = false }, + { Name = "effectiveStat", Type = "number", Nilable = false }, + { Name = "posBuff", Type = "number", Nilable = false }, + { Name = "negBuff", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(StatInformation); diff --git a/APIDocumentation/Documentation/StorePublicUIDocumentation.lua b/APIDocumentation/Documentation/StorePublicUIDocumentation.lua deleted file mode 100644 index 3e3cac4..0000000 --- a/APIDocumentation/Documentation/StorePublicUIDocumentation.lua +++ /dev/null @@ -1,61 +0,0 @@ -local StorePublicUI = -{ - Name = "StorePublic", - Type = "System", - Namespace = "C_StorePublic", - - Functions = - { - { - Name = "DoesGroupHavePurchaseableProducts", - Type = "Function", - - Arguments = - { - { Name = "groupID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "hasPurchaseableProducts", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HasPurchaseableProducts", - Type = "Function", - - Returns = - { - { Name = "hasPurchaseableProducts", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsDisabledByParentalControls", - Type = "Function", - - Returns = - { - { Name = "disabled", Type = "bool", Nilable = false }, - }, - }, - { - 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/APIDocumentation/Documentation/StringUtilDocumentation.lua b/APIDocumentation/Documentation/StringUtilDocumentation.lua deleted file mode 100644 index fecd0c6..0000000 --- a/APIDocumentation/Documentation/StringUtilDocumentation.lua +++ /dev/null @@ -1,37 +0,0 @@ -local StringUtil = -{ - Name = "StringUtil", - Type = "System", - - Functions = - { - { - Name = "StripHyperlinks", - Type = "Function", - - Arguments = - { - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "maintainColor", Type = "bool", Nilable = false, Default = false }, - { Name = "maintainBrackets", Type = "bool", Nilable = false, Default = false }, - { Name = "stripNewlines", Type = "bool", Nilable = false, Default = false }, - { Name = "maintainAtlases", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "stripped", Type = "string", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(StringUtil); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SummonInfoDocumentation.lua b/APIDocumentation/Documentation/SummonInfoDocumentation.lua deleted file mode 100644 index c00741f..0000000 --- a/APIDocumentation/Documentation/SummonInfoDocumentation.lua +++ /dev/null @@ -1,73 +0,0 @@ -local SummonInfo = -{ - Name = "SummonInfo", - Type = "System", - Namespace = "C_SummonInfo", - - 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/APIDocumentation/Documentation/SummoningDocumentation.lua b/APIDocumentation/Documentation/SummoningDocumentation.lua new file mode 100644 index 0000000..bf25928 --- /dev/null +++ b/APIDocumentation/Documentation/SummoningDocumentation.lua @@ -0,0 +1,66 @@ +local Summoning = +{ + Name = "Summoning", + Type = "System", + Namespace = "Summoning", + + Functions = + { + { + Name = "CancelSummon", + Type = "Function", + + }, + { + Name = "ConfirmSummon", + Type = "Function", + + }, + { + Name = "GetSummonConfirmAreaName", + Type = "Function", + + Returns = + { + { Name = "area", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSummonConfirmSummoner", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSummonConfirmTimeLeft", + Type = "Function", + + Returns = + { + { Name = "timeleft", Type = "number", Nilable = false }, + }, + }, + { + Name = "PlayerCanTeleport", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Summoning); diff --git a/APIDocumentation/Documentation/SystemDocumentation.lua b/APIDocumentation/Documentation/SystemDocumentation.lua deleted file mode 100644 index 6355804..0000000 --- a/APIDocumentation/Documentation/SystemDocumentation.lua +++ /dev/null @@ -1,201 +0,0 @@ -local System = -{ - Name = "SystemInfo", - Type = "System", - Namespace = "C_System", - - Functions = - { - { - Name = "GetFrameStack", - Type = "Function", - - Returns = - { - { Name = "objects", Type = "table", InnerType = "ScriptRegion", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "CaptureframesFailed", - Type = "Event", - LiteralName = "CAPTUREFRAMES_FAILED", - }, - { - Name = "CaptureframesSucceeded", - Type = "Event", - LiteralName = "CAPTUREFRAMES_SUCCEEDED", - }, - { - Name = "DisableTaxiBenchmark", - Type = "Event", - LiteralName = "DISABLE_TAXI_BENCHMARK", - }, - { - Name = "EnableTaxiBenchmark", - Type = "Event", - LiteralName = "ENABLE_TAXI_BENCHMARK", - }, - { - Name = "FirstFrameRendered", - Type = "Event", - LiteralName = "FIRST_FRAME_RENDERED", - }, - { - Name = "GenericError", - Type = "Event", - LiteralName = "GENERIC_ERROR", - Payload = - { - { Name = "errorMessage", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GlobalMouseDown", - Type = "Event", - LiteralName = "GLOBAL_MOUSE_DOWN", - Payload = - { - { Name = "button", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "GlobalMouseUp", - Type = "Event", - LiteralName = "GLOBAL_MOUSE_UP", - Payload = - { - { Name = "button", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "InitialHotfixesApplied", - Type = "Event", - LiteralName = "INITIAL_HOTFIXES_APPLIED", - }, - { - Name = "LocResult", - Type = "Event", - LiteralName = "LOC_RESULT", - Payload = - { - { Name = "result", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "LogoutCancel", - Type = "Event", - LiteralName = "LOGOUT_CANCEL", - }, - { - Name = "PlayerCamping", - Type = "Event", - LiteralName = "PLAYER_CAMPING", - }, - { - Name = "PlayerEnteringWorld", - Type = "Event", - LiteralName = "PLAYER_ENTERING_WORLD", - Payload = - { - { Name = "isInitialLogin", Type = "bool", Nilable = false }, - { Name = "isReloadingUi", Type = "bool", Nilable = false }, - }, - }, - { - Name = "PlayerLeavingWorld", - Type = "Event", - LiteralName = "PLAYER_LEAVING_WORLD", - }, - { - Name = "PlayerLogin", - Type = "Event", - LiteralName = "PLAYER_LOGIN", - }, - { - Name = "PlayerLogout", - Type = "Event", - LiteralName = "PLAYER_LOGOUT", - }, - { - Name = "PlayerQuiting", - Type = "Event", - LiteralName = "PLAYER_QUITING", - }, - { - Name = "SearchDbLoaded", - Type = "Event", - LiteralName = "SEARCH_DB_LOADED", - }, - { - Name = "StreamingIcon", - Type = "Event", - LiteralName = "STREAMING_ICON", - Payload = - { - { Name = "streamingStatus", Type = "number", Nilable = false }, - }, - }, - { - Name = "Sysmsg", - Type = "Event", - LiteralName = "SYSMSG", - 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", - Payload = - { - { Name = "totalTimePlayed", Type = "number", Nilable = false }, - { Name = "timePlayedThisLevel", Type = "number", Nilable = false }, - }, - }, - { - Name = "UiErrorMessage", - Type = "Event", - LiteralName = "UI_ERROR_MESSAGE", - Payload = - { - { Name = "errorType", Type = "luaIndex", Nilable = false }, - { Name = "message", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "UiInfoMessage", - Type = "Event", - LiteralName = "UI_INFO_MESSAGE", - Payload = - { - { Name = "errorType", Type = "luaIndex", Nilable = false }, - { Name = "message", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "VariablesLoaded", - Type = "Event", - LiteralName = "VARIABLES_LOADED", - }, - { - Name = "WoWMouseNotFound", - Type = "Event", - LiteralName = "WOW_MOUSE_NOT_FOUND", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(System); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SystemTimeDocumentation.lua b/APIDocumentation/Documentation/SystemTimeDocumentation.lua deleted file mode 100644 index 2aca88b..0000000 --- a/APIDocumentation/Documentation/SystemTimeDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local SystemTime = -{ - Name = "SystemTime", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(SystemTime); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TTSSettingsDocumentation.lua b/APIDocumentation/Documentation/TTSSettingsDocumentation.lua deleted file mode 100644 index 71b7c20..0000000 --- a/APIDocumentation/Documentation/TTSSettingsDocumentation.lua +++ /dev/null @@ -1,218 +0,0 @@ -local TTSSettings = -{ - Name = "TTSSettings", - Type = "System", - Namespace = "C_TTSSettings", - - Functions = - { - { - Name = "GetChannelEnabled", - Type = "Function", - - 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", - - Arguments = - { - { Name = "chatName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "enabled", Type = "bool", Nilable = false }, - }, - }, - { - Name = "GetSetting", - Type = "Function", - - 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", - - Arguments = - { - { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, - }, - - Returns = - { - { Name = "voiceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "GetVoiceOptionName", - Type = "Function", - - Arguments = - { - { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, - }, - - Returns = - { - { Name = "voiceName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "MarkCharacterSettingsSaved", - Type = "Function", - }, - { - Name = "SetChannelEnabled", - Type = "Function", - - Arguments = - { - { Name = "channelInfo", Type = "ChatChannelInfo", Nilable = false }, - { Name = "newVal", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetChannelKeyEnabled", - Type = "Function", - - Arguments = - { - { Name = "channelKey", Type = "string", Nilable = false }, - { Name = "newVal", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetChatTypeEnabled", - Type = "Function", - - Arguments = - { - { Name = "chatName", Type = "cstring", Nilable = false }, - { Name = "newVal", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetDefaultSettings", - Type = "Function", - }, - { - Name = "SetSetting", - Type = "Function", - - Arguments = - { - { Name = "setting", Type = "TtsBoolSetting", Nilable = false }, - { Name = "newVal", Type = "bool", Nilable = false, Default = false }, - }, - }, - { - Name = "SetSpeechRate", - Type = "Function", - - Arguments = - { - { Name = "newVal", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetSpeechVolume", - Type = "Function", - - Arguments = - { - { Name = "newVal", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetVoiceOption", - Type = "Function", - - Arguments = - { - { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, - { Name = "voiceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetVoiceOptionName", - Type = "Function", - - Arguments = - { - { Name = "voiceType", Type = "TtsVoiceType", Nilable = false }, - { Name = "voiceName", Type = "string", Nilable = false }, - }, - }, - { - Name = "ShouldOverrideMessage", - Type = "Function", - - 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/APIDocumentation/Documentation/TalentDocumentation.lua b/APIDocumentation/Documentation/TalentDocumentation.lua new file mode 100644 index 0000000..1eab774 --- /dev/null +++ b/APIDocumentation/Documentation/TalentDocumentation.lua @@ -0,0 +1,340 @@ +local Talent = +{ + Name = "Talent", + Type = "System", + Namespace = "Talent", + + Functions = + { + { + Name = "AddPreviewTalentPoints", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "talentIndex", Type = "luaIndex", Nilable = false }, + { Name = "points", Type = "number", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + }, + { + Name = "CheckTalentMasterDist", + Type = "Function", + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ConfirmTalentWipe", + Type = "Function", + + }, + { + Name = "GetActiveTalentGroup", + Type = "Function", + + Arguments = + { + { Name = "isInspect", Type = "bool", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "activeTalentGroup", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGroupPreviewTalentPointsSpent", + Type = "Function", + + Arguments = + { + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "pointsSpent", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTalentGroups", + Type = "Function", + + Arguments = + { + { Name = "isInspect", Type = "bool", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "numTalentGroups", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTalentTabs", + Type = "Function", + + Arguments = + { + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "numTabs", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumTalents", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "numTalents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetPetTalentTree", + Type = "Function", + + Returns = + { + { Name = "talent", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetPreviewTalentPointsSpent", + Type = "Function", + + }, + { + Name = "GetTalentInfo", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "talentIndex", Type = "luaIndex", Nilable = false }, + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconTexture", Type = "string", Nilable = false }, + { Name = "tier", Type = "number", Nilable = false }, + { Name = "column", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "maxRank", Type = "number", Nilable = false }, + { Name = "isExceptional", Type = "bool", Nilable = false }, + { Name = "meetsPrereq", Type = "bool", Nilable = false }, + { Name = "previewRank", Type = "number", Nilable = false }, + { Name = "meetsPreviewPrereq", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTalentLink", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "talentIndex", Type = "luaIndex", Nilable = false }, + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTalentPrereqs", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "talentIndex", Type = "luaIndex", Nilable = false }, + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "tier", Type = "number", Nilable = false }, + { Name = "column", Type = "number", Nilable = false }, + { Name = "isLearnable", Type = "bool", Nilable = false }, + { Name = "isPreviewLearnable", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetTalentTabInfo", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "points", Type = "number", Nilable = false }, + { Name = "background", Type = "string", Nilable = false }, + { Name = "previewPoints", Type = "number", Nilable = false }, + { Name = "isUnlocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetUnspentTalentPoints", + Type = "Function", + + Arguments = + { + { Name = "inspect", Type = "bool", Nilable = false }, + { Name = "pet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "points", Type = "number", Nilable = false }, + }, + }, + { + Name = "LearnPreviewTalents", + Type = "Function", + + Arguments = + { + { Name = "isPet", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "LearnTalent", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "talentIndex", Type = "luaIndex", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ResetGroupPreviewTalentPoints", + Type = "Function", + + Arguments = + { + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ResetPreviewTalentPoints", + Type = "Function", + + Arguments = + { + { Name = "tabIndex", Type = "luaIndex", Nilable = false }, + { Name = "isPet", Type = "bool", Nilable = false }, + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetActiveTalentGroup", + Type = "Function", + + Arguments = + { + { Name = "talentGroup", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "ActiveTalentGroupChanged", + Type = "Event", + LiteralName = "ACTIVE_TALENT_GROUP_CHANGED", + }, + { + Name = "ConfirmTalentWipe", + Type = "Event", + LiteralName = "CONFIRM_TALENT_WIPE", + Payload = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "PetTalentUpdate", + Type = "Event", + LiteralName = "PET_TALENT_UPDATE", + }, + { + Name = "PlayerTalentUpdate", + Type = "Event", + LiteralName = "PLAYER_TALENT_UPDATE", + }, + { + Name = "PreviewPetTalentPointsChanged", + Type = "Event", + LiteralName = "PREVIEW_PET_TALENT_POINTS_CHANGED", + }, + { + Name = "PreviewTalentPointsChanged", + Type = "Event", + LiteralName = "PREVIEW_TALENT_POINTS_CHANGED", + }, + { + Name = "TalentsInvoluntarilyReset", + Type = "Event", + LiteralName = "TALENTS_INVOLUNTARILY_RESET", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Talent); diff --git a/APIDocumentation/Documentation/TargetingDocumentation.lua b/APIDocumentation/Documentation/TargetingDocumentation.lua new file mode 100644 index 0000000..657f4ec --- /dev/null +++ b/APIDocumentation/Documentation/TargetingDocumentation.lua @@ -0,0 +1,178 @@ +local Targeting = +{ + Name = "Targeting", + Type = "System", + Namespace = "Targeting", + + Functions = + { + { + Name = "AssistUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ClearFocus", + Type = "Function", + + }, + { + Name = "ClearTarget", + Type = "Function", + + }, + { + Name = "FocusUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "SpellCanTargetUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SpellTargetUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "TargetLastEnemy", + Type = "Function", + + }, + { + Name = "TargetLastFriend", + Type = "Function", + + }, + { + Name = "TargetLastTarget", + Type = "Function", + + }, + { + Name = "TargetNearest", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "TargetNearestEnemy", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TargetNearestEnemyPlayer", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TargetNearestFriend", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TargetNearestFriendPlayer", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TargetNearestPartyMember", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TargetNearestRaidMember", + Type = "Function", + + Arguments = + { + { Name = "backward", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TargetUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "canTarget", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Targeting); diff --git a/APIDocumentation/Documentation/TaxiMapDocumentation.lua b/APIDocumentation/Documentation/TaxiMapDocumentation.lua deleted file mode 100644 index b1dc30a..0000000 --- a/APIDocumentation/Documentation/TaxiMapDocumentation.lua +++ /dev/null @@ -1,116 +0,0 @@ -local TaxiMap = -{ - Name = "TaxiMap", - Type = "System", - Namespace = "C_TaxiMap", - - Functions = - { - { - Name = "GetAllTaxiNodes", - Type = "Function", - 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", - 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 }, - }, - }, - }, - - Events = - { - { - Name = "TaximapClosed", - Type = "Event", - LiteralName = "TAXIMAP_CLOSED", - }, - { - Name = "TaximapOpened", - Type = "Event", - LiteralName = "TAXIMAP_OPENED", - 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 = "textureKitPrefix", Type = "string", Nilable = true }, - }, - }, - { - 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 = "textureKitPrefix", Type = "string", Nilable = true }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(TaxiMap); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TaxiflightDocumentation.lua b/APIDocumentation/Documentation/TaxiflightDocumentation.lua new file mode 100644 index 0000000..3d57ece --- /dev/null +++ b/APIDocumentation/Documentation/TaxiflightDocumentation.lua @@ -0,0 +1,228 @@ +local Taxiflight = +{ + Name = "TaxiFlight", + Type = "System", + Namespace = "TaxiFlight", + + Functions = + { + { + Name = "CloseTaxiMap", + Type = "Function", + + }, + { + Name = "GetNumRoutes", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numHops", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTaxiBenchmarkMode", + Type = "Function", + + Returns = + { + { Name = "isBenchmark", Type = "bool", Nilable = false }, + }, + }, + { + Name = "NumTaxiNodes", + Type = "Function", + + Returns = + { + { Name = "numNodes", Type = "number", Nilable = false }, + }, + }, + { + Name = "SetTaxiBenchmarkMode", + Type = "Function", + + Arguments = + { + { Name = "arg", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetTaxiMap", + Type = "Function", + + Arguments = + { + { Name = "texture", Type = "table", Nilable = false }, + }, + + }, + { + Name = "TakeTaxiNode", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "TaxiGetDestX", + Type = "Function", + + Arguments = + { + { Name = "source", Type = "number", Nilable = false }, + { Name = "dest", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dX", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiGetDestY", + Type = "Function", + + Arguments = + { + { Name = "source", Type = "number", Nilable = false }, + { Name = "dest", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "dY", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiGetSrcX", + Type = "Function", + + Arguments = + { + { Name = "source", Type = "number", Nilable = false }, + { Name = "dest", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sX", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiGetSrcY", + Type = "Function", + + Arguments = + { + { Name = "source", Type = "number", Nilable = false }, + { Name = "dest", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "sY", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiNodeCost", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "cost", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiNodeGetType", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiNodeName", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "TaxiNodePosition", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + }, + }, + { + Name = "TaxiNodeSetCurrent", + Type = "Function", + + Arguments = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + + }, + { + Name = "UnitOnTaxi", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "onTaxi", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Taxiflight); diff --git a/APIDocumentation/Documentation/TextureSharedDocumentation.lua b/APIDocumentation/Documentation/TextureSharedDocumentation.lua deleted file mode 100644 index 85b8b97..0000000 --- a/APIDocumentation/Documentation/TextureSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local TextureShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(TextureShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TextureUtilsDocumentation.lua b/APIDocumentation/Documentation/TextureUtilsDocumentation.lua deleted file mode 100644 index 2501d16..0000000 --- a/APIDocumentation/Documentation/TextureUtilsDocumentation.lua +++ /dev/null @@ -1,134 +0,0 @@ -local TextureUtils = -{ - Name = "TextureUtils", - Type = "System", - Namespace = "C_Texture", - - Functions = - { - { - Name = "ClearTitleIconTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - }, - }, - { - Name = "GetAtlasInfo", - Type = "Function", - - Arguments = - { - { Name = "atlas", Type = "textureAtlas", Nilable = false }, - }, - - Returns = - { - { Name = "info", Type = "AtlasInfo", Nilable = false }, - }, - }, - { - Name = "GetFilenameFromFileDataID", - Type = "Function", - - Arguments = - { - { Name = "fileDataID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "filename", Type = "string", Nilable = false }, - }, - }, - { - Name = "GetTitleIconTexture", - Type = "Function", - - Arguments = - { - { Name = "titleID", Type = "string", Nilable = false }, - { Name = "version", Type = "TitleIconVersion", Nilable = false }, - { Name = "callback", Type = "GetTitleIconTextureCallback", Nilable = false }, - }, - }, - { - Name = "IsTitleIconTextureReady", - Type = "Function", - - Arguments = - { - { Name = "titleID", Type = "string", Nilable = false }, - { Name = "version", Type = "TitleIconVersion", Nilable = false }, - }, - - Returns = - { - { Name = "ready", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetTitleIconTexture", - Type = "Function", - - Arguments = - { - { Name = "texture", Type = "SimpleTexture", Nilable = false }, - { Name = "titleID", Type = "string", Nilable = false }, - { Name = "version", Type = "TitleIconVersion", 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 = "width", Type = "number", Nilable = false }, - { Name = "height", Type = "number", 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 = "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/APIDocumentation/Documentation/ThreatDocumentation.lua b/APIDocumentation/Documentation/ThreatDocumentation.lua new file mode 100644 index 0000000..dcf4a36 --- /dev/null +++ b/APIDocumentation/Documentation/ThreatDocumentation.lua @@ -0,0 +1,91 @@ +local Threat = +{ + Name = "Threat", + Type = "System", + Namespace = "Threat", + + Functions = + { + { + Name = "GetThreatStatusColor", + Type = "Function", + + Arguments = + { + { Name = "status", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "red", Type = "number", Nilable = false }, + { Name = "green", Type = "number", Nilable = false }, + { Name = "blue", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsThreatWarningEnabled", + Type = "Function", + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitDetailedThreatSituation", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "mobUnit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "isTanking", Type = "bool", Nilable = false }, + { Name = "status", Type = "number", Nilable = false }, + { Name = "scaledPercent", Type = "number", Nilable = false }, + { Name = "rawPercent", Type = "number", Nilable = false }, + { Name = "threatValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitThreatSituation", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "mobUnit", Type = "UnitToken", Nilable = true }, + }, + + Returns = + { + { Name = "status", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "UnitThreatListUpdate", + Type = "Event", + LiteralName = "UNIT_THREAT_LIST_UPDATE", + }, + { + Name = "UnitThreatSituationUpdate", + Type = "Event", + LiteralName = "UNIT_THREAT_SITUATION_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Threat); diff --git a/APIDocumentation/Documentation/TimeDocumentation.lua b/APIDocumentation/Documentation/TimeDocumentation.lua deleted file mode 100644 index 4f0336c..0000000 --- a/APIDocumentation/Documentation/TimeDocumentation.lua +++ /dev/null @@ -1,22 +0,0 @@ -local Time = -{ - Tables = - { - { - Name = "CalendarTime", - Type = "Structure", - Fields = - { - { Name = "day", Type = "number", Nilable = false }, - { 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/APIDocumentation/Documentation/TooltipComparisonDocumentation.lua b/APIDocumentation/Documentation/TooltipComparisonDocumentation.lua deleted file mode 100644 index c78db48..0000000 --- a/APIDocumentation/Documentation/TooltipComparisonDocumentation.lua +++ /dev/null @@ -1,44 +0,0 @@ -local TooltipComparison = -{ - Name = "TooltipComparison", - Type = "System", - Namespace = "C_TooltipComparison", - - Functions = - { - }, - - Events = - { - }, - - 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/APIDocumentation/Documentation/TooltipConstantsDocumentation.lua b/APIDocumentation/Documentation/TooltipConstantsDocumentation.lua deleted file mode 100644 index ba565b4..0000000 --- a/APIDocumentation/Documentation/TooltipConstantsDocumentation.lua +++ /dev/null @@ -1,51 +0,0 @@ -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/APIDocumentation/Documentation/TooltipInfoDocumentation.lua b/APIDocumentation/Documentation/TooltipInfoDocumentation.lua deleted file mode 100644 index f702dd4..0000000 --- a/APIDocumentation/Documentation/TooltipInfoDocumentation.lua +++ /dev/null @@ -1,44 +0,0 @@ -local TooltipInfo = -{ - Name = "TooltipInfo", - Type = "System", - Namespace = "C_TooltipInfo", - - Functions = - { - }, - - Events = - { - { - Name = "HideHyperlinkTooltip", - Type = "Event", - LiteralName = "HIDE_HYPERLINK_TOOLTIP", - }, - { - Name = "ShowHyperlinkTooltip", - Type = "Event", - LiteralName = "SHOW_HYPERLINK_TOOLTIP", - Payload = - { - { Name = "hyperlink", Type = "string", Nilable = false }, - }, - }, - { - Name = "TooltipDataUpdate", - Type = "Event", - LiteralName = "TOOLTIP_DATA_UPDATE", - 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/APIDocumentation/Documentation/TooltipInfoSharedDocumentation.lua b/APIDocumentation/Documentation/TooltipInfoSharedDocumentation.lua deleted file mode 100644 index 8759ed7..0000000 --- a/APIDocumentation/Documentation/TooltipInfoSharedDocumentation.lua +++ /dev/null @@ -1,128 +0,0 @@ -local TooltipInfoShared = -{ - Tables = - { - { - Name = "TooltipDataItemBinding", - Type = "Enumeration", - NumValues = 9, - MinValue = 0, - MaxValue = 8, - 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 = "TooltipDataLineType", - Type = "Enumeration", - NumValues = 31, - MinValue = 0, - MaxValue = 30, - 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 = "RestrictedRaceClass", Type = "TooltipDataLineType", EnumValue = 21 }, - { Name = "RestrictedFaction", Type = "TooltipDataLineType", EnumValue = 22 }, - { Name = "RestrictedSkill", Type = "TooltipDataLineType", EnumValue = 23 }, - { Name = "RestrictedPvPMedal", Type = "TooltipDataLineType", EnumValue = 24 }, - { Name = "RestrictedReputation", Type = "TooltipDataLineType", EnumValue = 25 }, - { Name = "RestrictedSpellKnown", Type = "TooltipDataLineType", EnumValue = 26 }, - { Name = "RestrictedLevel", Type = "TooltipDataLineType", EnumValue = 27 }, - { Name = "EquipSlot", Type = "TooltipDataLineType", EnumValue = 28 }, - { Name = "ItemName", Type = "TooltipDataLineType", EnumValue = 29 }, - { Name = "Separator", Type = "TooltipDataLineType", EnumValue = 30 }, - }, - }, - { - Name = "TooltipDataType", - Type = "Enumeration", - NumValues = 27, - MinValue = 0, - MaxValue = 26, - 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 = "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/APIDocumentation/Documentation/ToyBoxInfoDocumentation.lua b/APIDocumentation/Documentation/ToyBoxInfoDocumentation.lua deleted file mode 100644 index 551862d..0000000 --- a/APIDocumentation/Documentation/ToyBoxInfoDocumentation.lua +++ /dev/null @@ -1,63 +0,0 @@ -local ToyBoxInfo = -{ - Name = "ToyBoxInfo", - Type = "System", - Namespace = "C_ToyBoxInfo", - - Functions = - { - { - Name = "ClearFanfare", - Type = "Function", - - Arguments = - { - { Name = "itemID", Type = "number", Nilable = false }, - }, - }, - { - Name = "NeedsFanfare", - Type = "Function", - - Arguments = - { - { Name = "itemID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "needsFanfare", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "NewToyAdded", - Type = "Event", - LiteralName = "NEW_TOY_ADDED", - Payload = - { - { Name = "itemID", Type = "number", Nilable = false }, - }, - }, - { - Name = "ToysUpdated", - Type = "Event", - LiteralName = "TOYS_UPDATED", - 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/APIDocumentation/Documentation/TrackingDocumentation.lua b/APIDocumentation/Documentation/TrackingDocumentation.lua new file mode 100644 index 0000000..7411a65 --- /dev/null +++ b/APIDocumentation/Documentation/TrackingDocumentation.lua @@ -0,0 +1,62 @@ +local Tracking = +{ + Name = "Tracking", + Type = "System", + Namespace = "Tracking", + + Functions = + { + { + Name = "GetNumTrackingTypes", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrackingInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + { Name = "category", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetTracking", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "enabled", Type = "bool", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "MinimapUpdateTracking", + Type = "Event", + LiteralName = "MINIMAP_UPDATE_TRACKING", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Tracking); diff --git a/APIDocumentation/Documentation/TradeDocumentation.lua b/APIDocumentation/Documentation/TradeDocumentation.lua new file mode 100644 index 0000000..890dccf --- /dev/null +++ b/APIDocumentation/Documentation/TradeDocumentation.lua @@ -0,0 +1,253 @@ +local Trade = +{ + Name = "Trade", + Type = "System", + Namespace = "Trade", + + Functions = + { + { + Name = "AcceptTrade", + Type = "Function", + + }, + { + Name = "AddTradeMoney", + Type = "Function", + + }, + { + Name = "BeginTrade", + Type = "Function", + + }, + { + Name = "CancelTrade", + Type = "Function", + + }, + { + Name = "CancelTradeAccept", + Type = "Function", + + }, + { + Name = "ClickTargetTradeButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "ClickTradeButton", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CloseTrade", + Type = "Function", + + }, + { + Name = "GetPlayerTradeMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTargetTradeMoney", + Type = "Function", + + Returns = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradePlayerItemInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "enchantment", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradePlayerItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradeTargetItemInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "quality", Type = "itemQuality", Nilable = false }, + { Name = "isUsable", Type = "bool", Nilable = false }, + { Name = "enchantment", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeTargetItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "InitiateTrade", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "PickupTradeMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "ReplaceTradeEnchant", + Type = "Function", + + }, + { + Name = "SetTradeMoney", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "EndBoundTradeable", + Type = "Event", + LiteralName = "END_BOUND_TRADEABLE", + }, + { + Name = "TradeAcceptUpdate", + Type = "Event", + LiteralName = "TRADE_ACCEPT_UPDATE", + Payload = + { + { Name = "player", Type = "number", Nilable = false }, + { Name = "target", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeClosed", + Type = "Event", + LiteralName = "TRADE_CLOSED", + }, + { + Name = "TradePlayerItemChanged", + Type = "Event", + LiteralName = "TRADE_PLAYER_ITEM_CHANGED", + Payload = + { + { Name = "slotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradePotentialBindEnchant", + Type = "Event", + LiteralName = "TRADE_POTENTIAL_BIND_ENCHANT", + }, + { + Name = "TradeReplaceEnchant", + Type = "Event", + LiteralName = "TRADE_REPLACE_ENCHANT", + Payload = + { + { Name = "current", Type = "string", Nilable = false }, + { Name = "new", Type = "string", Nilable = false }, + }, + }, + { + Name = "TradeShow", + Type = "Event", + LiteralName = "TRADE_SHOW", + }, + { + Name = "TradeTargetItemChanged", + Type = "Event", + LiteralName = "TRADE_TARGET_ITEM_CHANGED", + Payload = + { + { Name = "slotID", Type = "number", Nilable = false }, + }, + }, + { + Name = "TradeUpdate", + Type = "Event", + LiteralName = "TRADE_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Trade); diff --git a/APIDocumentation/Documentation/TradeInfoDocumentation.lua b/APIDocumentation/Documentation/TradeInfoDocumentation.lua deleted file mode 100644 index 3eee5ae..0000000 --- a/APIDocumentation/Documentation/TradeInfoDocumentation.lua +++ /dev/null @@ -1,96 +0,0 @@ -local TradeInfo = -{ - Name = "TradeInfo", - Type = "System", - Namespace = "C_TradeInfo", - - Functions = - { - }, - - Events = - { - { - Name = "PlayerTradeMoney", - Type = "Event", - LiteralName = "PLAYER_TRADE_MONEY", - }, - { - Name = "TradeAcceptUpdate", - Type = "Event", - LiteralName = "TRADE_ACCEPT_UPDATE", - Payload = - { - { Name = "playerAccepted", Type = "number", Nilable = false }, - { Name = "targetAccepted", Type = "number", Nilable = false }, - }, - }, - { - Name = "TradeClosed", - Type = "Event", - LiteralName = "TRADE_CLOSED", - }, - { - Name = "TradeMoneyChanged", - Type = "Event", - LiteralName = "TRADE_MONEY_CHANGED", - }, - { - Name = "TradePlayerItemChanged", - Type = "Event", - LiteralName = "TRADE_PLAYER_ITEM_CHANGED", - Payload = - { - { Name = "tradeSlotIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "TradePotentialBindEnchant", - Type = "Event", - LiteralName = "TRADE_POTENTIAL_BIND_ENCHANT", - Payload = - { - { Name = "canBecomeBoundForTrade", Type = "bool", Nilable = false }, - }, - }, - { - Name = "TradeRequest", - Type = "Event", - LiteralName = "TRADE_REQUEST", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "TradeRequestCancel", - Type = "Event", - LiteralName = "TRADE_REQUEST_CANCEL", - }, - { - Name = "TradeShow", - Type = "Event", - LiteralName = "TRADE_SHOW", - }, - { - Name = "TradeTargetItemChanged", - Type = "Event", - LiteralName = "TRADE_TARGET_ITEM_CHANGED", - Payload = - { - { Name = "tradeSlotIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "TradeUpdate", - Type = "Event", - LiteralName = "TRADE_UPDATE", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(TradeInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TradeSkillUIDocumentation.lua b/APIDocumentation/Documentation/TradeSkillUIDocumentation.lua deleted file mode 100644 index f749511..0000000 --- a/APIDocumentation/Documentation/TradeSkillUIDocumentation.lua +++ /dev/null @@ -1,86 +0,0 @@ -local TradeSkillUI = -{ - Name = "TradeSkillUI", - Type = "System", - Namespace = "C_TradeSkillUI", - - Functions = - { - }, - - Events = - { - { - Name = "NewRecipeLearned", - Type = "Event", - LiteralName = "NEW_RECIPE_LEARNED", - 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", - }, - { - Name = "TradeSkillClose", - Type = "Event", - LiteralName = "TRADE_SKILL_CLOSE", - }, - { - Name = "TradeSkillDataSourceChanged", - Type = "Event", - LiteralName = "TRADE_SKILL_DATA_SOURCE_CHANGED", - }, - { - Name = "TradeSkillDataSourceChanging", - Type = "Event", - LiteralName = "TRADE_SKILL_DATA_SOURCE_CHANGING", - }, - { - Name = "TradeSkillDetailsUpdate", - Type = "Event", - LiteralName = "TRADE_SKILL_DETAILS_UPDATE", - }, - { - Name = "TradeSkillFilterUpdate", - Type = "Event", - LiteralName = "TRADE_SKILL_FILTER_UPDATE", - }, - { - Name = "TradeSkillListUpdate", - Type = "Event", - LiteralName = "TRADE_SKILL_LIST_UPDATE", - }, - { - Name = "TradeSkillNameUpdate", - Type = "Event", - LiteralName = "TRADE_SKILL_NAME_UPDATE", - }, - { - Name = "TradeSkillShow", - Type = "Event", - LiteralName = "TRADE_SKILL_SHOW", - }, - { - Name = "TradeSkillUpdate", - Type = "Event", - LiteralName = "TRADE_SKILL_UPDATE", - }, - { - Name = "UpdateTradeskillRecast", - Type = "Event", - LiteralName = "UPDATE_TRADESKILL_RECAST", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(TradeSkillUI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TradeSkillUITypesDocumentation.lua b/APIDocumentation/Documentation/TradeSkillUITypesDocumentation.lua deleted file mode 100644 index 5f61704..0000000 --- a/APIDocumentation/Documentation/TradeSkillUITypesDocumentation.lua +++ /dev/null @@ -1,72 +0,0 @@ -local TradeSkillUITypes = -{ - Tables = - { - { - Name = "CraftingReagentInfo", - Type = "Structure", - Fields = - { - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "slot", Type = "number", Nilable = false }, - { Name = "quantity", Type = "number", Nilable = false }, - }, - }, - { - Name = "RegularReagentInfo", - Type = "Structure", - Fields = - { - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "quantity", Type = "number", Nilable = false }, - }, - }, - { - Name = "TradeSkillReagentInfo", - Type = "Structure", - Fields = - { - { Name = "reagentName", Type = "cstring", Nilable = true }, - { Name = "reagentFileID", Type = "fileID", Nilable = true }, - { Name = "itemID", Type = "number", Nilable = false }, - { Name = "reagentCount", Type = "number", Nilable = false }, - { Name = "playerReagentCount", Type = "number", Nilable = false }, - }, - }, - { - Name = "TradeSkillRecipeInfo", - Type = "Structure", - Fields = - { - { Name = "type", Type = "string", Nilable = false, Default = "recipe" }, - { Name = "categoryID", Type = "number", Nilable = false }, - { Name = "name", Type = "cstring", Nilable = false }, - { Name = "difficulty", Type = "cstring", Nilable = true }, - { Name = "maxTrivialLevel", Type = "number", Nilable = false }, - { Name = "itemLevel", Type = "number", Nilable = false }, - { Name = "numAvailable", Type = "number", Nilable = false }, - { Name = "alternateVerb", Type = "cstring", Nilable = true }, - { Name = "numSkillUps", Type = "number", Nilable = false }, - { Name = "numIndents", Type = "number", 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 = "hiddenUnlessLearned", 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 = "previousRecipeID", Type = "number", Nilable = true }, - { Name = "nextRecipeID", Type = "number", Nilable = true }, - { Name = "icon", Type = "number", Nilable = true }, - { Name = "productQuality", Type = "number", 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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(TradeSkillUITypes); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TradeskillDocumentation.lua b/APIDocumentation/Documentation/TradeskillDocumentation.lua new file mode 100644 index 0000000..46d2ab4 --- /dev/null +++ b/APIDocumentation/Documentation/TradeskillDocumentation.lua @@ -0,0 +1,463 @@ +local Tradeskill = +{ + Name = "Tradeskill", + Type = "System", + Namespace = "Tradeskill", + + Functions = + { + { + Name = "CloseTradeSkill", + Type = "Function", + + }, + { + Name = "CollapseTradeSkillSubClass", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "DoTradeSkill", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "repeat", Type = "number", Nilable = true }, + }, + + }, + { + Name = "ExpandTradeSkillSubClass", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetFirstTradeSkill", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetNumTradeSkills", + Type = "Function", + + Returns = + { + { Name = "numSkills", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillCooldown", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "cooldown", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillDescription", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "description", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillIcon", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "texturePath", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "skillName", Type = "string", Nilable = false }, + { Name = "skillType", Type = "string", Nilable = false }, + { Name = "numAvailable", Type = "number", Nilable = false }, + { Name = "isExpanded", Type = "bool", Nilable = false }, + { Name = "serviceType", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillInvSlotFilter", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillInvSlots", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillItemLevelFilter", + Type = "Function", + + Returns = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillItemNameFilter", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillLine", + Type = "Function", + + Returns = + { + { Name = "tradeskillName", Type = "string", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillListLink", + Type = "Function", + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillNumMade", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "minMade", Type = "number", Nilable = false }, + { Name = "maxMade", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillNumReagents", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numReagents", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillReagentInfo", + Type = "Function", + + Arguments = + { + { Name = "skillIndex", Type = "luaIndex", Nilable = false }, + { Name = "reagentIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "reagentName", Type = "string", Nilable = false }, + { Name = "reagentTexture", Type = "string", Nilable = false }, + { Name = "reagentCount", Type = "number", Nilable = false }, + { Name = "playerReagentCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillReagentItemLink", + Type = "Function", + + Arguments = + { + { Name = "skillIndex", Type = "luaIndex", Nilable = false }, + { Name = "reagentIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillRecipeLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillSelectionIndex", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillSubClassFilter", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "enabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillSubClasses", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetTradeSkillTools", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "toolName", Type = "string", Nilable = false }, + { Name = "hasTool", Type = "bool", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetTradeskillRepeatCount", + Type = "Function", + + Returns = + { + { Name = "repeatCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsTradeSkillLinked", + Type = "Function", + + Returns = + { + { Name = "isLinked", Type = "bool", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "SelectTradeSkill", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetTradeSkillInvSlotFilter", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + { Name = "exclusive", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "SetTradeSkillItemLevelFilter", + Type = "Function", + + Arguments = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetTradeSkillItemNameFilter", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetTradeSkillSubClassFilter", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + { Name = "exclusive", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "StopTradeSkillRepeat", + Type = "Function", + + }, + { + Name = "TradeSkillOnlyShowMakeable", + Type = "Function", + + Arguments = + { + { Name = "filter", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "TradeSkillOnlyShowSkillUps", + Type = "Function", + + Arguments = + { + { Name = "filter", Type = "bool", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "ChatMsgTradeskills", + Type = "Event", + LiteralName = "CHAT_MSG_TRADESKILLS", + }, + { + Name = "TradeSkillClose", + Type = "Event", + LiteralName = "TRADE_SKILL_CLOSE", + }, + { + Name = "TradeSkillFilterUpdate", + Type = "Event", + LiteralName = "TRADE_SKILL_FILTER_UPDATE", + }, + { + Name = "TradeSkillShow", + Type = "Event", + LiteralName = "TRADE_SKILL_SHOW", + }, + { + Name = "TradeSkillUpdate", + Type = "Event", + LiteralName = "TRADE_SKILL_UPDATE", + }, + { + Name = "UpdateTradeskillRecast", + Type = "Event", + LiteralName = "UPDATE_TRADESKILL_RECAST", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Tradeskill); diff --git a/APIDocumentation/Documentation/TrainerDocumentation.lua b/APIDocumentation/Documentation/TrainerDocumentation.lua index ed2fca8..9e76816 100644 --- a/APIDocumentation/Documentation/TrainerDocumentation.lua +++ b/APIDocumentation/Documentation/TrainerDocumentation.lua @@ -2,10 +2,277 @@ local Trainer = { Name = "Trainer", Type = "System", - Namespace = "C_Trainer", + Namespace = "Trainer", Functions = { + { + Name = "BuyTrainerService", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "CheckTalentMasterDist", + Type = "Function", + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseTrainer", + Type = "Function", + + }, + { + Name = "GetNumTrainerServices", + Type = "Function", + + Returns = + { + { Name = "numServices", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrainerGreetingText", + Type = "Function", + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTrainerSelectionIndex", + Type = "Function", + + Returns = + { + { Name = "selectionIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceAbilityReq", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "abilityIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "ability", Type = "string", Nilable = false }, + { Name = "hasReq", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceCost", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "moneyCost", Type = "number", Nilable = false }, + { Name = "talentCost", Type = "number", Nilable = false }, + { Name = "skillCost", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceDescription", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceIcon", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "icon", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "serviceName", Type = "string", Nilable = false }, + { Name = "serviceSubText", Type = "string", Nilable = false }, + { Name = "serviceType", Type = "string", Nilable = false }, + { Name = "isExpanded", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceItemLink", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "link", Type = "hyperlink", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceLevelReq", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "reqLevel", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceNumAbilityReq", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numRequirements", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceSkillLine", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "skillLine", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceSkillReq", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "skill", Type = "string", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + { Name = "hasReq", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetTrainerServiceStepReq", + Type = "Function", + + }, + { + Name = "GetTrainerServiceTypeFilter", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsTradeskillTrainer", + Type = "Function", + + Returns = + { + { Name = "isTradeskill", Type = "bool", Nilable = false }, + }, + }, + { + Name = "OpenTrainer", + Type = "Function", + + }, + { + Name = "SelectTrainerService", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetTrainerServiceTypeFilter", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + { Name = "exclusive", Type = "bool", Nilable = true }, + }, + + }, + { + Name = "SetTrainerSkillLineFilter", + Type = "Function", + + Arguments = + { + { Name = "type", Type = "string", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + { Name = "exclusive", Type = "bool", Nilable = true }, + }, + + }, }, Events = @@ -20,11 +287,6 @@ local Trainer = Type = "Event", LiteralName = "TRAINER_DESCRIPTION_UPDATE", }, - { - Name = "TrainerServiceInfoNameUpdate", - Type = "Event", - LiteralName = "TRAINER_SERVICE_INFO_NAME_UPDATE", - }, { Name = "TrainerShow", Type = "Event", @@ -42,4 +304,4 @@ local Trainer = }, }; -APIDocumentation:AddDocumentationTable(Trainer); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Trainer); diff --git a/APIDocumentation/Documentation/TraitConfigDocumentation.lua b/APIDocumentation/Documentation/TraitConfigDocumentation.lua deleted file mode 100644 index 8dd4973..0000000 --- a/APIDocumentation/Documentation/TraitConfigDocumentation.lua +++ /dev/null @@ -1,20 +0,0 @@ -local TraitConfig = -{ - Name = "TraitConfig", - Type = "System", - Namespace = "C_TraitConfig", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(TraitConfig); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TraitConstantsDocumentation.lua b/APIDocumentation/Documentation/TraitConstantsDocumentation.lua deleted file mode 100644 index 75b51dc..0000000 --- a/APIDocumentation/Documentation/TraitConstantsDocumentation.lua +++ /dev/null @@ -1,299 +0,0 @@ -local TraitConstants = -{ - Tables = - { - { - Name = "NodeOpFailureReason", - Type = "Enumeration", - NumValues = 25, - MinValue = 0, - MaxValue = 24, - 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 = "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 = 4, - MinValue = 0, - MaxValue = 3, - 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 = "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 = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Gold", Type = "TraitCurrencyType", EnumValue = 0 }, - { Name = "CurrencyTypesBased", Type = "TraitCurrencyType", EnumValue = 1 }, - { Name = "TraitSourced", Type = "TraitCurrencyType", EnumValue = 2 }, - }, - }, - { - 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 = 10, - MinValue = 0, - MaxValue = 9, - 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 = "TraitNodeFlag", - Type = "Enumeration", - NumValues = 4, - MinValue = 1, - MaxValue = 8, - 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 = "TraitNodeGroupFlag", - Type = "Enumeration", - NumValues = 1, - MinValue = 1, - MaxValue = 1, - Fields = - { - { Name = "AvailableByDefault", Type = "TraitNodeGroupFlag", EnumValue = 1 }, - }, - }, - { - Name = "TraitNodeType", - Type = "Enumeration", - NumValues = 3, - MinValue = 0, - MaxValue = 2, - Fields = - { - { Name = "Single", Type = "TraitNodeType", EnumValue = 0 }, - { Name = "Tiered", Type = "TraitNodeType", EnumValue = 1 }, - { Name = "Selection", Type = "TraitNodeType", EnumValue = 2 }, - }, - }, - { - 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 = 2, - MinValue = 1, - MaxValue = 2, - Fields = - { - { Name = "AllowMultipleLoadoutsPerTree", Type = "TraitSystemFlag", EnumValue = 1 }, - { Name = "ShowSpendConfirmation", Type = "TraitSystemFlag", EnumValue = 2 }, - }, - }, - { - 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 = 10 }, - { 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/APIDocumentation/Documentation/TransmogSharedDocumentation.lua b/APIDocumentation/Documentation/TransmogSharedDocumentation.lua deleted file mode 100644 index 887b5b9..0000000 --- a/APIDocumentation/Documentation/TransmogSharedDocumentation.lua +++ /dev/null @@ -1,122 +0,0 @@ -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 = "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 = 10, - MinValue = 0, - MaxValue = 9, - 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 = "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 = 7, - MinValue = 0, - MaxValue = 6, - 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 = "Faction", Type = "TransmogUseErrorType", EnumValue = 4 }, - { Name = "Holiday", Type = "TransmogUseErrorType", EnumValue = 5 }, - { Name = "HotRecheckFailed", Type = "TransmogUseErrorType", EnumValue = 6 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(TransmogShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TutorialDocumentation.lua b/APIDocumentation/Documentation/TutorialDocumentation.lua index c594428..7e7baad 100644 --- a/APIDocumentation/Documentation/TutorialDocumentation.lua +++ b/APIDocumentation/Documentation/TutorialDocumentation.lua @@ -2,10 +2,30 @@ local Tutorial = { Name = "Tutorial", Type = "System", - Namespace = "C_Tutorial", + Namespace = "Tutorial", Functions = { + { + Name = "ClearTutorials", + Type = "Function", + + }, + { + Name = "FlagTutorial", + Type = "Function", + + Arguments = + { + { Name = "tutorial", Type = "string", Nilable = false }, + }, + + }, + { + Name = "ResetTutorials", + Type = "Function", + + }, }, Events = @@ -16,8 +36,7 @@ local Tutorial = LiteralName = "TUTORIAL_TRIGGER", Payload = { - { Name = "tutorialIndex", Type = "number", Nilable = false }, - { Name = "forceShow", Type = "bool", Nilable = false }, + { Name = "id", Type = "number", Nilable = false }, }, }, }, @@ -27,4 +46,4 @@ local Tutorial = }, }; -APIDocumentation:AddDocumentationTable(Tutorial); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Tutorial); diff --git a/APIDocumentation/Documentation/UIColorDocumentation.lua b/APIDocumentation/Documentation/UIColorDocumentation.lua deleted file mode 100644 index d8d5fd1..0000000 --- a/APIDocumentation/Documentation/UIColorDocumentation.lua +++ /dev/null @@ -1,38 +0,0 @@ -local UIColor = -{ - Name = "UIColor", - Type = "System", - Namespace = "C_UIColor", - - Functions = - { - { - Name = "GetColors", - Type = "Function", - - Returns = - { - { Name = "colors", Type = "table", InnerType = "DBColorExport", Nilable = false }, - }, - }, - }, - - Events = - { - }, - - Tables = - { - { - Name = "DBColorExport", - Type = "Structure", - Fields = - { - { Name = "baseTag", Type = "cstring", Nilable = false }, - { Name = "color", Type = "colorRGBA", Mixin = "ColorMixin", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(UIColor); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIFileAssetSharedDocumentation.lua b/APIDocumentation/Documentation/UIFileAssetSharedDocumentation.lua deleted file mode 100644 index 2fc16f6..0000000 --- a/APIDocumentation/Documentation/UIFileAssetSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local UIFileAssetShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UIFileAssetShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua b/APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua deleted file mode 100644 index dcaa2f7..0000000 --- a/APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua +++ /dev/null @@ -1,51 +0,0 @@ -local UIGenericWidgetDisplay = -{ - Name = "GenericWidgetDisplay", - Type = "System", - Namespace = "C_GenericWidgetDisplay", - - Functions = - { - { - Name = "Acknowledge", - Type = "Function", - }, - { - Name = "Close", - Type = "Function", - }, - }, - - Events = - { - { - Name = "GenericWidgetDisplayShow", - Type = "Event", - LiteralName = "GENERIC_WIDGET_DISPLAY_SHOW", - 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/APIDocumentation/Documentation/UIMacrosDocumentation.lua b/APIDocumentation/Documentation/UIMacrosDocumentation.lua deleted file mode 100644 index 499979e..0000000 --- a/APIDocumentation/Documentation/UIMacrosDocumentation.lua +++ /dev/null @@ -1,43 +0,0 @@ -local UIMacros = -{ - Name = "UIMacros", - Type = "System", - Namespace = "C_Macro", - - Functions = - { - { - Name = "GetNumIcons", - Type = "Function", - - Returns = - { - { Name = "numIcons", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "ExecuteChatLine", - Type = "Event", - LiteralName = "EXECUTE_CHAT_LINE", - Payload = - { - { Name = "chatLine", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "UpdateMacros", - Type = "Event", - LiteralName = "UPDATE_MACROS", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UIMacros); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIManagerDocumentation.lua b/APIDocumentation/Documentation/UIManagerDocumentation.lua deleted file mode 100644 index df7cedd..0000000 --- a/APIDocumentation/Documentation/UIManagerDocumentation.lua +++ /dev/null @@ -1,80 +0,0 @@ -local UIManager = -{ - Name = "UI", - Type = "System", - Namespace = "C_UI", - - 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 = "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", - }, - { - Name = "UiScaleChanged", - Type = "Event", - LiteralName = "UI_SCALE_CHANGED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UIManager); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIModelInfoDocumentation.lua b/APIDocumentation/Documentation/UIModelInfoDocumentation.lua deleted file mode 100644 index ebee40a..0000000 --- a/APIDocumentation/Documentation/UIModelInfoDocumentation.lua +++ /dev/null @@ -1,231 +0,0 @@ -local UIModelInfo = -{ - Name = "ModelInfo", - Type = "System", - Namespace = "C_ModelInfo", - - Functions = - { - { - Name = "AddActiveModelScene", - Type = "Function", - 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", - 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", - Documentation = { "This function does nothing in public clients" }, - - Arguments = - { - { Name = "modelSceneFrame", Type = "ModelSceneFrame", Nilable = false }, - }, - }, - { - Name = "ClearActiveModelSceneActor", - Type = "Function", - Documentation = { "This function does nothing in public clients" }, - - Arguments = - { - { Name = "modelSceneFrameActor", Type = "ModelSceneFrameActor", Nilable = false }, - }, - }, - { - Name = "GetModelSceneActorDisplayInfoByID", - Type = "Function", - - Arguments = - { - { Name = "modelActorDisplayID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "actorDisplayInfo", Type = "UIModelSceneActorDisplayInfo", Nilable = false }, - }, - }, - { - Name = "GetModelSceneActorInfoByID", - Type = "Function", - - Arguments = - { - { Name = "modelActorID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "actorInfo", Type = "UIModelSceneActorInfo", Nilable = false }, - }, - }, - { - Name = "GetModelSceneCameraInfoByID", - Type = "Function", - - Arguments = - { - { Name = "modelSceneCameraID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "modelSceneCameraInfo", Type = "UIModelSceneCameraInfo", Nilable = false }, - }, - }, - { - Name = "GetModelSceneInfoByID", - Type = "Function", - - 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", - }, - }, - - Tables = - { - { - Name = "ModelSceneSetting", - Type = "Enumeration", - NumValues = 1, - MinValue = 1, - MaxValue = 1, - Fields = - { - { Name = "AlignLightToOrbitDelta", Type = "ModelSceneSetting", EnumValue = 1 }, - }, - }, - { - Name = "ModelSceneType", - Type = "Enumeration", - NumValues = 16, - MinValue = 0, - MaxValue = 15, - 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 = "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 }, - }, - }, - { - 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/APIDocumentation/Documentation/UIModelInfoSharedDocumentation.lua b/APIDocumentation/Documentation/UIModelInfoSharedDocumentation.lua deleted file mode 100644 index 0670831..0000000 --- a/APIDocumentation/Documentation/UIModelInfoSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local UIModelInfoShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UIModelInfoShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UISharedDocumentation.lua b/APIDocumentation/Documentation/UISharedDocumentation.lua deleted file mode 100644 index c0f6de4..0000000 --- a/APIDocumentation/Documentation/UISharedDocumentation.lua +++ /dev/null @@ -1,31 +0,0 @@ -local UIShared = -{ - Tables = - { - { - 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 = "uiRect", - 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/APIDocumentation/Documentation/UISystemVisibilityManagerDocumentation.lua b/APIDocumentation/Documentation/UISystemVisibilityManagerDocumentation.lua deleted file mode 100644 index 4dbfa51..0000000 --- a/APIDocumentation/Documentation/UISystemVisibilityManagerDocumentation.lua +++ /dev/null @@ -1,50 +0,0 @@ -local UISystemVisibilityManager = -{ - Name = "UISystemVisibilityManager", - Type = "System", - Namespace = "C_SystemVisibilityManager", - - Functions = - { - { - Name = "IsSystemVisible", - Type = "Function", - - Arguments = - { - { Name = "system", Type = "UISystemType", Nilable = false }, - }, - - Returns = - { - { Name = "visible", Type = "bool", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "SystemVisibilityChanged", - Type = "Event", - LiteralName = "SYSTEM_VISIBILITY_CHANGED", - }, - }, - - 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/APIDocumentation/Documentation/UITextureAssetSharedDocumentation.lua b/APIDocumentation/Documentation/UITextureAssetSharedDocumentation.lua deleted file mode 100644 index 70e36d9..0000000 --- a/APIDocumentation/Documentation/UITextureAssetSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local UITextureAssetShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UITextureAssetShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UITimerDocumentation.lua b/APIDocumentation/Documentation/UITimerDocumentation.lua deleted file mode 100644 index 23a485f..0000000 --- a/APIDocumentation/Documentation/UITimerDocumentation.lua +++ /dev/null @@ -1,74 +0,0 @@ -local UITimer = -{ - Name = "UITimer", - Type = "System", - Namespace = "C_Timer", - - Functions = - { - { - Name = "After", - Type = "Function", - - Arguments = - { - { Name = "seconds", Type = "number", Nilable = false }, - { Name = "callback", Type = "TimerCallback", Nilable = false }, - }, - }, - { - Name = "NewTicker", - Type = "Function", - - 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", - - 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/APIDocumentation/Documentation/UIWidgetManagerDocumentation.lua b/APIDocumentation/Documentation/UIWidgetManagerDocumentation.lua deleted file mode 100644 index 328d9f0..0000000 --- a/APIDocumentation/Documentation/UIWidgetManagerDocumentation.lua +++ /dev/null @@ -1,501 +0,0 @@ -local UIWidgetManager = -{ - Name = "UIWidgetManager", - Type = "System", - Namespace = "C_UIWidgetManager", - - Functions = - { - { - Name = "GetAllWidgetsBySetID", - Type = "Function", - - 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", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "BulletTextListWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetCaptureBarWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "CaptureBarWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetDoubleIconAndTextWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "DoubleIconAndTextWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetDoubleStatusBarWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "DoubleStatusBarWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetHorizontalCurrenciesWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "HorizontalCurrenciesWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetIconAndTextWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "IconAndTextWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetIconTextAndBackgroundWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "IconTextAndBackgroundWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetIconTextAndCurrenciesWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "IconTextAndCurrenciesWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetStackedResourceTrackerWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "StackedResourceTrackerWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetStatusBarWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "StatusBarWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetTextWithStateWidgetVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "TextWithStateWidgetVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetTextureWithStateVisualizationInfo", - Type = "Function", - - Arguments = - { - { Name = "widgetID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "widgetInfo", Type = "TextureWithStateVisualizationInfo", Nilable = true }, - }, - }, - { - Name = "GetTopCenterWidgetSetID", - Type = "Function", - - Returns = - { - { Name = "setID", Type = "number", Nilable = false }, - }, - }, - }, - - Events = - { - { - Name = "UpdateAllUiWidgets", - Type = "Event", - LiteralName = "UPDATE_ALL_UI_WIDGETS", - }, - { - Name = "UpdateUiWidget", - Type = "Event", - LiteralName = "UPDATE_UI_WIDGET", - Payload = - { - { Name = "widgetInfo", Type = "UIWidgetInfo", Nilable = false }, - }, - }, - }, - - Tables = - { - { - 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 = "WidgetEnabledState", - Type = "Enumeration", - NumValues = 4, - MinValue = 0, - MaxValue = 3, - Fields = - { - { Name = "Disabled", Type = "WidgetEnabledState", EnumValue = 0 }, - { Name = "Enabled", Type = "WidgetEnabledState", EnumValue = 1 }, - { Name = "Red", Type = "WidgetEnabledState", EnumValue = 2 }, - { Name = "Highlight", Type = "WidgetEnabledState", EnumValue = 3 }, - }, - }, - { - Name = "WidgetShownState", - Type = "Enumeration", - NumValues = 2, - MinValue = 0, - MaxValue = 1, - Fields = - { - { Name = "Hidden", Type = "WidgetShownState", EnumValue = 0 }, - { Name = "Shown", Type = "WidgetShownState", 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 = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", Nilable = false }, - }, - }, - { - Name = "CaptureBarWidgetVisualizationInfo", - Type = "Structure", - Fields = - { - { Name = "shownState", Type = "WidgetShownState", Nilable = false }, - { Name = "barPercent", Type = "number", Nilable = false }, - { Name = "neutralPercent", Type = "number", Nilable = false }, - { Name = "textureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "textureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "rightBarMin", Type = "number", Nilable = false }, - { Name = "rightBarMax", Type = "number", Nilable = false }, - { Name = "rightBarValue", Type = "number", Nilable = false }, - { Name = "text", Type = "string", Nilable = false }, - { Name = "textureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", Nilable = false }, - }, - }, - { - Name = "HorizontalCurrenciesWidgetVisualizationInfo", - Type = "Structure", - Fields = - { - { Name = "shownState", Type = "WidgetShownState", Nilable = false }, - { Name = "currencies", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "textureKitID", Type = "number", Nilable = false }, - { Name = "hasTimer", Type = "bool", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", Nilable = false }, - }, - }, - { - Name = "IconTextAndBackgroundWidgetVisualizationInfo", - Type = "Structure", - Fields = - { - { Name = "shownState", Type = "WidgetShownState", Nilable = false }, - { Name = "value", Type = "number", Nilable = false }, - { Name = "textureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "textureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", Nilable = false }, - }, - }, - { - Name = "ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo", - Type = "Structure", - Fields = - { - { Name = "shownState", Type = "WidgetShownState", Nilable = false }, - { Name = "currencies", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, - { Name = "frameTextureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", Nilable = false }, - }, - }, - { - Name = "StackedResourceTrackerWidgetVisualizationInfo", - Type = "Structure", - Fields = - { - { Name = "shownState", Type = "WidgetShownState", Nilable = false }, - { Name = "resources", Type = "table", InnerType = "UIWidgetCurrencyInfo", Nilable = false }, - { Name = "frameTextureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "barWidth", Type = "number", Nilable = false }, - { Name = "barValueInSeconds", Type = "number", Nilable = false }, - { Name = "frameTextureKitID", Type = "number", Nilable = false }, - { Name = "fillTextureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "widgetWidth", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", Nilable = false }, - }, - }, - { - Name = "TextureWithStateVisualizationInfo", - Type = "Structure", - Fields = - { - { Name = "shownState", Type = "WidgetShownState", Nilable = false }, - { Name = "name", Type = "string", Nilable = false }, - { Name = "backgroundTextureKitID", Type = "number", Nilable = false }, - { Name = "portraitTextureKitID", Type = "number", Nilable = false }, - { Name = "orderIndex", Type = "number", Nilable = false }, - { Name = "widgetTag", Type = "string", 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 = "UIWidgetInfo", - Type = "Structure", - Fields = - { - { Name = "widgetID", Type = "number", Nilable = false }, - { Name = "widgetSetID", Type = "number", Nilable = false }, - { Name = "widgetType", Type = "UIWidgetVisualizationType", Nilable = false }, - }, - }, - { - Name = "UIWidgetTextTooltipPair", - Type = "Structure", - Fields = - { - { Name = "text", Type = "string", Nilable = false }, - { Name = "tooltip", Type = "string", Nilable = false }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(UIWidgetManager); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIWidgetManagerSharedDocumentation.lua b/APIDocumentation/Documentation/UIWidgetManagerSharedDocumentation.lua deleted file mode 100644 index bf275f3..0000000 --- a/APIDocumentation/Documentation/UIWidgetManagerSharedDocumentation.lua +++ /dev/null @@ -1,74 +0,0 @@ -local UIWidgetManagerShared = -{ - Tables = - { - { - 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 = "UIWidgetScale", - Type = "Enumeration", - NumValues = 6, - MinValue = 0, - MaxValue = 5, - 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 = "UIWidgetSetLayoutDirection", - Type = "Enumeration", - NumValues = 2, - MinValue = 0, - MaxValue = 1, - Fields = - { - { Name = "Vertical", Type = "UIWidgetSetLayoutDirection", EnumValue = 0 }, - { Name = "Horizontal", Type = "UIWidgetSetLayoutDirection", EnumValue = 1 }, - }, - }, - { - Name = "UIWidgetVisualizationType", - Type = "Enumeration", - NumValues = 13, - MinValue = 0, - MaxValue = 12, - 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 = "TextureWithState", Type = "UIWidgetVisualizationType", EnumValue = 12 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(UIWidgetManagerShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/URLDocumentation.lua b/APIDocumentation/Documentation/URLDocumentation.lua deleted file mode 100644 index 3e53664..0000000 --- a/APIDocumentation/Documentation/URLDocumentation.lua +++ /dev/null @@ -1,19 +0,0 @@ -local URL = -{ - Name = "URL", - Type = "System", - - Functions = - { - }, - - Events = - { - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(URL); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UiModelSceneConstantsDocumentation.lua b/APIDocumentation/Documentation/UiModelSceneConstantsDocumentation.lua deleted file mode 100644 index 8b91f35..0000000 --- a/APIDocumentation/Documentation/UiModelSceneConstantsDocumentation.lua +++ /dev/null @@ -1,33 +0,0 @@ -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 = 3, - MinValue = 1, - MaxValue = 4, - Fields = - { - { Name = "SheatheWeapon", Type = "UIModelSceneFlags", EnumValue = 1 }, - { Name = "HideWeapon", Type = "UIModelSceneFlags", EnumValue = 2 }, - { Name = "Autodress", Type = "UIModelSceneFlags", EnumValue = 4 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(UiModelSceneConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UivisualDocumentation.lua b/APIDocumentation/Documentation/UivisualDocumentation.lua new file mode 100644 index 0000000..f31aaf7 --- /dev/null +++ b/APIDocumentation/Documentation/UivisualDocumentation.lua @@ -0,0 +1,143 @@ +local Uivisual = +{ + Name = "UIVisual", + Type = "System", + Namespace = "UIVisual", + + Functions = + { + { + Name = "ConsoleAddMessage", + Type = "Function", + + }, + { + Name = "ConsoleExec", + Type = "Function", + + Arguments = + { + { Name = "console_command", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SetupFullscreenScale", + Type = "Function", + + Arguments = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + + }, + { + Name = "ShowCloak", + Type = "Function", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ShowHelm", + Type = "Function", + + Arguments = + { + { Name = "show", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "ShowingCloak", + Type = "Function", + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ShowingHelm", + Type = "Function", + + Returns = + { + { Name = "isShown", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "MirrorTimerPause", + Type = "Event", + LiteralName = "MIRROR_TIMER_PAUSE", + Payload = + { + { Name = "duration", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "MirrorTimerStart", + Type = "Event", + LiteralName = "MIRROR_TIMER_START", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, + { Name = "maxvalue", Type = "number", Nilable = false }, + { Name = "step", Type = "number", Nilable = false }, + { Name = "pause", Type = "number", Nilable = false }, + { Name = "label", Type = "string", Nilable = false }, + }, + }, + { + Name = "MirrorTimerStop", + Type = "Event", + LiteralName = "MIRROR_TIMER_STOP", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "TabardCansaveChanged", + Type = "Event", + LiteralName = "TABARD_CANSAVE_CHANGED", + }, + { + Name = "TabardSavePending", + Type = "Event", + LiteralName = "TABARD_SAVE_PENDING", + }, + { + Name = "UiErrorMessage", + Type = "Event", + LiteralName = "UI_ERROR_MESSAGE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + }, + }, + { + Name = "UiInfoMessage", + Type = "Event", + LiteralName = "UI_INFO_MESSAGE", + Payload = + { + { Name = "message", Type = "string", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Uivisual); diff --git a/APIDocumentation/Documentation/UncategorizedDocumentation.lua b/APIDocumentation/Documentation/UncategorizedDocumentation.lua new file mode 100644 index 0000000..afc670f --- /dev/null +++ b/APIDocumentation/Documentation/UncategorizedDocumentation.lua @@ -0,0 +1,1305 @@ +local Uncategorized = +{ + Name = "Uncategorized", + Type = "System", + Namespace = "Uncategorized", + + Functions = + { + { + Name = "AcceptProposal", + Type = "Function", + + }, + { + Name = "BNAcceptFriendInvite", + Type = "Function", + + }, + { + Name = "BNConnected", + Type = "Function", + + Returns = + { + { Name = "isOnline", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNCreateConversation", + Type = "Function", + + Arguments = + { + { Name = "presenceID_1", Type = "number", Nilable = false }, + { Name = "presenceID_2", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNDeclineFriendInvite", + Type = "Function", + + }, + { + Name = "BNFeaturesEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNFeaturesEnabledAndConnected", + Type = "Function", + + }, + { + Name = "BNGetBlockedInfo", + Type = "Function", + + }, + { + Name = "BNGetBlockedToonInfo", + Type = "Function", + + }, + { + Name = "BNGetConversationInfo", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + }, + }, + { + Name = "BNGetConversationMemberInfo", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "number", Nilable = false }, + { Name = "memberIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "unknown", Type = "number", Nilable = false }, + { Name = "displayName", Type = "string", Nilable = false }, + }, + }, + { + Name = "BNGetCustomMessageTable", + Type = "Function", + + }, + { + Name = "BNGetFOFInfo", + Type = "Function", + + Arguments = + { + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "mutual", Type = "bool", Nilable = false }, + { Name = "non-mutual", Type = "bool", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "presenceID", Type = "number", Nilable = false }, + { Name = "givenName", Type = "string", Nilable = false }, + { Name = "surname", Type = "string", Nilable = false }, + { Name = "isFriend", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNGetFriendInviteInfo", + Type = "Function", + + }, + { + Name = "BNGetMaxPlayersInConversation", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "BNGetNumBlocked", + Type = "Function", + + }, + { + Name = "BNGetNumBlockedToons", + Type = "Function", + + }, + { + Name = "BNGetNumConversationMembers", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "memberCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "BNGetNumFOF", + Type = "Function", + + }, + { + Name = "BNGetNumFriendInvites", + Type = "Function", + + }, + { + Name = "BNGetSelectedBlock", + Type = "Function", + + }, + { + Name = "BNGetSelectedToonBlock", + Type = "Function", + + }, + { + Name = "BNInviteToConversation", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "number", Nilable = false }, + { Name = "presenceID", Type = "number", Nilable = false }, + }, + + }, + { + Name = "BNIsBlocked", + Type = "Function", + + }, + { + Name = "BNIsFriend", + Type = "Function", + + }, + { + Name = "BNIsSelf", + Type = "Function", + + Arguments = + { + { Name = "presenceID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isSelf", Type = "bool", Nilable = false }, + }, + }, + { + Name = "BNIsToonBlocked", + Type = "Function", + + }, + { + Name = "BNLeaveConversation", + Type = "Function", + + }, + { + Name = "BNListConversation", + Type = "Function", + + }, + { + Name = "BNRemoveFriend", + Type = "Function", + + }, + { + Name = "BNReportFriendInvite", + Type = "Function", + + }, + { + Name = "BNReportPlayer", + Type = "Function", + + }, + { + Name = "BNRequestFOFInfo", + Type = "Function", + + }, + { + Name = "BNSendConversationMessage", + Type = "Function", + + }, + { + Name = "BNSendFriendInvite", + Type = "Function", + + }, + { + Name = "BNSendFriendInviteByID", + Type = "Function", + + }, + { + Name = "BNSendWhisper", + Type = "Function", + + }, + { + Name = "BNSetAFK", + Type = "Function", + + }, + { + Name = "BNSetBlocked", + Type = "Function", + + }, + { + Name = "BNSetDND", + Type = "Function", + + }, + { + Name = "BNSetFocus", + Type = "Function", + + }, + { + Name = "BNSetSelectedBlock", + Type = "Function", + + }, + { + Name = "BNSetSelectedFriend", + Type = "Function", + + }, + { + Name = "BNSetSelectedToonBlock", + Type = "Function", + + }, + { + Name = "BNSetToonBlocked", + Type = "Function", + + }, + { + Name = "BattlefieldMgrEntryInviteResponse", + Type = "Function", + + }, + { + Name = "BattlefieldMgrExitRequest", + Type = "Function", + + }, + { + Name = "BattlefieldMgrQueueInviteResponse", + Type = "Function", + + }, + { + Name = "BattlefieldMgrQueueRequest", + Type = "Function", + + }, + { + Name = "CalendarContextInviteTentative", + Type = "Function", + + }, + { + Name = "CalendarEventTentative", + Type = "Function", + + }, + { + Name = "CalendarGetDayEventSequenceInfo", + Type = "Function", + + }, + { + Name = "CanChangePlayerDifficulty", + Type = "Function", + + }, + { + Name = "CanMapChangeDifficulty", + Type = "Function", + + }, + { + Name = "CanPartyLFGBackfill", + Type = "Function", + + }, + { + Name = "CanResetTutorials", + Type = "Function", + + }, + { + Name = "CancelSell", + Type = "Function", + + }, + { + Name = "CannotBeResurrected", + Type = "Function", + + }, + { + Name = "ChangePlayerDifficulty", + Type = "Function", + + }, + { + Name = "ClearAllLFGDungeons", + Type = "Function", + + }, + { + Name = "ClearLFGDungeon", + Type = "Function", + + }, + { + Name = "CompleteLFGRoleCheck", + Type = "Function", + + }, + { + Name = "DungeonUsesTerrainMap", + Type = "Function", + + }, + { + Name = "FindSpellBookSlotByID", + Type = "Function", + + }, + { + Name = "ForceGossip", + Type = "Function", + + }, + { + Name = "GMReportLag", + Type = "Function", + + }, + { + Name = "GetAllowLowLevelRaid", + Type = "Function", + + }, + { + Name = "GetAutoCompletePresenceID", + Type = "Function", + + }, + { + Name = "GetAvailableQuestInfo", + Type = "Function", + + Arguments = + { + { Name = "availableIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "isTrivial", Type = "bool", Nilable = false }, + { Name = "isDaily", Type = "bool", Nilable = false }, + { Name = "isRepeatable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetChatWindowSavedDimensions", + Type = "Function", + + }, + { + Name = "GetChatWindowSavedPosition", + Type = "Function", + + }, + { + Name = "GetContainerItemQuestInfo", + Type = "Function", + + Arguments = + { + { Name = "container", Type = "number", Nilable = false }, + { Name = "slot", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isQuest", Type = "bool", Nilable = false }, + { Name = "questId", Type = "number", Nilable = false }, + { Name = "isActive", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetFactionInfoByID", + Type = "Function", + + Arguments = + { + { Name = "factionID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "standingID", Type = "number", Nilable = false }, + { Name = "barMin", Type = "number", Nilable = false }, + { Name = "barMax", Type = "number", Nilable = false }, + { Name = "barValue", Type = "number", Nilable = false }, + { Name = "atWarWith", Type = "bool", Nilable = false }, + { Name = "canToggleAtWar", Type = "bool", Nilable = false }, + { Name = "isHeader", Type = "bool", Nilable = false }, + { Name = "isCollapsed", Type = "bool", Nilable = false }, + { Name = "hasRep", Type = "bool", Nilable = false }, + { Name = "isWatched", Type = "bool", Nilable = false }, + { Name = "isChild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetInstanceLockTimeRemainingEncounter", + Type = "Function", + + }, + { + Name = "GetLFDChoiceCollapseState", + Type = "Function", + + }, + { + Name = "GetLFDChoiceEnabledState", + Type = "Function", + + }, + { + Name = "GetLFDChoiceLockedState", + Type = "Function", + + }, + { + Name = "GetLFDLockInfo", + Type = "Function", + + }, + { + Name = "GetLFDLockPlayerCount", + Type = "Function", + + }, + { + Name = "GetLFGBootProposal", + Type = "Function", + + }, + { + Name = "GetLFGCompletionReward", + Type = "Function", + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "typeID", Type = "number", Nilable = false }, + { Name = "textureFilename", Type = "string", Nilable = false }, + { Name = "moneyBase", Type = "number", Nilable = false }, + { Name = "moneyVar", Type = "number", Nilable = false }, + { Name = "experienceBase", Type = "number", Nilable = false }, + { Name = "experienceVar", Type = "number", Nilable = false }, + { Name = "numStrangers", Type = "number", Nilable = false }, + { Name = "numRewards", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetLFGCompletionRewardItem", + Type = "Function", + + }, + { + Name = "GetLFGDeserterExpiration", + Type = "Function", + + }, + { + Name = "GetLFGDungeonInfo", + Type = "Function", + + }, + { + Name = "GetLFGDungeonRewardInfo", + Type = "Function", + + }, + { + Name = "GetLFGDungeonRewardLink", + Type = "Function", + + }, + { + Name = "GetLFGDungeonRewards", + Type = "Function", + + }, + { + Name = "GetLFGInfoLocal", + Type = "Function", + + }, + { + Name = "GetLFGInfoServer", + Type = "Function", + + }, + { + Name = "GetLFGProposal", + Type = "Function", + + }, + { + Name = "GetLFGProposalEncounter", + Type = "Function", + + }, + { + Name = "GetLFGProposalMember", + Type = "Function", + + }, + { + Name = "GetLFGQueueStats", + Type = "Function", + + }, + { + Name = "GetLFGQueuedList", + Type = "Function", + + }, + { + Name = "GetLFGRandomCooldownExpiration", + Type = "Function", + + }, + { + Name = "GetLFGRandomDungeonInfo", + Type = "Function", + + }, + { + Name = "GetLFGRoleUpdate", + Type = "Function", + + }, + { + Name = "GetLFGRoleUpdateMember", + Type = "Function", + + }, + { + Name = "GetLFGRoleUpdateSlot", + Type = "Function", + + }, + { + Name = "GetLFRChoiceOrder", + Type = "Function", + + }, + { + Name = "GetLastQueueStatusIndex", + Type = "Function", + + }, + { + Name = "GetMultiCastBarOffset", + Type = "Function", + + }, + { + Name = "GetMultiCastTotemSpells", + Type = "Function", + + }, + { + Name = "GetNextCompleatedTutorial", + Type = "Function", + + }, + { + Name = "GetNumQuestItemDrops", + Type = "Function", + + }, + { + Name = "GetNumQuestLogRewardFactions", + Type = "Function", + + }, + { + Name = "GetNumRandomDungeons", + Type = "Function", + + }, + { + Name = "GetPartyLFGBackfillInfo", + Type = "Function", + + }, + { + Name = "GetPetSpellBonusDamage", + Type = "Function", + + }, + { + Name = "GetPrevCompleatedTutorial", + Type = "Function", + + }, + { + Name = "GetQuestLogItemDrop", + Type = "Function", + + }, + { + Name = "GetQuestLogRewardArenaPoints", + Type = "Function", + + }, + { + Name = "GetQuestLogRewardFactionInfo", + Type = "Function", + + }, + { + Name = "GetQuestLogRewardXP", + Type = "Function", + + Returns = + { + { Name = "experience", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetQuestPOILeaderBoard", + Type = "Function", + + }, + { + Name = "GetQuestSortIndex", + Type = "Function", + + }, + { + Name = "GetQuestWatchIndex", + Type = "Function", + + Arguments = + { + { Name = "questLogIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questWatchIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetQuestWorldMapAreaID", + Type = "Function", + + }, + { + Name = "GetRaidDifficulty", + Type = "Function", + + }, + { + Name = "GetRandomBGHonorCurrencyBonuses", + Type = "Function", + + }, + { + Name = "GetRandomDungeonBestChoice", + Type = "Function", + + }, + { + Name = "GetRewardArenaPoints", + Type = "Function", + + Returns = + { + { Name = "arenaPoints", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVehicleUIIndicator", + Type = "Function", + + }, + { + Name = "GetVehicleUIIndicatorSeat", + Type = "Function", + + }, + { + Name = "HasCompletedAnyAchievement", + Type = "Function", + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "HasLFGRestrictions", + Type = "Function", + + }, + { + Name = "IsBNLogin", + Type = "Function", + + }, + { + Name = "IsInLFGDungeon", + Type = "Function", + + }, + { + Name = "IsLFGDungeonJoinable", + Type = "Function", + + }, + { + Name = "IsListedInLFR", + Type = "Function", + + Returns = + { + { Name = "listedInLFR", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPartyLFG", + Type = "Function", + + }, + { + Name = "IsPetAttackAction", + Type = "Function", + + }, + { + Name = "IsTutorialFlagged", + Type = "Function", + + }, + { + Name = "IsZoomOutAvailable", + Type = "Function", + + }, + { + Name = "JoinLFG", + Type = "Function", + + }, + { + Name = "LeaveLFG", + Type = "Function", + + }, + { + Name = "PartyLFGStartBackfill", + Type = "Function", + + }, + { + Name = "ProcessQuestLogRewardFactions", + Type = "Function", + + }, + { + Name = "QuestIsDaily", + Type = "Function", + + }, + { + Name = "QuestIsWeekly", + Type = "Function", + + }, + { + Name = "QuestMapUpdateAllQuests", + Type = "Function", + + }, + { + Name = "QuestPOIGetIconInfo", + Type = "Function", + + }, + { + Name = "QuestPOIGetQuestIDByIndex", + Type = "Function", + + }, + { + Name = "QuestPOIGetQuestIDByVisibleIndex", + Type = "Function", + + }, + { + Name = "QuestPOIUpdateIcons", + Type = "Function", + + }, + { + Name = "RefreshLFGList", + Type = "Function", + + }, + { + Name = "RegisterStaticConstants", + Type = "Function", + + }, + { + Name = "RejectProposal", + Type = "Function", + + }, + { + Name = "RequestLFDPartyLockInfo", + Type = "Function", + + }, + { + Name = "RequestLFDPlayerLockInfo", + Type = "Function", + + }, + { + Name = "RespondMailLockSendItem", + Type = "Function", + + }, + { + Name = "SearchLFGGetEncounterResults", + Type = "Function", + + }, + { + Name = "SearchLFGGetJoinedID", + Type = "Function", + + }, + { + Name = "SearchLFGGetNumResults", + Type = "Function", + + }, + { + Name = "SearchLFGGetPartyResults", + Type = "Function", + + }, + { + Name = "SearchLFGGetResults", + Type = "Function", + + }, + { + Name = "SearchLFGJoin", + Type = "Function", + + }, + { + Name = "SearchLFGLeave", + Type = "Function", + + }, + { + Name = "SearchLFGSort", + Type = "Function", + + }, + { + Name = "SendSystemMessage", + Type = "Function", + + }, + { + Name = "SetAllowLowLevelRaid", + Type = "Function", + + Arguments = + { + { Name = "enable", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetAuctionsTabShowing", + Type = "Function", + + }, + { + Name = "SetChatColorNameByClass", + Type = "Function", + + Arguments = + { + { Name = "chatType", Type = "string", Nilable = false }, + { Name = "colorByName", Type = "bool", Nilable = false }, + }, + + }, + { + Name = "SetChatWindowSavedDimensions", + Type = "Function", + + }, + { + Name = "SetChatWindowSavedPosition", + Type = "Function", + + }, + { + Name = "SetLFGBootVote", + Type = "Function", + + }, + { + Name = "SetLFGDungeon", + Type = "Function", + + Arguments = + { + { Name = "queueIndex", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetLFGDungeonEnabled", + Type = "Function", + + }, + { + Name = "SetLFGHeaderCollapsed", + Type = "Function", + + }, + { + Name = "SetMapByID", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetPOIIconOverlapDistance", + Type = "Function", + + }, + { + Name = "SetPOIIconOverlapPushDistance", + Type = "Function", + + }, + { + Name = "SetSavedInstanceExtend", + Type = "Function", + + }, + { + Name = "ShiftQuestWatches", + Type = "Function", + + }, + { + Name = "SortBGList", + Type = "Function", + + }, + { + Name = "SortQuestWatches", + Type = "Function", + + Returns = + { + { Name = "changed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "Stopwatch_Clear", + Type = "Function", + + }, + { + Name = "Stopwatch_FinishCountdown", + Type = "Function", + + }, + { + Name = "Stopwatch_IsPlaying", + Type = "Function", + + }, + { + Name = "Stopwatch_Pause", + Type = "Function", + + }, + { + Name = "Stopwatch_Play", + Type = "Function", + + }, + { + Name = "Stopwatch_StartCountdown", + Type = "Function", + + }, + { + Name = "Stopwatch_Toggle", + Type = "Function", + + }, + { + Name = "TriggerTutorial", + Type = "Function", + + }, + { + Name = "UnitGroupRolesAssigned", + Type = "Function", + + }, + { + Name = "UnitHasLFGDeserter", + Type = "Function", + + }, + { + Name = "UnitHasLFGRandomCooldown", + Type = "Function", + + }, + { + Name = "debughook", + Type = "Function", + + }, + }, + + Events = + { + { + Name = "BindEnchant", + Type = "Event", + LiteralName = "BIND_ENCHANT", + }, + { + Name = "ConfirmBinder", + Type = "Event", + LiteralName = "CONFIRM_BINDER", + Payload = + { + { Name = "newHome", Type = "string", Nilable = false }, + }, + }, + { + Name = "ConfirmDisenchantRoll", + Type = "Event", + LiteralName = "CONFIRM_DISENCHANT_ROLL", + }, + { + Name = "ConfirmSummon", + Type = "Event", + LiteralName = "CONFIRM_SUMMON", + }, + { + Name = "ConfirmXpLoss", + Type = "Event", + LiteralName = "CONFIRM_XP_LOSS", + }, + { + Name = "CorpseInRange", + Type = "Event", + LiteralName = "CORPSE_IN_RANGE", + }, + { + Name = "CorpseOutOfRange", + Type = "Event", + LiteralName = "CORPSE_OUT_OF_RANGE", + }, + { + Name = "DisableTaxiBenchmark", + Type = "Event", + LiteralName = "DISABLE_TAXI_BENCHMARK", + }, + { + Name = "DisableXpGain", + Type = "Event", + LiteralName = "DISABLE_XP_GAIN", + }, + { + Name = "EnableTaxiBenchmark", + Type = "Event", + LiteralName = "ENABLE_TAXI_BENCHMARK", + }, + { + Name = "EnableXpGain", + Type = "Event", + LiteralName = "ENABLE_XP_GAIN", + }, + { + Name = "RunePowerUpdate", + Type = "Event", + LiteralName = "RUNE_POWER_UPDATE", + Payload = + { + { Name = "runeIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEnergize", Type = "string", Nilable = false }, + }, + }, + { + Name = "RuneTypeUpdate", + Type = "Event", + LiteralName = "RUNE_TYPE_UPDATE", + Payload = + { + { Name = "runeIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ScreenshotFailed", + Type = "Event", + LiteralName = "SCREENSHOT_FAILED", + }, + { + Name = "ScreenshotSucceeded", + Type = "Event", + LiteralName = "SCREENSHOT_SUCCEEDED", + }, + { + Name = "UpdateBindings", + Type = "Event", + LiteralName = "UPDATE_BINDINGS", + }, + { + Name = "UpdateExhaustion", + Type = "Event", + LiteralName = "UPDATE_EXHAUSTION", + }, + { + Name = "UpdateGmStatus", + Type = "Event", + LiteralName = "UPDATE_GM_STATUS", + Payload = + { + { Name = "avilable", Type = "number", Nilable = false }, + }, + }, + { + Name = "UpdateLfgList", + Type = "Event", + LiteralName = "UPDATE_LFG_LIST", + }, + { + Name = "UpdateLfgListIncremental", + Type = "Event", + LiteralName = "UPDATE_LFG_LIST_INCREMENTAL", + }, + { + Name = "UpdateLfgTypes", + Type = "Event", + LiteralName = "UPDATE_LFG_TYPES", + }, + { + Name = "UpdateShapeshiftCooldown", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_COOLDOWN", + }, + { + Name = "UpdateShapeshiftForm", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_FORM", + }, + { + Name = "UpdateShapeshiftForms", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_FORMS", + }, + { + Name = "UpdateShapeshiftUsable", + Type = "Event", + LiteralName = "UPDATE_SHAPESHIFT_USABLE", + }, + { + Name = "UpdateStealth", + Type = "Event", + LiteralName = "UPDATE_STEALTH", + }, + { + Name = "UpdateTicket", + Type = "Event", + LiteralName = "UPDATE_TICKET", + }, + { + Name = "UpdateWorldStates", + Type = "Event", + LiteralName = "UPDATE_WORLD_STATES", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Uncategorized); diff --git a/APIDocumentation/Documentation/UncategorizedeventsDocumentation.lua b/APIDocumentation/Documentation/UncategorizedeventsDocumentation.lua new file mode 100644 index 0000000..c8556f6 --- /dev/null +++ b/APIDocumentation/Documentation/UncategorizedeventsDocumentation.lua @@ -0,0 +1,212 @@ +local Uncategorizedevents = +{ + Name = "UncategorizedEvents", + Type = "System", + Namespace = "UncategorizedEvents", + + Functions = + { + }, + + Events = + { + { + Name = "CancelSummon", + Type = "Event", + LiteralName = "CANCEL_SUMMON", + }, + { + Name = "CloseTabardFrame", + Type = "Event", + LiteralName = "CLOSE_TABARD_FRAME", + }, + { + Name = "CriteriaUpdate", + Type = "Event", + LiteralName = "CRITERIA_UPDATE", + }, + { + Name = "DisplaySizeChanged", + Type = "Event", + LiteralName = "DISPLAY_SIZE_CHANGED", + }, + { + Name = "EndRefund", + Type = "Event", + LiteralName = "END_REFUND", + }, + { + Name = "EquipBindConfirm", + Type = "Event", + LiteralName = "EQUIP_BIND_CONFIRM", + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "FriendlistUpdate", + Type = "Event", + LiteralName = "FRIENDLIST_UPDATE", + }, + { + Name = "GmresponseReceived", + Type = "Event", + LiteralName = "GMRESPONSE_RECEIVED", + }, + { + Name = "GmPlayerInfo", + Type = "Event", + LiteralName = "GM_PLAYER_INFO", + }, + { + Name = "IgnorelistUpdate", + Type = "Event", + LiteralName = "IGNORELIST_UPDATE", + }, + { + Name = "IgrBillingNagDialog", + Type = "Event", + LiteralName = "IGR_BILLING_NAG_DIALOG", + }, + { + Name = "KnownTitlesUpdate", + Type = "Event", + LiteralName = "KNOWN_TITLES_UPDATE", + }, + { + Name = "LanguageListChanged", + Type = "Event", + LiteralName = "LANGUAGE_LIST_CHANGED", + }, + { + Name = "LevelGrantProposed", + Type = "Event", + LiteralName = "LEVEL_GRANT_PROPOSED", + }, + { + Name = "LogoutCancel", + Type = "Event", + LiteralName = "LOGOUT_CANCEL", + }, + { + Name = "ModifierStateChanged", + Type = "Event", + LiteralName = "MODIFIER_STATE_CHANGED", + Payload = + { + { Name = "key", Type = "string", Nilable = false }, + { Name = "state", Type = "number", Nilable = false }, + }, + }, + { + Name = "MutelistUpdate", + Type = "Event", + LiteralName = "MUTELIST_UPDATE", + }, + { + Name = "NewTitleEarned", + Type = "Event", + LiteralName = "NEW_TITLE_EARNED", + Payload = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "OldTitleLost", + Type = "Event", + LiteralName = "OLD_TITLE_LOST", + Payload = + { + { Name = "title", Type = "string", Nilable = false }, + }, + }, + { + Name = "OpenTabardFrame", + Type = "Event", + LiteralName = "OPEN_TABARD_FRAME", + }, + { + Name = "PlaytimeChanged", + Type = "Event", + LiteralName = "PLAYTIME_CHANGED", + }, + { + Name = "PlayMovie", + Type = "Event", + LiteralName = "PLAY_MOVIE", + }, + { + Name = "RaisedAsGhoul", + Type = "Event", + LiteralName = "RAISED_AS_GHOUL", + }, + { + Name = "ReplaceEnchant", + Type = "Event", + LiteralName = "REPLACE_ENCHANT", + Payload = + { + { Name = "current", Type = "string", Nilable = false }, + { Name = "new", Type = "string", Nilable = false }, + }, + }, + { + Name = "SynchronizeSettings", + Type = "Event", + LiteralName = "SYNCHRONIZE_SETTINGS", + }, + { + Name = "TimePlayedMsg", + Type = "Event", + LiteralName = "TIME_PLAYED_MSG", + Payload = + { + { Name = "total", Type = "number", Nilable = false }, + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "UseBindConfirm", + Type = "Event", + LiteralName = "USE_BIND_CONFIRM", + }, + { + Name = "VariablesLoaded", + Type = "Event", + LiteralName = "VARIABLES_LOADED", + }, + { + Name = "VoteKickReasonNeeded", + Type = "Event", + LiteralName = "VOTE_KICK_REASON_NEEDED", + }, + { + Name = "WearEquipmentSet", + Type = "Event", + LiteralName = "WEAR_EQUIPMENT_SET", + }, + { + Name = "WhoListUpdate", + Type = "Event", + LiteralName = "WHO_LIST_UPDATE", + }, + { + Name = "WorldStateUiTimerUpdate", + Type = "Event", + LiteralName = "WORLD_STATE_UI_TIMER_UPDATE", + }, + { + Name = "WowMouseNotFound", + Type = "Event", + LiteralName = "WOW_MOUSE_NOT_FOUND", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Uncategorizedevents); diff --git a/APIDocumentation/Documentation/UnitAuraDocumentation.lua b/APIDocumentation/Documentation/UnitAuraDocumentation.lua deleted file mode 100644 index 5ba67a9..0000000 --- a/APIDocumentation/Documentation/UnitAuraDocumentation.lua +++ /dev/null @@ -1,28 +0,0 @@ -local UnitAura = -{ - Name = "UnitAuraUpdate", - Type = "System", - - Functions = - { - }, - - Events = - { - { - Name = "UnitAura", - Type = "Event", - LiteralName = "UNIT_AURA", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UnitAura); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UnitConstantsDocumentation.lua b/APIDocumentation/Documentation/UnitConstantsDocumentation.lua deleted file mode 100644 index b8aef54..0000000 --- a/APIDocumentation/Documentation/UnitConstantsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local UnitConstants = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UnitConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UnitDocumentation.lua b/APIDocumentation/Documentation/UnitDocumentation.lua index 3347bad..d2877a8 100644 --- a/APIDocumentation/Documentation/UnitDocumentation.lua +++ b/APIDocumentation/Documentation/UnitDocumentation.lua @@ -2,21 +2,164 @@ local Unit = { Name = "Unit", Type = "System", + Namespace = "Unit", Functions = { { - Name = "IsPlayerInGuildFromGUID", + Name = "CanInspect", Type = "Function", Arguments = { - { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "showError", Type = "bool", Nilable = false }, }, Returns = { - { Name = "IsInGuild", Type = "bool", Nilable = false }, + { Name = "canInspect", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CheckInteractDistance", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "distIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canInteract", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetGuildInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "guildName", Type = "string", Nilable = false }, + { Name = "guildRankName", Type = "string", Nilable = false }, + { Name = "guildRankIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetMuteStatus", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "channel", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "muteStatus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetPlayerInfoByGUID", + Type = "Function", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "class", Type = "string", Nilable = false }, + { Name = "classFilename", Type = "string", Nilable = false }, + { Name = "race", Type = "string", Nilable = false }, + { Name = "raceFilename", Type = "string", Nilable = false }, + { Name = "sex", Type = "number", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "realm", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetUnitName", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "showServerName", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "nameString", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetUnitSpeed", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "speed", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsIgnoredOrMuted", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isIgnoredOrMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMuted", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "muted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUnitOnQuest", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, }, }, { @@ -25,42 +168,14 @@ local Unit = 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", - - Arguments = - { - { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, - { Name = "creatureDisplayID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetUnitCursorTexture", - Type = "Function", - - Arguments = - { - { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, + { Name = "texture", Type = "table", 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 = "ShouldKnowUnitHealth", + Name = "UnitAffectingCombat", Type = "Function", - Documentation = { "Whether the player would have been able to know the unit's exact health value in the original game release." }, Arguments = { @@ -69,7 +184,123 @@ local Unit = Returns = { - { Name = "shouldKnowUnitHealth", Type = "bool", Nilable = false }, + { Name = "inCombat", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitAura", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "rank", Type = "string", Nilable = true }, + { Name = "filter", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "dispelType", Type = "string", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "expires", Type = "number", Nilable = false }, + { Name = "caster", Type = "string", Nilable = false }, + { Name = "isStealable", Type = "1nil", Nilable = false }, + { Name = "shouldConsolidate", Type = "bool", Nilable = false }, + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitCanAssist", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "canAssist", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCanAttack", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "canAttack", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCanCooperate", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "canCooperate", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitCastingInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subText", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "endTime", Type = "time_t", Nilable = false }, + { Name = "isTradeSkill", Type = "bool", Nilable = false }, + { Name = "castID", Type = "number", Nilable = false }, + { Name = "notInterruptible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitChannelInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "subText", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "texture", Type = "string", Nilable = false }, + { Name = "startTime", Type = "time_t", Nilable = false }, + { Name = "endTime", Type = "time_t", Nilable = false }, + { Name = "isTradeSkill", Type = "bool", Nilable = false }, + { Name = "notInterruptible", Type = "bool", Nilable = false }, }, }, { @@ -78,20 +309,36 @@ local Unit = Arguments = { - { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, }, Returns = { - { Name = "className", Type = "cstring", Nilable = false }, - { Name = "classFilename", Type = "cstring", Nilable = false }, - { Name = "classID", Type = "number", Nilable = false }, + { Name = "class", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "string", Nilable = false }, }, }, { Name = "UnitClassBase", Type = "Function", + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "class", Type = "string", Nilable = false }, + { Name = "classFileName", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitClassification", + Type = "Function", + Arguments = { { Name = "unit", Type = "UnitToken", Nilable = false }, @@ -99,8 +346,235 @@ local Unit = Returns = { - { Name = "classFilename", Type = "cstring", Nilable = false }, - { Name = "classID", Type = "number", Nilable = false }, + { Name = "classification", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitCreatureFamily", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "family", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitCreatureType", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "type", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitDebuff", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "index", Type = "luaIndex", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "rank", Type = "string", Nilable = true }, + { Name = "filter", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "rank", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + { Name = "dispelType", Type = "string", Nilable = false }, + { Name = "duration", Type = "time_t", Nilable = false }, + { Name = "expires", Type = "number", Nilable = false }, + { Name = "caster", Type = "string", Nilable = false }, + { Name = "isStealable", Type = "1nil", Nilable = false }, + }, + }, + { + Name = "UnitExists", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitFactionGroup", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "factionGroup", Type = "string", Nilable = false }, + { Name = "factionName", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitGUID", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "UnitHasRelicSlot", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "hasRelic", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitHealth", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "modifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitHealthMax", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "maxValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitInBattleground", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "raidNum", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitInParty", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInRaid", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "inRaid", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitInRange", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inRange", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsAFK", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isAFK", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsCharmed", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isCharmed", Type = "bool", Nilable = false }, }, }, { @@ -118,68 +592,7 @@ local Unit = }, }, { - Name = "UnitIsOwnerOrControllerOfUnit", - Type = "Function", - - Arguments = - { - { Name = "controllingUnit", Type = "UnitToken", Nilable = false }, - { Name = "controlledUnit", Type = "UnitToken", Nilable = false }, - }, - - Returns = - { - { Name = "unitIsOwnerOrControllerOfUnit", Type = "bool", Nilable = false }, - }, - }, - { - Name = "UnitPower", - Type = "Function", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - { Name = "powerType", Type = "PowerType", Nilable = false, Default = "NumPowerTypes" }, - { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "power", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitPowerDisplayMod", - Type = "Function", - - Arguments = - { - { Name = "powerType", Type = "PowerType", Nilable = false }, - }, - - Returns = - { - { Name = "displayMod", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitPowerMax", - Type = "Function", - - Arguments = - { - { Name = "unitToken", Type = "UnitToken", Nilable = false }, - { Name = "powerType", Type = "PowerType", Nilable = false, Default = "NumPowerTypes" }, - { Name = "unmodified", Type = "bool", Nilable = false, Default = false }, - }, - - Returns = - { - { Name = "maxPower", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSex", + Name = "UnitIsControlling", Type = "Function", Arguments = @@ -189,430 +602,615 @@ local Unit = Returns = { - { Name = "sex", Type = "number", Nilable = true }, + { Name = "isControlling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsCorpse", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isCorpse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDND", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isDND", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDead", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isDead", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsDeadOrGhost", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isDeadOrGhost", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsEnemy", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isEnemy", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsFeignDeath", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isFeign", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsFriend", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isFriends", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsGhost", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isGhost", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsInMyGuild", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inGuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVP", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isPVP", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVPFreeForAll", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isFreeForAll", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPVPSanctuary", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPartyLeader", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "leader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPlayer", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsPossessed", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isPossessed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsRaidOfficer", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "leader", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsSameServer", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isSame", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsTapped", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + }, + { + Name = "UnitIsTappedByAllThreatList", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "allTapped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsTappedByPlayer", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isTapped", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsTrivial", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isTrivial", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isSame", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsVisible", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isVisible", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitLevel", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "level", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitMana", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "regen", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitManaMax", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "maxValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitName", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "showServerName", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "nameString", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitOnTaxi", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "onTaxi", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPVPName", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitPVPRank", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPlayerControlled", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isPlayer", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPlayerOrPetInParty", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPlayerOrPetInRaid", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inParty", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitPower", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "modifier", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerMax", + Type = "Function", + + Arguments = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + { Name = "powerType", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "maxValue", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitPowerType", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "powerType", Type = "number", Nilable = false }, + { Name = "powerToken", Type = "string", Nilable = false }, + { Name = "altR", Type = "number", Nilable = false }, + { Name = "altG", Type = "number", Nilable = false }, + { Name = "altB", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitRace", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "race", Type = "string", Nilable = false }, + { Name = "fileName", Type = "string", Nilable = false }, + }, + }, + { + Name = "UnitReaction", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "reaction", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSelectionColor", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "red", Type = "number", Nilable = false }, + { Name = "green", Type = "number", Nilable = false }, + { Name = "blue", Type = "number", Nilable = false }, + { Name = "alpha", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitSex", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "gender", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitUsingVehicle", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "usingVehicle", Type = "bool", Nilable = false }, }, }, }, Events = { - { - Name = "ActivePlayerSpecializationChanged", - Type = "Event", - LiteralName = "ACTIVE_PLAYER_SPECIALIZATION_CHANGED", - }, - { - Name = "ArenaCooldownsUpdate", - Type = "Event", - LiteralName = "ARENA_COOLDOWNS_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "ArenaCrowdControlSpellUpdate", - Type = "Event", - LiteralName = "ARENA_CROWD_CONTROL_SPELL_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - { Name = "itemID", Type = "number", Nilable = false }, - }, - }, - { - Name = "AutofollowBegin", - Type = "Event", - LiteralName = "AUTOFOLLOW_BEGIN", - Payload = - { - { Name = "name", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "AutofollowEnd", - Type = "Event", - LiteralName = "AUTOFOLLOW_END", - }, - { - Name = "CancelSummon", - Type = "Event", - LiteralName = "CANCEL_SUMMON", - }, - { - Name = "ConfirmBinder", - Type = "Event", - LiteralName = "CONFIRM_BINDER", - Payload = - { - { Name = "areaName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ConfirmSummon", - Type = "Event", - LiteralName = "CONFIRM_SUMMON", - Payload = - { - { Name = "summonReason", Type = "number", Nilable = false }, - { Name = "skippingStartExperience", Type = "bool", Nilable = false }, - }, - }, - { - Name = "HearthstoneBound", - Type = "Event", - LiteralName = "HEARTHSTONE_BOUND", - }, - { - Name = "IncomingResurrectChanged", - Type = "Event", - LiteralName = "INCOMING_RESURRECT_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "LocalplayerPetRenamed", - Type = "Event", - LiteralName = "LOCALPLAYER_PET_RENAMED", - }, - { - Name = "MirrorTimerPause", - Type = "Event", - LiteralName = "MIRROR_TIMER_PAUSE", - Payload = - { - { Name = "timerName", Type = "cstring", Nilable = false }, - { Name = "paused", Type = "number", Nilable = false }, - }, - }, - { - Name = "MirrorTimerStart", - Type = "Event", - LiteralName = "MIRROR_TIMER_START", - 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", - Payload = - { - { Name = "timerName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "ObjectEnteredAOI", - Type = "Event", - LiteralName = "OBJECT_ENTERED_AOI", - Payload = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "ObjectLeftAOI", - Type = "Event", - LiteralName = "OBJECT_LEFT_AOI", - Payload = - { - { Name = "guid", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "PetBarUpdateUsable", - Type = "Event", - LiteralName = "PET_BAR_UPDATE_USABLE", - }, - { - Name = "PetUiUpdate", - Type = "Event", - LiteralName = "PET_UI_UPDATE", - }, - { - Name = "PlayerCanGlideChanged", - Type = "Event", - LiteralName = "PLAYER_CAN_GLIDE_CHANGED", - Payload = - { - { Name = "canGlide", Type = "bool", Nilable = false }, - }, - }, - { - Name = "PlayerDamageDoneMods", - Type = "Event", - LiteralName = "PLAYER_DAMAGE_DONE_MODS", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerEnterCombat", - Type = "Event", - LiteralName = "PLAYER_ENTER_COMBAT", - }, - { - Name = "PlayerFarsightFocusChanged", - Type = "Event", - LiteralName = "PLAYER_FARSIGHT_FOCUS_CHANGED", - }, - { - Name = "PlayerFlagsChanged", - Type = "Event", - LiteralName = "PLAYER_FLAGS_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerFocusChanged", - Type = "Event", - LiteralName = "PLAYER_FOCUS_CHANGED", - }, - { - Name = "PlayerLeaveCombat", - Type = "Event", - LiteralName = "PLAYER_LEAVE_COMBAT", - }, - { - Name = "PlayerLevelChanged", - Type = "Event", - LiteralName = "PLAYER_LEVEL_CHANGED", - Payload = - { - { Name = "oldLevel", Type = "number", Nilable = false }, - { Name = "newLevel", Type = "number", Nilable = false }, - }, - }, - { - Name = "PlayerLevelUp", - Type = "Event", - LiteralName = "PLAYER_LEVEL_UP", - 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 = "spiritDelta", Type = "number", Nilable = false }, - }, - }, - { - Name = "PlayerMaxLevelUpdate", - Type = "Event", - LiteralName = "PLAYER_MAX_LEVEL_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerMountDisplayChanged", - Type = "Event", - LiteralName = "PLAYER_MOUNT_DISPLAY_CHANGED", - }, - { - Name = "PlayerPvpKillsChanged", - Type = "Event", - LiteralName = "PLAYER_PVP_KILLS_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerPvpRankChanged", - Type = "Event", - LiteralName = "PLAYER_PVP_RANK_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerRegenDisabled", - Type = "Event", - LiteralName = "PLAYER_REGEN_DISABLED", - }, - { - Name = "PlayerRegenEnabled", - Type = "Event", - LiteralName = "PLAYER_REGEN_ENABLED", - }, - { - Name = "PlayerSoftEnemyChanged", - Type = "Event", - LiteralName = "PLAYER_SOFT_ENEMY_CHANGED", - }, - { - Name = "PlayerSoftFriendChanged", - Type = "Event", - LiteralName = "PLAYER_SOFT_FRIEND_CHANGED", - }, - { - Name = "PlayerSoftInteractChanged", - Type = "Event", - LiteralName = "PLAYER_SOFT_INTERACT_CHANGED", - Payload = - { - { Name = "oldTarget", Type = "WOWGUID", Nilable = false }, - { Name = "newTarget", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "PlayerSoftTargetInteraction", - Type = "Event", - LiteralName = "PLAYER_SOFT_TARGET_INTERACTION", - }, - { - Name = "PlayerStartedLooking", - Type = "Event", - LiteralName = "PLAYER_STARTED_LOOKING", - }, - { - Name = "PlayerStartedMoving", - Type = "Event", - LiteralName = "PLAYER_STARTED_MOVING", - }, - { - Name = "PlayerStartedTurning", - Type = "Event", - LiteralName = "PLAYER_STARTED_TURNING", - }, - { - Name = "PlayerStoppedLooking", - Type = "Event", - LiteralName = "PLAYER_STOPPED_LOOKING", - }, - { - Name = "PlayerStoppedMoving", - Type = "Event", - LiteralName = "PLAYER_STOPPED_MOVING", - }, - { - Name = "PlayerStoppedTurning", - Type = "Event", - LiteralName = "PLAYER_STOPPED_TURNING", - }, - { - Name = "PlayerTargetChanged", - Type = "Event", - LiteralName = "PLAYER_TARGET_CHANGED", - }, - { - Name = "PlayerTargetSetAttacking", - Type = "Event", - LiteralName = "PLAYER_TARGET_SET_ATTACKING", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerTrialXpUpdate", - Type = "Event", - LiteralName = "PLAYER_TRIAL_XP_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PlayerUpdateResting", - Type = "Event", - LiteralName = "PLAYER_UPDATE_RESTING", - }, - { - Name = "PlayerXpUpdate", - Type = "Event", - LiteralName = "PLAYER_XP_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "PortraitsUpdated", - Type = "Event", - LiteralName = "PORTRAITS_UPDATED", - }, - { - Name = "PvpTimerUpdate", - Type = "Event", - LiteralName = "PVP_TIMER_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "RunePowerUpdate", - Type = "Event", - LiteralName = "RUNE_POWER_UPDATE", - Payload = - { - { Name = "runeIndex", Type = "number", Nilable = false }, - { Name = "added", Type = "bool", Nilable = true }, - }, - }, - { - Name = "RuneTypeUpdate", - Type = "Event", - LiteralName = "RUNE_TYPE_UPDATE", - Payload = - { - { Name = "runeIndex", Type = "number", Nilable = false }, - }, - }, - { - Name = "SpellConfirmationPrompt", - Type = "Event", - LiteralName = "SPELL_CONFIRMATION_PROMPT", - 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", - Payload = - { - { Name = "spellID", Type = "number", Nilable = false }, - { Name = "effectValue", Type = "number", Nilable = false }, - }, - }, { Name = "UnitAttack", Type = "Event", LiteralName = "UNIT_ATTACK", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -621,7 +1219,7 @@ local Unit = LiteralName = "UNIT_ATTACK_POWER", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -630,13 +1228,17 @@ local Unit = LiteralName = "UNIT_ATTACK_SPEED", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { - Name = "UnitCheatToggleEvent", + Name = "UnitAura", Type = "Event", - LiteralName = "UNIT_CHEAT_TOGGLE_EVENT", + LiteralName = "UNIT_AURA", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, }, { Name = "UnitClassificationChanged", @@ -644,31 +1246,13 @@ local Unit = LiteralName = "UNIT_CLASSIFICATION_CHANGED", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { - Name = "UnitCombat", + Name = "UnitComboPoints", Type = "Event", - LiteralName = "UNIT_COMBAT", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", 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", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "isConnected", Type = "bool", Nilable = false }, - }, + LiteralName = "UNIT_COMBO_POINTS", }, { Name = "UnitDamage", @@ -676,7 +1260,7 @@ local Unit = LiteralName = "UNIT_DAMAGE", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -685,7 +1269,7 @@ local Unit = LiteralName = "UNIT_DEFENSE", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -694,17 +1278,13 @@ local Unit = LiteralName = "UNIT_DISPLAYPOWER", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { - Name = "UnitFaction", + Name = "UnitDynamicFlags", Type = "Event", - LiteralName = "UNIT_FACTION", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, + LiteralName = "UNIT_DYNAMIC_FLAGS", }, { Name = "UnitFlags", @@ -712,34 +1292,7 @@ local Unit = LiteralName = "UNIT_FLAGS", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitFormChanged", - Type = "Event", - LiteralName = "UNIT_FORM_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitHappiness", - Type = "Event", - LiteralName = "UNIT_HAPPINESS", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitHealPrediction", - Type = "Event", - LiteralName = "UNIT_HEAL_PREDICTION", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, }, }, { @@ -748,25 +1301,7 @@ local Unit = LiteralName = "UNIT_HEALTH", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitHealthFrequent", - Type = "Event", - LiteralName = "UNIT_HEALTH_FREQUENT", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitInventoryChanged", - Type = "Event", - LiteralName = "UNIT_INVENTORY_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -775,7 +1310,7 @@ local Unit = LiteralName = "UNIT_LEVEL", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -784,7 +1319,7 @@ local Unit = LiteralName = "UNIT_MANA", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -793,17 +1328,7 @@ local Unit = LiteralName = "UNIT_MAXHEALTH", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitMaxpower", - Type = "Event", - LiteralName = "UNIT_MAXPOWER", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "powerType", Type = "cstring", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -812,7 +1337,7 @@ local Unit = LiteralName = "UNIT_MODEL_CHANGED", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -821,16 +1346,7 @@ local Unit = LiteralName = "UNIT_NAME_UPDATE", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitOtherPartyChanged", - Type = "Event", - LiteralName = "UNIT_OTHER_PARTY_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -839,35 +1355,13 @@ local Unit = LiteralName = "UNIT_PET", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { Name = "UnitPetExperience", Type = "Event", LiteralName = "UNIT_PET_EXPERIENCE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitPetTrainingPoints", - Type = "Event", - LiteralName = "UNIT_PET_TRAINING_POINTS", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitPhase", - Type = "Event", - LiteralName = "UNIT_PHASE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, }, { Name = "UnitPortraitUpdate", @@ -875,72 +1369,16 @@ local Unit = LiteralName = "UNIT_PORTRAIT_UPDATE", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { - Name = "UnitPowerBarHide", + Name = "UnitRage", Type = "Event", - LiteralName = "UNIT_POWER_BAR_HIDE", + LiteralName = "UNIT_RAGE", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitPowerBarShow", - Type = "Event", - LiteralName = "UNIT_POWER_BAR_SHOW", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitPowerBarTimerUpdate", - Type = "Event", - LiteralName = "UNIT_POWER_BAR_TIMER_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitPowerFrequent", - Type = "Event", - LiteralName = "UNIT_POWER_FREQUENT", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "powerType", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "UnitPowerUpdate", - Type = "Event", - LiteralName = "UNIT_POWER_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "powerType", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "UnitQuestLogChanged", - Type = "Event", - LiteralName = "UNIT_QUEST_LOG_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitRangedAttackPower", - Type = "Event", - LiteralName = "UNIT_RANGED_ATTACK_POWER", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -949,7 +1387,16 @@ local Unit = LiteralName = "UNIT_RANGEDDAMAGE", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitRangedAttackPower", + Type = "Event", + LiteralName = "UNIT_RANGED_ATTACK_POWER", + Payload = + { + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -958,144 +1405,7 @@ local Unit = LiteralName = "UNIT_RESISTANCES", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitSpellHaste", - Type = "Event", - LiteralName = "UNIT_SPELL_HASTE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastChannelStart", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_CHANNEL_START", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastChannelStop", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_CHANNEL_STOP", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastChannelUpdate", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_CHANNEL_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastDelayed", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_DELAYED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastFailed", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_FAILED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastFailedQuiet", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_FAILED_QUIET", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastInterrupted", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_INTERRUPTED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastInterruptible", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_INTERRUPTIBLE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastNotInterruptible", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_NOT_INTERRUPTIBLE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastStart", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_START", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastStop", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_STOP", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, - }, - }, - { - Name = "UnitSpellcastSucceeded", - Type = "Event", - LiteralName = "UNIT_SPELLCAST_SUCCEEDED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "castGUID", Type = "WOWGUID", Nilable = false }, - { Name = "spellID", Type = "number", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -1104,7 +1414,7 @@ local Unit = LiteralName = "UNIT_STATS", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, { @@ -1113,105 +1423,19 @@ local Unit = LiteralName = "UNIT_TARGET", Payload = { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + { Name = "unitID", Type = "UnitToken", Nilable = false }, }, }, - { - Name = "UnitTargetableChanged", - Type = "Event", - LiteralName = "UNIT_TARGETABLE_CHANGED", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitThreatListUpdate", - Type = "Event", - LiteralName = "UNIT_THREAT_LIST_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UnitThreatSituationUpdate", - Type = "Event", - LiteralName = "UNIT_THREAT_SITUATION_UPDATE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, - }, - { - Name = "UpdateExhaustion", - Type = "Event", - LiteralName = "UPDATE_EXHAUSTION", - }, { Name = "UpdateMouseoverUnit", Type = "Event", LiteralName = "UPDATE_MOUSEOVER_UNIT", }, - { - Name = "UpdateStealth", - Type = "Event", - LiteralName = "UPDATE_STEALTH", - }, - { - Name = "VehicleAngleUpdate", - Type = "Event", - LiteralName = "VEHICLE_ANGLE_UPDATE", - Payload = - { - { Name = "normalizedPitch", Type = "number", Nilable = false }, - { Name = "radians", Type = "number", Nilable = false }, - }, - }, }, Tables = { - { - Name = "PowerType", - Type = "Enumeration", - NumValues = 29, - MinValue = -2, - MaxValue = 26, - Fields = - { - { Name = "HealthCost", Type = "PowerType", EnumValue = -2 }, - { Name = "None", Type = "PowerType", EnumValue = -1 }, - { 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 = "Happiness", 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 = "ComboPoints", Type = "PowerType", EnumValue = 14 }, - { Name = "Obsolete2", 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 = "NumPowerTypes", Type = "PowerType", EnumValue = 26 }, - }, - }, }, }; -APIDocumentation:AddDocumentationTable(Unit); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Unit); diff --git a/APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua b/APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua deleted file mode 100644 index b966433..0000000 --- a/APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua +++ /dev/null @@ -1,23 +0,0 @@ -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/APIDocumentation/Documentation/UnitSharedDocumentation.lua b/APIDocumentation/Documentation/UnitSharedDocumentation.lua deleted file mode 100644 index 594bf8f..0000000 --- a/APIDocumentation/Documentation/UnitSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local UnitShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(UnitShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UserFeedbackDocumentation.lua b/APIDocumentation/Documentation/UserFeedbackDocumentation.lua deleted file mode 100644 index 15951b2..0000000 --- a/APIDocumentation/Documentation/UserFeedbackDocumentation.lua +++ /dev/null @@ -1,49 +0,0 @@ -local UserFeedback = -{ - Name = "UserFeedback", - Type = "System", - Namespace = "C_UserFeedback", - - Functions = - { - { - Name = "SubmitBug", - Type = "Function", - - 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", - - 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/APIDocumentation/Documentation/UtilityDocumentation.lua b/APIDocumentation/Documentation/UtilityDocumentation.lua new file mode 100644 index 0000000..1120fd3 --- /dev/null +++ b/APIDocumentation/Documentation/UtilityDocumentation.lua @@ -0,0 +1,459 @@ +local Utility = +{ + Name = "Utility", + Type = "System", + Namespace = "Utility", + + Functions = + { + { + Name = "CreateFont", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "fontObject", Type = "table", Nilable = false }, + }, + }, + { + Name = "CreateFrame", + Type = "Function", + + Arguments = + { + { Name = "frameType", Type = "string", Nilable = false }, + { Name = "name", Type = "string", Nilable = false }, + { Name = "parent", Type = "table", Nilable = false }, + { Name = "template", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "EnumerateFrames", + Type = "Function", + + Arguments = + { + { Name = "currentFrame", Type = "frame", Nilable = true }, + }, + + Returns = + { + { Name = "nextFrame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "GetAutoCompleteResults", + Type = "Function", + + Arguments = + { + { Name = "inputString", Type = "string", Nilable = false }, + { Name = "includeBitfield", Type = "number", Nilable = false }, + { Name = "excludeBitfield", Type = "number", Nilable = false }, + { Name = "maxResults", Type = "number", Nilable = false }, + { Name = "cursorPosition", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetClickFrame", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "GetCurrentKeyBoardFocus", + Type = "Function", + + Returns = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "GetFramesRegisteredForEvent", + Type = "Function", + + Arguments = + { + { Name = "event", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetMirrorTimerInfo", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "timer", Type = "string", 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 = "label", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMirrorTimerProgress", + Type = "Function", + + Arguments = + { + { Name = "timer", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "progress", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMouseButtonClicked", + Type = "Function", + + Returns = + { + { Name = "button", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMouseButtonName", + Type = "Function", + + Arguments = + { + { Name = "buttonNumber", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "buttonName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMouseFocus", + Type = "Function", + + Returns = + { + { Name = "frame", Type = "frame", Nilable = false }, + }, + }, + { + Name = "GetMuteName", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetNumFrames", + Type = "Function", + + Returns = + { + { Name = "numFrames", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetText", + Type = "Function", + + Arguments = + { + { Name = "eventType", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "icon", Type = "string", Nilable = false }, + { Name = "expansion", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTime", + Type = "Function", + + Returns = + { + { Name = "time", Type = "time_t", Nilable = false }, + }, + }, + { + Name = "IsLoggedIn", + Type = "Function", + + Returns = + { + { Name = "loggedIn", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMouseButtonDown", + Type = "Function", + + Arguments = + { + { Name = "button", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "isDown", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RegisterForSave", + Type = "Function", + + }, + { + Name = "RegisterForSavePerCharacter", + Type = "Function", + + }, + { + Name = "RequestTimePlayed", + Type = "Function", + + }, + { + Name = "RunScript", + Type = "Function", + + Arguments = + { + { Name = "script", Type = "string", Nilable = false }, + }, + + }, + { + Name = "SecondsToTime", + Type = "Function", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + { Name = "noSeconds", Type = "bool", Nilable = false }, + { Name = "notAbbreviated", Type = "bool", Nilable = false }, + { Name = "maxCount", Type = "number", Nilable = true }, + }, + + Returns = + { + { Name = "time", Type = "string", Nilable = false }, + }, + }, + { + Name = "SetPortraitToTexture", + Type = "Function", + + Arguments = + { + { Name = "frameName", Type = "string", Nilable = false }, + { Name = "texturePath", Type = "string", Nilable = false }, + }, + + }, + { + Name = "debuglocals", + Type = "Function", + + Arguments = + { + { Name = "stackLevel", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "localsInfo", Type = "string", Nilable = false }, + }, + }, + { + Name = "getglobal", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "value", Type = "string", Nilable = false }, + }, + }, + { + Name = "scrub", + Type = "Function", + + Arguments = + { + { Name = "...", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "setglobal", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "value", Type = "string", Nilable = false }, + }, + + }, + { + Name = "strconcat", + Type = "Function", + + Arguments = + { + { Name = "...", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "result", Type = "string", Nilable = false }, + }, + }, + { + Name = "strjoin", + Type = "Function", + + Arguments = + { + { Name = "sep", Type = "string", Nilable = false }, + { Name = "...", Type = "table", Nilable = false }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "strlenutf8", + Type = "Function", + + Arguments = + { + { Name = "string", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "length", Type = "number", Nilable = false }, + }, + }, + { + Name = "strreplace", + Type = "Function", + + Arguments = + { + { Name = "text", Type = "string", Nilable = false }, + { Name = "pattern", Type = "string", Nilable = false }, + { Name = "replacement", Type = "string", Nilable = false }, + { Name = "count", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "newText", Type = "string", Nilable = false }, + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "strsplit", + Type = "Function", + + Arguments = + { + { Name = "sep", Type = "string", Nilable = false }, + { Name = "text", Type = "string", Nilable = false }, + { Name = "limit", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "strtrim", + Type = "Function", + + Arguments = + { + { Name = "str", Type = "string", Nilable = false }, + { Name = "trimChars", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "text", Type = "string", Nilable = false }, + }, + }, + { + Name = "wipe", + Type = "Function", + + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Utility); diff --git a/APIDocumentation/Documentation/ValidateNameConstantsDocumentation.lua b/APIDocumentation/Documentation/ValidateNameConstantsDocumentation.lua deleted file mode 100644 index 1ac31fe..0000000 --- a/APIDocumentation/Documentation/ValidateNameConstantsDocumentation.lua +++ /dev/null @@ -1,50 +0,0 @@ -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/APIDocumentation/Documentation/VectorSharedDocumentation.lua b/APIDocumentation/Documentation/VectorSharedDocumentation.lua deleted file mode 100644 index 3376142..0000000 --- a/APIDocumentation/Documentation/VectorSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local VectorShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(VectorShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VehicleConstantsDocumentation.lua b/APIDocumentation/Documentation/VehicleConstantsDocumentation.lua deleted file mode 100644 index a27360c..0000000 --- a/APIDocumentation/Documentation/VehicleConstantsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local VehicleConstants = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(VehicleConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VehicleDocumentation.lua b/APIDocumentation/Documentation/VehicleDocumentation.lua index 0d7d7d2..43c354e 100644 --- a/APIDocumentation/Documentation/VehicleDocumentation.lua +++ b/APIDocumentation/Documentation/VehicleDocumentation.lua @@ -2,10 +2,358 @@ local Vehicle = { Name = "Vehicle", Type = "System", - Namespace = "C_Vehicle", + Namespace = "Vehicle", Functions = { + { + Name = "CanEjectPassengerFromSeat", + Type = "Function", + + Arguments = + { + { Name = "seat", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canEject", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanExitVehicle", + Type = "Function", + + Returns = + { + { Name = "canExit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSwitchVehicleSeat", + Type = "Function", + + Returns = + { + { Name = "canSwitch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSwitchVehicleSeats", + Type = "Function", + + Returns = + { + { Name = "canSwitch", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CombatTextSetActiveUnit", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + }, + { + Name = "EjectPassengerFromSeat", + Type = "Function", + + Arguments = + { + { Name = "seat", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "canEject", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsUsingVehicleControls", + Type = "Function", + + }, + { + Name = "IsVehicleAimAngleAdjustable", + Type = "Function", + + Returns = + { + { Name = "hasAngleControl", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVehicleAimPowerAdjustable", + Type = "Function", + + }, + { + Name = "UnitControllingVehicle", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "isControlling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitHasVehicleUI", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "hasVehicle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInVehicle", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "inVehicle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitInVehicleControlSeat", + Type = "Function", + + Returns = + { + { Name = "isInControl", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsControlling", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isControlling", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitSwitchToVehicleSeat", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "seat", Type = "number", Nilable = false }, + }, + + }, + { + Name = "UnitTargetsVehicleInRaidUI", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "targetVehicle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitUsingVehicle", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "usingVehicle", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitVehicleSeatCount", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "numSeats", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitVehicleSeatInfo", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + { Name = "seat", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "controlType", Type = "string", Nilable = false }, + { Name = "occupantName", Type = "string", Nilable = false }, + { Name = "occupantRealm", Type = "string", Nilable = false }, + { Name = "canEject", Type = "bool", Nilable = false }, + { Name = "canSwitchSeats", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitVehicleSkin", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "skin", Type = "string", Nilable = false }, + }, + }, + { + Name = "VehicleAimDecrement", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "VehicleAimDownStart", + Type = "Function", + + }, + { + Name = "VehicleAimDownStop", + Type = "Function", + + }, + { + Name = "VehicleAimGetAngle", + Type = "Function", + + Returns = + { + { Name = "angle", Type = "number", Nilable = false }, + }, + }, + { + Name = "VehicleAimGetNormAngle", + Type = "Function", + + }, + { + Name = "VehicleAimGetNormPower", + Type = "Function", + + }, + { + Name = "VehicleAimIncrement", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "VehicleAimRequestAngle", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "VehicleAimRequestNormAngle", + Type = "Function", + + Arguments = + { + { Name = "amount", Type = "number", Nilable = false }, + }, + + }, + { + Name = "VehicleAimSetNormPower", + Type = "Function", + + }, + { + Name = "VehicleAimUpStart", + Type = "Function", + + }, + { + Name = "VehicleAimUpStop", + Type = "Function", + + }, + { + Name = "VehicleCameraZoomIn", + Type = "Function", + + }, + { + Name = "VehicleCameraZoomOut", + Type = "Function", + + }, + { + Name = "VehicleExit", + Type = "Function", + + }, + { + Name = "VehicleNextSeat", + Type = "Function", + + }, + { + Name = "VehiclePrevSeat", + Type = "Function", + + }, }, Events = @@ -14,77 +362,36 @@ local Vehicle = Name = "PlayerGainsVehicleData", Type = "Event", LiteralName = "PLAYER_GAINS_VEHICLE_DATA", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - { Name = "vehicleUIIndicatorID", Type = "number", Nilable = false }, - }, }, { Name = "PlayerLosesVehicleData", Type = "Event", LiteralName = "PLAYER_LOSES_VEHICLE_DATA", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, }, { Name = "UnitEnteredVehicle", Type = "Event", LiteralName = "UNIT_ENTERED_VEHICLE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", 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", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", 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", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, }, { Name = "UnitExitingVehicle", Type = "Event", LiteralName = "UNIT_EXITING_VEHICLE", - Payload = - { - { Name = "unitTarget", Type = "UnitToken", Nilable = false }, - }, }, { Name = "VehicleAngleShow", Type = "Event", LiteralName = "VEHICLE_ANGLE_SHOW", - Payload = - { - { Name = "shouldShow", Type = "number", Nilable = true }, - }, + }, + { + Name = "VehicleAngleUpdate", + Type = "Event", + LiteralName = "VEHICLE_ANGLE_UPDATE", }, { Name = "VehiclePassengersChanged", @@ -95,10 +402,6 @@ local Vehicle = Name = "VehiclePowerShow", Type = "Event", LiteralName = "VEHICLE_POWER_SHOW", - Payload = - { - { Name = "shouldShow", Type = "number", Nilable = true }, - }, }, { Name = "VehicleUpdate", @@ -112,4 +415,4 @@ local Vehicle = }, }; -APIDocumentation:AddDocumentationTable(Vehicle); \ No newline at end of file +APIDocumentation:AddDocumentationTable(Vehicle); diff --git a/APIDocumentation/Documentation/VideoDocumentation.lua b/APIDocumentation/Documentation/VideoDocumentation.lua index 5855530..f64a2c0 100644 --- a/APIDocumentation/Documentation/VideoDocumentation.lua +++ b/APIDocumentation/Documentation/VideoDocumentation.lua @@ -2,173 +2,218 @@ local Video = { Name = "Video", Type = "System", - Namespace = "C_VideoOptions", + Namespace = "Video", Functions = { { - Name = "GetCurrentGameWindowSize", + Name = "GetCurrentMultisampleFormat", Type = "Function", Returns = { - { Name = "size", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, }, { - Name = "GetDefaultGameWindowSize", + Name = "GetCurrentResolution", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetFarclip", + Type = "Function", + + Returns = + { + { Name = "distance", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetFramerate", + Type = "Function", + + Returns = + { + { Name = "framerate", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGamma", + Type = "Function", + + Returns = + { + { Name = "gamma", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMultisampleFormats", + Type = "Function", + + Returns = + { + { Name = "color", Type = "number", Nilable = false }, + { Name = "depth", Type = "number", Nilable = false }, + { Name = "multisample", Type = "number", Nilable = false }, + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetRefreshRates", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetScreenHeight", + Type = "Function", + + Returns = + { + { Name = "height", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetScreenResolutions", + Type = "Function", + + Returns = + { + { Name = "...", Type = "list", Nilable = false }, + }, + }, + { + Name = "GetScreenWidth", + Type = "Function", + + Returns = + { + { Name = "screenWidth", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetTerrainMip", + Type = "Function", + + Returns = + { + { Name = "terrainDetail", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVideoCaps", + Type = "Function", + + Returns = + { + { Name = "hasAnisotropic", Type = "number", Nilable = false }, + { Name = "hasPixelShaders", Type = "number", Nilable = false }, + { Name = "hasVertexShaders", Type = "number", Nilable = false }, + { Name = "hasTrilinear", Type = "number", Nilable = false }, + { Name = "hasTripleBufering", Type = "number", Nilable = false }, + { Name = "maxAnisotropy", Type = "number", Nilable = false }, + { Name = "hasHardwareCursor", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsDesaturateSupported", + Type = "Function", + + Returns = + { + { Name = "isSupported", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsPlayerResolutionAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsStereoVideoAvailable", + Type = "Function", + + Returns = + { + { Name = "isAvailable", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RestartGx", + Type = "Function", + + }, + { + Name = "RestoreVideoStereoDefaults", + Type = "Function", + + }, + { + Name = "SetGamma", Type = "Function", Arguments = { - { Name = "monitor", Type = "number", Nilable = false }, + { Name = "value", Type = "number", Nilable = false }, }, - Returns = - { - { Name = "size", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, - }, }, { - Name = "GetGameWindowSizes", + Name = "SetMultisampleFormat", Type = "Function", Arguments = { - { Name = "monitor", Type = "number", Nilable = false }, - { Name = "fullscreen", Type = "bool", Nilable = false }, + { Name = "index", Type = "luaIndex", 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 = "SetGameWindowSize", + Name = "SetScreenResolution", Type = "Function", Arguments = { - { Name = "x", Type = "number", Nilable = false }, - { Name = "y", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, }, + + }, + { + Name = "SetTexLodBias", + Type = "Function", + + }, + { + Name = "SetWaterDetail", + Type = "Function", + + Arguments = + { + { Name = "value", Type = "number", Nilable = false }, + }, + }, }, Events = { - { - Name = "AdapterListChanged", - Type = "Event", - LiteralName = "ADAPTER_LIST_CHANGED", - }, - { - Name = "DisplaySizeChanged", - Type = "Event", - LiteralName = "DISPLAY_SIZE_CHANGED", - }, - { - Name = "GlueScreenshotFailed", - Type = "Event", - LiteralName = "GLUE_SCREENSHOT_FAILED", - }, - { - Name = "GxRestarted", - Type = "Event", - LiteralName = "GX_RESTARTED", - }, - { - Name = "ScreenshotFailed", - Type = "Event", - LiteralName = "SCREENSHOT_FAILED", - }, - { - Name = "ScreenshotStarted", - Type = "Event", - LiteralName = "SCREENSHOT_STARTED", - }, - { - Name = "ScreenshotSucceeded", - Type = "Event", - LiteralName = "SCREENSHOT_SUCCEEDED", - }, }, Tables = { - { - Name = "GraphicsValidationResult", - Type = "Enumeration", - NumValues = 42, - MinValue = 0, - MaxValue = 41, - 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 = "Unknown", Type = "GraphicsValidationResult", EnumValue = 41 }, - }, - }, - { - 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 +APIDocumentation:AddDocumentationTable(Video); diff --git a/APIDocumentation/Documentation/VignetteConstantsDocumentation.lua b/APIDocumentation/Documentation/VignetteConstantsDocumentation.lua deleted file mode 100644 index bbfcd19..0000000 --- a/APIDocumentation/Documentation/VignetteConstantsDocumentation.lua +++ /dev/null @@ -1,23 +0,0 @@ -local VignetteConstants = -{ - Tables = - { - { - 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/APIDocumentation/Documentation/VignetteInfoDocumentation.lua b/APIDocumentation/Documentation/VignetteInfoDocumentation.lua deleted file mode 100644 index da0978d..0000000 --- a/APIDocumentation/Documentation/VignetteInfoDocumentation.lua +++ /dev/null @@ -1,40 +0,0 @@ -local VignetteInfo = -{ - Name = "Vignette", - Type = "System", - Namespace = "C_VignetteInfo", - - Functions = - { - }, - - Events = - { - }, - - 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 = "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 }, - }, - }, - }, -}; - -APIDocumentation:AddDocumentationTable(VignetteInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VoiceChatDocumentation.lua b/APIDocumentation/Documentation/VoiceChatDocumentation.lua deleted file mode 100644 index c914e11..0000000 --- a/APIDocumentation/Documentation/VoiceChatDocumentation.lua +++ /dev/null @@ -1,1344 +0,0 @@ -local VoiceChat = -{ - Name = "VoiceChat", - Type = "System", - Namespace = "C_VoiceChat", - - Functions = - { - { - Name = "ActivateChannel", - Type = "Function", - - Arguments = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "ActivateChannelTranscription", - Type = "Function", - - Arguments = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "BeginLocalCapture", - Type = "Function", - - Arguments = - { - { Name = "listenToLocalUser", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CanPlayerUseVoiceChat", - Type = "Function", - - Returns = - { - { Name = "canUseVoiceChat", Type = "bool", Nilable = false }, - }, - }, - { - Name = "CreateChannel", - Type = "Function", - - Arguments = - { - { Name = "channelDisplayName", Type = "cstring", Nilable = false }, - }, - - Returns = - { - { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, - }, - }, - { - Name = "DeactivateChannel", - Type = "Function", - - Arguments = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "DeactivateChannelTranscription", - Type = "Function", - - 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", - - Arguments = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "channel", Type = "VoiceChatChannel", Nilable = true }, - }, - }, - { - Name = "GetChannelForChannelType", - Type = "Function", - - Arguments = - { - { Name = "channelType", Type = "ChatChannelType", Nilable = false }, - }, - - Returns = - { - { Name = "channel", Type = "VoiceChatChannel", Nilable = true }, - }, - }, - { - Name = "GetChannelForCommunityStream", - Type = "Function", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - - Returns = - { - { Name = "channel", Type = "VoiceChatChannel", Nilable = true }, - }, - }, - { - 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 = "GetLocalPlayerActiveChannelMemberInfo", - Type = "Function", - - Returns = - { - { Name = "memberInfo", Type = "VoiceChatMember", Nilable = true }, - }, - }, - { - Name = "GetLocalPlayerMemberID", - Type = "Function", - - 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", - - Arguments = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "memberGUID", Type = "WOWGUID", Nilable = false }, - }, - }, - { - Name = "GetMemberID", - Type = "Function", - - Arguments = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "memberGUID", Type = "WOWGUID", Nilable = false }, - }, - - Returns = - { - { Name = "memberID", Type = "number", Nilable = true }, - }, - }, - { - Name = "GetMemberInfo", - Type = "Function", - - Arguments = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "memberInfo", Type = "VoiceChatMember", Nilable = true }, - }, - }, - { - Name = "GetMemberName", - Type = "Function", - - Arguments = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "memberName", Type = "string", Nilable = true }, - }, - }, - { - Name = "GetMemberVolume", - Type = "Function", - - 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", - - 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", - - 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", - - Arguments = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "isLocalPlayer", Type = "bool", Nilable = false }, - }, - }, - { - Name = "IsMemberMuted", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - }, - - Returns = - { - { Name = "mutedForMe", Type = "bool", Nilable = true }, - }, - }, - { - Name = "IsMemberMutedForAll", - Type = "Function", - - Arguments = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - - Returns = - { - { Name = "mutedForAll", Type = "bool", Nilable = true }, - }, - }, - { - Name = "IsMemberSilenced", - Type = "Function", - - 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", - - 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 = "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", - - 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", - - Arguments = - { - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - }, - }, - { - Name = "RequestJoinChannelByChannelType", - Type = "Function", - - Arguments = - { - { Name = "channelType", Type = "ChatChannelType", Nilable = false }, - { Name = "autoActivate", Type = "bool", Nilable = true }, - }, - }, - { - Name = "SetCommunicationMode", - Type = "Function", - - Arguments = - { - { Name = "communicationMode", Type = "CommunicationMode", Nilable = false }, - }, - }, - { - Name = "SetDeafened", - Type = "Function", - - Arguments = - { - { Name = "isDeafened", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetInputDevice", - Type = "Function", - - Arguments = - { - { Name = "deviceID", Type = "string", Nilable = false }, - }, - }, - { - Name = "SetInputVolume", - Type = "Function", - - Arguments = - { - { Name = "volume", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMasterVolumeScale", - Type = "Function", - - Arguments = - { - { Name = "scale", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetMemberMuted", - Type = "Function", - - Arguments = - { - { Name = "playerLocation", Type = "PlayerLocation", Mixin = "PlayerLocationMixin", Nilable = false }, - { Name = "muted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetMemberVolume", - Type = "Function", - 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", - - Arguments = - { - { Name = "isMuted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "SetOutputDevice", - Type = "Function", - - Arguments = - { - { Name = "deviceID", Type = "string", Nilable = false }, - }, - }, - { - Name = "SetOutputVolume", - Type = "Function", - - Arguments = - { - { Name = "volume", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetPortraitTexture", - Type = "Function", - - Arguments = - { - { Name = "textureObject", Type = "SimpleTexture", Nilable = false }, - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "SetPushToTalkBinding", - Type = "Function", - - Arguments = - { - { Name = "keys", Type = "table", InnerType = "string", Nilable = false }, - }, - }, - { - Name = "SetVADSensitivity", - Type = "Function", - - 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", - - Arguments = - { - { Name = "text", Type = "string", Nilable = false }, - }, - }, - { - Name = "SpeakText", - Type = "Function", - - Arguments = - { - { Name = "voiceID", Type = "number", Nilable = false }, - { Name = "text", Type = "cstring", Nilable = false }, - { Name = "destination", Type = "VoiceTtsDestination", Nilable = false }, - { Name = "rate", Type = "number", Nilable = false }, - { Name = "volume", Type = "number", Nilable = false }, - }, - }, - { - Name = "StopSpeakingText", - Type = "Function", - }, - { - Name = "ToggleDeafened", - Type = "Function", - }, - { - Name = "ToggleMemberMuted", - Type = "Function", - - 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", - }, - { - Name = "VoiceChatActiveOutputDeviceUpdated", - Type = "Event", - LiteralName = "VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED", - }, - { - Name = "VoiceChatAudioCaptureEnergy", - Type = "Event", - LiteralName = "VOICE_CHAT_AUDIO_CAPTURE_ENERGY", - Payload = - { - { Name = "isSpeaking", Type = "bool", Nilable = false }, - { Name = "energy", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatAudioCaptureStarted", - Type = "Event", - LiteralName = "VOICE_CHAT_AUDIO_CAPTURE_STARTED", - }, - { - Name = "VoiceChatAudioCaptureStopped", - Type = "Event", - LiteralName = "VOICE_CHAT_AUDIO_CAPTURE_STOPPED", - }, - { - Name = "VoiceChatChannelActivated", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_ACTIVATED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelDeactivated", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_DEACTIVATED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelDisplayNameChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "channelDisplayName", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelJoined", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_JOINED", - 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", - 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", - Payload = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelMemberEnergyChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED", - 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", - 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", - 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", - 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", - Payload = - { - { Name = "memberID", Type = "number", Nilable = false }, - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelMemberSilencedChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED", - 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", - 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", - 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", - 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", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "isMuted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelPttChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_PTT_CHANGED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "pushToTalkSetting", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelRemoved", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_REMOVED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelTranscribingChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "isTranscribing", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelTransmitChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "isTransmitting", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatChannelVolumeChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_CHANNEL_VOLUME_CHANGED", - Payload = - { - { Name = "channelID", Type = "number", Nilable = false }, - { Name = "volume", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatCommunicationModeChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_COMMUNICATION_MODE_CHANGED", - Payload = - { - { Name = "communicationMode", Type = "CommunicationMode", Nilable = false }, - }, - }, - { - Name = "VoiceChatConnectionSuccess", - Type = "Event", - LiteralName = "VOICE_CHAT_CONNECTION_SUCCESS", - }, - { - Name = "VoiceChatDeafenedChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_DEAFENED_CHANGED", - Payload = - { - { Name = "isDeafened", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatError", - Type = "Event", - LiteralName = "VOICE_CHAT_ERROR", - Payload = - { - { Name = "platformCode", Type = "number", Nilable = false }, - { Name = "statusCode", Type = "VoiceChatStatusCode", Nilable = false }, - }, - }, - { - Name = "VoiceChatInputDevicesUpdated", - Type = "Event", - LiteralName = "VOICE_CHAT_INPUT_DEVICES_UPDATED", - }, - { - Name = "VoiceChatLogin", - Type = "Event", - LiteralName = "VOICE_CHAT_LOGIN", - Payload = - { - { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, - }, - }, - { - Name = "VoiceChatLogout", - Type = "Event", - LiteralName = "VOICE_CHAT_LOGOUT", - Payload = - { - { Name = "status", Type = "VoiceChatStatusCode", Nilable = false }, - }, - }, - { - Name = "VoiceChatMutedChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_MUTED_CHANGED", - Payload = - { - { Name = "isMuted", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatOutputDevicesUpdated", - Type = "Event", - LiteralName = "VOICE_CHAT_OUTPUT_DEVICES_UPDATED", - }, - { - Name = "VoiceChatPendingChannelJoinState", - Type = "Event", - LiteralName = "VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE", - 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", - Payload = - { - { Name = "isPressed", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatSilencedChanged", - Type = "Event", - LiteralName = "VOICE_CHAT_SILENCED_CHANGED", - Payload = - { - { Name = "isSilenced", Type = "bool", Nilable = false }, - }, - }, - { - Name = "VoiceChatSpeakForMeActiveStatusUpdated", - Type = "Event", - LiteralName = "VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED", - }, - { - Name = "VoiceChatSpeakForMeFeatureStatusUpdated", - Type = "Event", - LiteralName = "VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED", - }, - { - Name = "VoiceChatTtsPlaybackFailed", - Type = "Event", - LiteralName = "VOICE_CHAT_TTS_PLAYBACK_FAILED", - Payload = - { - { Name = "status", Type = "VoiceTtsStatusCode", Nilable = false }, - { Name = "utteranceID", Type = "number", Nilable = false }, - { Name = "destination", Type = "VoiceTtsDestination", Nilable = false }, - }, - }, - { - Name = "VoiceChatTtsPlaybackFinished", - Type = "Event", - LiteralName = "VOICE_CHAT_TTS_PLAYBACK_FINISHED", - Payload = - { - { Name = "numConsumers", Type = "number", Nilable = false }, - { Name = "utteranceID", Type = "number", Nilable = false }, - { Name = "destination", Type = "VoiceTtsDestination", Nilable = false }, - }, - }, - { - Name = "VoiceChatTtsPlaybackStarted", - Type = "Event", - LiteralName = "VOICE_CHAT_TTS_PLAYBACK_STARTED", - Payload = - { - { Name = "numConsumers", Type = "number", Nilable = false }, - { Name = "utteranceID", Type = "number", Nilable = false }, - { Name = "durationMS", Type = "number", Nilable = false }, - { Name = "destination", Type = "VoiceTtsDestination", Nilable = false }, - }, - }, - { - Name = "VoiceChatTtsSpeakTextUpdate", - Type = "Event", - LiteralName = "VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE", - Payload = - { - { Name = "status", Type = "VoiceTtsStatusCode", Nilable = false }, - { Name = "utteranceID", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoiceChatTtsVoicesUpdate", - Type = "Event", - LiteralName = "VOICE_CHAT_TTS_VOICES_UPDATE", - }, - { - Name = "VoiceChatVadSettingsUpdated", - Type = "Event", - LiteralName = "VOICE_CHAT_VAD_SETTINGS_UPDATED", - }, - }, - - 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 = "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 = "VoiceTtsDestination", - Type = "Enumeration", - NumValues = 7, - MinValue = 0, - MaxValue = 6, - Fields = - { - { Name = "RemoteTransmission", Type = "VoiceTtsDestination", EnumValue = 0 }, - { Name = "LocalPlayback", Type = "VoiceTtsDestination", EnumValue = 1 }, - { Name = "RemoteTransmissionWithLocalPlayback", Type = "VoiceTtsDestination", EnumValue = 2 }, - { Name = "QueuedRemoteTransmission", Type = "VoiceTtsDestination", EnumValue = 3 }, - { Name = "QueuedLocalPlayback", Type = "VoiceTtsDestination", EnumValue = 4 }, - { Name = "QueuedRemoteTransmissionWithLocalPlayback", Type = "VoiceTtsDestination", EnumValue = 5 }, - { Name = "ScreenReader", Type = "VoiceTtsDestination", EnumValue = 6 }, - }, - }, - { - 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 }, - { Name = "channelType", Type = "ChatChannelType", Nilable = false }, - { Name = "clubId", Type = "ClubId", Nilable = false }, - { Name = "streamId", Type = "ClubStreamId", Nilable = false }, - { Name = "volume", Type = "number", Nilable = false }, - { Name = "isActive", Type = "bool", Nilable = false }, - { Name = "isMuted", Type = "bool", Nilable = false }, - { Name = "isTransmitting", Type = "bool", Nilable = false }, - { Name = "isTranscribing", Type = "bool", Nilable = false }, - { 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/APIDocumentation/Documentation/VoiceDocumentation.lua b/APIDocumentation/Documentation/VoiceDocumentation.lua new file mode 100644 index 0000000..1174f24 --- /dev/null +++ b/APIDocumentation/Documentation/VoiceDocumentation.lua @@ -0,0 +1,647 @@ +local Voice = +{ + Name = "Voice", + Type = "System", + Namespace = "Voice", + + Functions = + { + { + Name = "AddMute", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + }, + + }, + { + Name = "AddOrDelMute", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelSilenceAll", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelSilenceVoice", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelUnSilenceAll", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelUnSilenceVoice", + Type = "Function", + + Arguments = + { + { Name = "channelName", Type = "string", Nilable = true }, + { Name = "channelId", Type = "number", Nilable = true }, + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "ChannelVoiceOff", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = true }, + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "ChannelVoiceOn", + Type = "Function", + + Arguments = + { + { Name = "channel", Type = "string", Nilable = true }, + { Name = "channelIndex", Type = "luaIndex", Nilable = true }, + }, + + }, + { + Name = "DelMute", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + }, + { + Name = "DisplayChannelVoiceOff", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "DisplayChannelVoiceOn", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "GetActiveVoiceChannel", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetMuteName", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetMuteStatus", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "channel", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "muteStatus", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetNumMutes", + Type = "Function", + + Returns = + { + { Name = "numMuted", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumVoiceSessionMembersBySessionID", + Type = "Function", + + Arguments = + { + { Name = "sessionId", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "numMembers", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetNumVoiceSessions", + Type = "Function", + + Returns = + { + { Name = "count", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetSelectedMute", + Type = "Function", + + Returns = + { + { Name = "selectedMute", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVoiceCurrentSessionID", + Type = "Function", + + Returns = + { + { Name = "id", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetVoiceSessionInfo", + Type = "Function", + + Arguments = + { + { Name = "session", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "active", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetVoiceSessionMemberInfoBySessionID", + Type = "Function", + + Arguments = + { + { Name = "session", Type = "number", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "voiceActive", Type = "bool", Nilable = false }, + { Name = "sessionActive", Type = "bool", Nilable = false }, + { Name = "muted", Type = "bool", Nilable = false }, + { Name = "squelched", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetVoiceStatus", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + { Name = "channel", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "status", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsIgnoredOrMuted", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isIgnoredOrMuted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsMuted", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = true }, + { Name = "name", Type = "string", Nilable = true }, + }, + + Returns = + { + { Name = "muted", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSilenced", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "isSilenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVoiceChatAllowed", + Type = "Function", + + Returns = + { + { Name = "isAllowed", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsVoiceChatAllowedByServer", + Type = "Function", + + }, + { + Name = "IsVoiceChatEnabled", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetActiveVoiceChannel", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SetActiveVoiceChannelBySessionID", + Type = "Function", + + Arguments = + { + { Name = "session", Type = "number", Nilable = false }, + }, + + }, + { + Name = "SetSelectedMute", + Type = "Function", + + Arguments = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + }, + { + Name = "SilenceMember", + Type = "Function", + + }, + { + Name = "UnSilenceMember", + Type = "Function", + + }, + { + Name = "UnitIsSilenced", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "channel", Type = "string", Nilable = false }, + }, + + Returns = + { + { Name = "silenced", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitIsTalking", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "state", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoiceChat_ActivatePrimaryCaptureCallback", + Type = "Function", + + }, + { + Name = "VoiceChat_GetCurrentMicrophoneSignalLevel", + Type = "Function", + + Returns = + { + { Name = "volume", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChat_IsPlayingLoopbackSound", + Type = "Function", + + Arguments = + { + { Name = "isPlaying", Type = "number", Nilable = false }, + }, + + }, + { + Name = "VoiceChat_IsRecordingLoopbackSound", + Type = "Function", + + Returns = + { + { Name = "isRecording", Type = "number", Nilable = false }, + }, + }, + { + Name = "VoiceChat_PlayLoopbackSound", + Type = "Function", + + }, + { + Name = "VoiceChat_RecordLoopbackSound", + Type = "Function", + + Arguments = + { + { Name = "seconds", Type = "number", Nilable = false }, + }, + + }, + { + Name = "VoiceChat_StartCapture", + Type = "Function", + + }, + { + Name = "VoiceChat_StopCapture", + Type = "Function", + + }, + { + Name = "VoiceChat_StopPlayingLoopbackSound", + Type = "Function", + + }, + { + Name = "VoiceChat_StopRecordingLoopbackSound", + Type = "Function", + + }, + { + Name = "VoiceEnumerateCaptureDevices", + Type = "Function", + + Arguments = + { + { Name = "deviceIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "deviceName", Type = "string", Nilable = false }, + }, + }, + { + Name = "VoiceEnumerateOutputDevices", + Type = "Function", + + Arguments = + { + { Name = "deviceIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "device", Type = "string", Nilable = false }, + }, + }, + { + Name = "VoiceGetCurrentCaptureDevice", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "VoiceGetCurrentOutputDevice", + Type = "Function", + + Returns = + { + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "VoiceIsDisabledByClient", + Type = "Function", + + Returns = + { + { Name = "isDisabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "VoicePushToTalkStart", + Type = "Function", + + }, + { + Name = "VoicePushToTalkStop", + Type = "Function", + + }, + { + Name = "VoiceSelectCaptureDevice", + Type = "Function", + + Arguments = + { + { Name = "deviceName", Type = "string", Nilable = false }, + }, + + }, + { + Name = "VoiceSelectOutputDevice", + Type = "Function", + + Arguments = + { + { Name = "deviceName", Type = "string", Nilable = false }, + }, + + }, + }, + + Events = + { + { + Name = "VoiceChatEnabledUpdate", + Type = "Event", + LiteralName = "VOICE_CHAT_ENABLED_UPDATE", + }, + { + Name = "VoiceLeftSession", + Type = "Event", + LiteralName = "VOICE_LEFT_SESSION", + }, + { + Name = "VoicePlateStart", + Type = "Event", + LiteralName = "VOICE_PLATE_START", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "VoicePlateStop", + Type = "Event", + LiteralName = "VOICE_PLATE_STOP", + Payload = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "VoicePushToTalkStart", + Type = "Event", + LiteralName = "VOICE_PUSH_TO_TALK_START", + }, + { + Name = "VoicePushToTalkStop", + Type = "Event", + LiteralName = "VOICE_PUSH_TO_TALK_STOP", + }, + { + Name = "VoiceSelfMute", + Type = "Event", + LiteralName = "VOICE_SELF_MUTE", + }, + { + Name = "VoiceSessionsUpdate", + Type = "Event", + LiteralName = "VOICE_SESSIONS_UPDATE", + }, + { + Name = "VoiceStart", + Type = "Event", + LiteralName = "VOICE_START", + Payload = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "VoiceStatusUpdate", + Type = "Event", + LiteralName = "VOICE_STATUS_UPDATE", + }, + { + Name = "VoiceStop", + Type = "Event", + LiteralName = "VOICE_STOP", + Payload = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Voice); diff --git a/APIDocumentation/Documentation/VoidStorageInfoDocumentation.lua b/APIDocumentation/Documentation/VoidStorageInfoDocumentation.lua deleted file mode 100644 index 6b05e5c..0000000 --- a/APIDocumentation/Documentation/VoidStorageInfoDocumentation.lua +++ /dev/null @@ -1,59 +0,0 @@ -local VoidStorageInfo = -{ - Name = "VoidStorageInfo", - Type = "System", - Namespace = "C_VoidStorageInfo", - - Functions = - { - }, - - Events = - { - { - Name = "VoidDepositWarning", - Type = "Event", - LiteralName = "VOID_DEPOSIT_WARNING", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - { Name = "link", Type = "cstring", Nilable = false }, - }, - }, - { - Name = "VoidStorageContentsUpdate", - Type = "Event", - LiteralName = "VOID_STORAGE_CONTENTS_UPDATE", - }, - { - Name = "VoidStorageDepositUpdate", - Type = "Event", - LiteralName = "VOID_STORAGE_DEPOSIT_UPDATE", - Payload = - { - { Name = "slot", Type = "number", Nilable = false }, - }, - }, - { - Name = "VoidStorageUpdate", - Type = "Event", - LiteralName = "VOID_STORAGE_UPDATE", - }, - { - Name = "VoidTransferDone", - Type = "Event", - LiteralName = "VOID_TRANSFER_DONE", - }, - { - Name = "VoidTransferSuccess", - Type = "Event", - LiteralName = "VOID_TRANSFER_SUCCESS", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(VoidStorageInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WeeklyRewardsSharedDocumentation.lua b/APIDocumentation/Documentation/WeeklyRewardsSharedDocumentation.lua deleted file mode 100644 index 99a8a70..0000000 --- a/APIDocumentation/Documentation/WeeklyRewardsSharedDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local WeeklyRewardsShared = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(WeeklyRewardsShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WoWGuidDocumentation.lua b/APIDocumentation/Documentation/WoWGuidDocumentation.lua deleted file mode 100644 index 61cf328..0000000 --- a/APIDocumentation/Documentation/WoWGuidDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local WoWGuid = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(WoWGuid); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WorldStateInfoDocumentation.lua b/APIDocumentation/Documentation/WorldStateInfoDocumentation.lua deleted file mode 100644 index 6b2a5e7..0000000 --- a/APIDocumentation/Documentation/WorldStateInfoDocumentation.lua +++ /dev/null @@ -1,58 +0,0 @@ -local WorldStateInfo = -{ - Name = "WorldStateInfo", - Type = "System", - Namespace = "C_WorldStateInfo", - - Functions = - { - }, - - Events = - { - { - Name = "StartTimer", - Type = "Event", - LiteralName = "START_TIMER", - Payload = - { - { Name = "timerType", Type = "luaIndex", 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", - Payload = - { - { Name = "timerType", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "WorldStateTimerStart", - Type = "Event", - LiteralName = "WORLD_STATE_TIMER_START", - Payload = - { - { Name = "timerID", Type = "number", Nilable = false }, - }, - }, - { - Name = "WorldStateTimerStop", - Type = "Event", - LiteralName = "WORLD_STATE_TIMER_STOP", - Payload = - { - { Name = "timerID", Type = "number", Nilable = false }, - }, - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(WorldStateInfo); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WowEntitlementInfoDocumentation.lua b/APIDocumentation/Documentation/WowEntitlementInfoDocumentation.lua deleted file mode 100644 index fe98703..0000000 --- a/APIDocumentation/Documentation/WowEntitlementInfoDocumentation.lua +++ /dev/null @@ -1,67 +0,0 @@ -local WowEntitlementInfo = -{ - Name = "WowEntitlementInfo", - Type = "System", - Namespace = "C_WowEntitlementInfo", - - Functions = - { - }, - - Events = - { - { - Name = "EntitlementDelivered", - Type = "Event", - LiteralName = "ENTITLEMENT_DELIVERED", - 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", - 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/APIDocumentation/Documentation/WowLabsConstantsDocumentation.lua b/APIDocumentation/Documentation/WowLabsConstantsDocumentation.lua deleted file mode 100644 index eb626b8..0000000 --- a/APIDocumentation/Documentation/WowLabsConstantsDocumentation.lua +++ /dev/null @@ -1,8 +0,0 @@ -local WowLabsConstants = -{ - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(WowLabsConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WowTokenUIDocumentation.lua b/APIDocumentation/Documentation/WowTokenUIDocumentation.lua deleted file mode 100644 index c036212..0000000 --- a/APIDocumentation/Documentation/WowTokenUIDocumentation.lua +++ /dev/null @@ -1,119 +0,0 @@ -local WowTokenUI = -{ - Name = "WowTokenUI", - Type = "System", - Namespace = "C_WowTokenUI", - - Functions = - { - }, - - Events = - { - { - Name = "TokenAuctionSold", - Type = "Event", - LiteralName = "TOKEN_AUCTION_SOLD", - }, - { - Name = "TokenBuyConfirmRequired", - Type = "Event", - LiteralName = "TOKEN_BUY_CONFIRM_REQUIRED", - }, - { - Name = "TokenBuyResult", - Type = "Event", - LiteralName = "TOKEN_BUY_RESULT", - Payload = - { - { Name = "result", Type = "number", Nilable = false }, - }, - }, - { - Name = "TokenCanVeteranBuyUpdate", - Type = "Event", - LiteralName = "TOKEN_CAN_VETERAN_BUY_UPDATE", - Payload = - { - { Name = "result", Type = "number", Nilable = false }, - }, - }, - { - Name = "TokenDistributionsUpdated", - Type = "Event", - LiteralName = "TOKEN_DISTRIBUTIONS_UPDATED", - Payload = - { - { Name = "result", Type = "number", Nilable = false }, - }, - }, - { - Name = "TokenMarketPriceUpdated", - Type = "Event", - LiteralName = "TOKEN_MARKET_PRICE_UPDATED", - Payload = - { - { Name = "result", Type = "number", Nilable = false }, - }, - }, - { - Name = "TokenRedeemBalanceUpdated", - Type = "Event", - LiteralName = "TOKEN_REDEEM_BALANCE_UPDATED", - }, - { - Name = "TokenRedeemConfirmRequired", - Type = "Event", - LiteralName = "TOKEN_REDEEM_CONFIRM_REQUIRED", - Payload = - { - { Name = "choiceType", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "TokenRedeemFrameShow", - Type = "Event", - LiteralName = "TOKEN_REDEEM_FRAME_SHOW", - }, - { - Name = "TokenRedeemGameTimeUpdated", - Type = "Event", - LiteralName = "TOKEN_REDEEM_GAME_TIME_UPDATED", - }, - { - Name = "TokenRedeemResult", - Type = "Event", - LiteralName = "TOKEN_REDEEM_RESULT", - Payload = - { - { Name = "result", Type = "luaIndex", Nilable = false }, - { Name = "choiceType", Type = "luaIndex", Nilable = false }, - }, - }, - { - Name = "TokenSellConfirmRequired", - Type = "Event", - LiteralName = "TOKEN_SELL_CONFIRM_REQUIRED", - }, - { - Name = "TokenSellResult", - Type = "Event", - LiteralName = "TOKEN_SELL_RESULT", - Payload = - { - { Name = "result", Type = "number", Nilable = false }, - }, - }, - { - Name = "TokenStatusChanged", - Type = "Event", - LiteralName = "TOKEN_STATUS_CHANGED", - }, - }, - - Tables = - { - }, -}; - -APIDocumentation:AddDocumentationTable(WowTokenUI); \ No newline at end of file diff --git a/APIDocumentation/Documentation/XMLUtilDocumentation.lua b/APIDocumentation/Documentation/XMLUtilDocumentation.lua deleted file mode 100644 index e1a418f..0000000 --- a/APIDocumentation/Documentation/XMLUtilDocumentation.lua +++ /dev/null @@ -1,75 +0,0 @@ -local XMLUtil = -{ - Name = "XMLUtil", - Type = "System", - Namespace = "C_XMLUtil", - - Functions = - { - { - Name = "GetTemplateInfo", - Type = "Function", - - 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 = "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/APIDocumentation/Documentation/ZoneInformationDocumentation.lua b/APIDocumentation/Documentation/ZoneInformationDocumentation.lua new file mode 100644 index 0000000..f867622 --- /dev/null +++ b/APIDocumentation/Documentation/ZoneInformationDocumentation.lua @@ -0,0 +1,101 @@ +local ZoneInformation = +{ + Name = "Zone Information", + Type = "System", + Namespace = "Zone Information", + + Functions = + { + { + Name = "GetMinimapZoneText", + Type = "Function", + + Returns = + { + { Name = "zoneText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetRealZoneText", + Type = "Function", + + Returns = + { + { Name = "zoneName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetSubZoneText", + Type = "Function", + + Returns = + { + { Name = "subzoneText", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetZonePVPInfo", + Type = "Function", + + Returns = + { + { Name = "pvpType", Type = "string", Nilable = false }, + { Name = "isSubZonePVP", Type = "bool", Nilable = false }, + { Name = "factionName", Type = "string", Nilable = false }, + }, + }, + { + Name = "GetZoneText", + Type = "Function", + + Returns = + { + { Name = "zone", Type = "string", Nilable = false }, + }, + }, + { + Name = "IsSubZonePVPPOI", + Type = "Function", + + Returns = + { + { Name = "isPVPPOI", Type = "bool", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "AreaSpiritHealerInRange", + Type = "Event", + LiteralName = "AREA_SPIRIT_HEALER_IN_RANGE", + }, + { + Name = "AreaSpiritHealerOutOfRange", + Type = "Event", + LiteralName = "AREA_SPIRIT_HEALER_OUT_OF_RANGE", + }, + { + Name = "ZoneChanged", + Type = "Event", + LiteralName = "ZONE_CHANGED", + }, + { + Name = "ZoneChangedIndoors", + Type = "Event", + LiteralName = "ZONE_CHANGED_INDOORS", + }, + { + Name = "ZoneChangedNewArea", + Type = "Event", + LiteralName = "ZONE_CHANGED_NEW_AREA", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ZoneInformation); diff --git a/APIDocumentation/EventsAPIMixin.lua b/APIDocumentation/EventsAPIMixin.lua index e0bb762..3b061fb 100644 --- a/APIDocumentation/EventsAPIMixin.lua +++ b/APIDocumentation/EventsAPIMixin.lua @@ -26,10 +26,7 @@ function EventsAPIMixin:GetClipboardString() 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 +function EventsAPIMixin:GetFullName(decorateOptionals, includeColorCodes) return ("Event.%s -> %s"):format(self:GetName(), self:GetPayloadString(decorateOptionals, includeColorCodes)); end diff --git a/APIDocumentation/FunctionsAPIMixin.lua b/APIDocumentation/FunctionsAPIMixin.lua index 6aa6977..241d973 100644 --- a/APIDocumentation/FunctionsAPIMixin.lua +++ b/APIDocumentation/FunctionsAPIMixin.lua @@ -19,9 +19,6 @@ function FunctionsAPIMixin:GetLinkHexColor() 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