diff --git a/.luacheckrc b/.luacheckrc index 3040487..7fc1481 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -19570,5 +19570,7 @@ globals = { "SecondsFormatterConstants", "ConvertSecondsToUnits", "SecondsToClock", "MinutesToTime", "FormatShortDate", "NUMBER_ABBREVIATION_DATA", "WeakAurasProfilingReportTitleText", "WeakAurasRealTimeProfiling", "WeakAurasRealTimeProfilingTitleText", "seconds", "NUM_CHAT_WINDOWS", - "GetNumGlyphSockets", "GetGlyphLink", "GetGlyphSocketInfo" + "GetNumGlyphSockets", "GetGlyphLink", "GetGlyphSocketInfo", "APIDocumentationMixin", "BaseAPIMixin", + "EventsAPIMixin", "FieldsAPIMixin", "FunctionsAPIMixin", "SystemsAPIMixin", "TablesAPIMixin", + "CopyToClipboard", "ChatFrame_OpenChat", "ChatTypeInfo" } diff --git a/APIDocumentation/APIDocumentation.toc b/APIDocumentation/APIDocumentation.toc new file mode 100644 index 0000000..1c3900d --- /dev/null +++ b/APIDocumentation/APIDocumentation.toc @@ -0,0 +1,335 @@ +## Interface: 30300 +## Title: APIDocumentation +## Author: Blizzard Entertainment +## LoadOnDemand: 1 +## DefaultState: Enabled +## Version: 1.0.0 +## 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. +## Notes-esES: Una documentación completa de la API de Blizzard, incluidos constantes, funciones y eventos. +## Notes-esMX: Una documentación completa de la API de Blizzard, incluidos constantes, funciones y eventos. +## Notes-ruRU: Полная документация API Blizzard, включая константы, функции и события. +## Notes-zhTW: 一個全面的暴雪 API 文檔，包括常量、函數和事件。 +## Notes-zhCN: 一份全面的暴雪 API 文档，包括常量、函数和事件。 +## X-Flavor: 3.3.5 +## X-Category: Documentation + +## AddOn files +BaseAPIMixin.lua +FieldsAPIMixin.lua +FunctionsAPIMixin.lua +SystemsAPIMixin.lua +TablesAPIMixin.lua +EventsAPIMixin.lua +Blizzard_APIDocumentation.lua + +## Documentation files +Documentation\AccountConstantsDocumentation.lua +Documentation\AccountInfoDocumentation.lua +Documentation\AchievementInfoDocumentation.lua +Documentation\ActionBarFrameDocumentation.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\BankDocumentation.lua +Documentation\BarberShopDocumentation.lua +Documentation\BaseDocumentation.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\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\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\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\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\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\ItemDocumentation.lua +Documentation\ItemLocationSharedDocumentation.lua +Documentation\ItemSharedDocumentation.lua +Documentation\ItemSocketInfoDocumentation.lua +Documentation\ItemTextDocumentation.lua +Documentation\ItemUpgradeDocumentation.lua +Documentation\KeyBindingsDocumentation.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\LootDocumentation.lua +Documentation\LossOfControlDocumentation.lua +Documentation\MailInfoDocumentation.lua +Documentation\MapConstantsDocumentation.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\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\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\UnitDocumentation.lua +Documentation\UnitSexConstantsDocumentation.lua +Documentation\UnitSharedDocumentation.lua +Documentation\URLDocumentation.lua +Documentation\UserFeedbackDocumentation.lua +Documentation\ValidateNameConstantsDocumentation.lua +Documentation\VectorSharedDocumentation.lua +Documentation\VehicleConstantsDocumentation.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 diff --git a/APIDocumentation/BaseAPIMixin.lua b/APIDocumentation/BaseAPIMixin.lua new file mode 100644 index 0000000..5b13268 --- /dev/null +++ b/APIDocumentation/BaseAPIMixin.lua @@ -0,0 +1,124 @@ +local addonName, Private = ... + +Private.Mixin = function(object, ...) + for i = 1, select("#", ...) do + local mixin = select(i, ...); + for k, v in pairs(mixin) do + object[k] = v; + end + end + return object; +end + +Private.CreateFromMixins = function(...) + return Private.Mixin({}, ...) +end + +BaseAPIMixin = {}; + +function BaseAPIMixin:GetType() + return assert(false); +end + +function BaseAPIMixin:GetPrettyType() + return self:GetType(); +end + +function BaseAPIMixin:GetLinkHexColor() + return "ffffff"; +end + +function BaseAPIMixin:GetName() + return self.Name; +end + +function BaseAPIMixin:GetFullName() + return self:GetName(); +end + +function BaseAPIMixin:GetParentName() + return ""; +end + +function BaseAPIMixin:GetLoweredParentName() + if not self.loweredParentName then + self.loweredParentName = self:GetParentName():lower(); + end + return self.loweredParentName; +end + +function BaseAPIMixin:GetLoweredName() + if not self.loweredName then + self.loweredName = self:GetName():lower(); + end + return self.loweredName; +end + +function BaseAPIMixin:GetClipboardString() + return self:GetFullName(); +end + +function BaseAPIMixin:GenerateAPILink() + return ("|cff%s|Hapi:%s:%s:%s|h%s|h|r"):format(self:GetLinkHexColor(), self:GetType(), self:GetName(), self:GetParentName(), self:GetFullName()); +end + +function BaseAPIMixin:GetSingleOutputLine() + return ("%s %s"):format(self:GetPrettyType(), self:GenerateAPILink()); +end + +function BaseAPIMixin:GetDetailedOutputLines() + return { self:GetSingleOutputLine() }; +end + +function BaseAPIMixin:MatchesSearchString(searchString) + return false; +end + +function BaseAPIMixin:MatchesName(name, parentName) + if name == self:GetName() then + return not parentName or parentName == self:GetParentName(); + end + return false; +end + +function BaseAPIMixin:MatchesNameCaseInsenstive(name, parentName) + if name == self:GetLoweredName() then + return not parentName or parentName == self:GetLoweredParentName(); + end + return false; +end + +function BaseAPIMixin:MatchesAnyAPI(apiTable, searchString) + if apiTable then + for i, apiInfo in ipairs(apiTable) do + if apiInfo:MatchesSearchString(searchString) then + return true; + end + end + end + return false; +end + +function BaseAPIMixin:MatchesAnyDocumentation(searchString) + if self.Documentation then + for i, documentation in ipairs(self.Documentation) do + if documentation:lower():match(searchString) then + return true; + end + end + end +end + +function BaseAPIMixin:AddDocumentationTags(lines) + if self.Documentation then + for i, documentation in ipairs(self.Documentation) do + table.insert(lines, APIDocumentation:GetIndentString() .. documentation); + end + end +end + +function BaseAPIMixin:AddSystemTag(lines) + if self.System then + table.insert(lines, APIDocumentation:GetIndentString() .. ("Part of the %s system"):format(self.System:GenerateAPILink())); + end +end diff --git a/APIDocumentation/Blizzard_APIDocumentation.lua b/APIDocumentation/Blizzard_APIDocumentation.lua new file mode 100644 index 0000000..e745143 --- /dev/null +++ b/APIDocumentation/Blizzard_APIDocumentation.lua @@ -0,0 +1,404 @@ +local addonName, Private = ... + +APIDocumentationMixin = {}; + +-- "public" +function APIDocumentationMixin:OnLoad() + self.tables = {}; + self.functions = {}; + self.systems = {}; + self.fields = {}; + self.events = {}; + self.callbacks = {}; + + self.Commands = { + Default = 1, + CopyAPI = 2, + OpenDump = 3, + }; +end + +function APIDocumentationMixin:HandleSlashCommand(command) + local commands = { (" "):split(command) }; + + if commands[1] == "?" or commands[1] == "help" or commands[1] == "" then + self:OutputUsage(); + elseif commands[1] == "stats" then + self:OutputStats(); + elseif commands[1] == "system" then + if commands[2] == "list" then + self:OutputAllSystems(); + else + self:OutputUsage(); + end + elseif commands[1] == "s" or commands[1] == "search" then + self:OutputAllAPIMatches(unpack(commands, 2)); + elseif commands[1] then + self:TryHandlingSystemSearchCommand(unpack(commands)); + else + self:OutputUsage(); + end +end + +function APIDocumentationMixin:HandleAPILink(link, command) + local _, type, name, parentName = (":"):split(link); + local apiInfo = self:FindAPIByName(type, name, parentName); + if apiInfo then + if command == self.Commands.CopyAPI then + self:HandleCopyAPI(apiInfo); + elseif command == self.Commands.OpenDump then + self:HandleOpenDump(apiInfo); + else + self:HandleDefaultCommand(apiInfo); + end + end +end + +function APIDocumentationMixin:HandleDefaultCommand(apiInfo) + self:WriteLine(" "); + self:WriteAllLines(apiInfo:GetDetailedOutputLines()); +end + +function APIDocumentationMixin:HandleCopyAPI(apiInfo) + local clipboardString = apiInfo:GetClipboardString(); + if CopyToClipboard then + CopyToClipboard(clipboardString); + end + self:WriteLineF("Copied to clipboard: %s", clipboardString); +end + +function APIDocumentationMixin:HandleOpenDump(apiInfo) + if apiInfo.Type == "Function" then + local dumpString; + local systemNamespace = apiInfo.System and apiInfo.System:GetNamespaceName() or nil; + if systemNamespace and systemNamespace ~= "" then + dumpString = ("/dump %s.%s()"):format(systemNamespace, apiInfo.Name); + else + dumpString = ("/dump %s()"):format(apiInfo.Name); + end + + local desiredCursorPosition = #dumpString - 1; + ChatFrame_OpenChat(dumpString, nil, desiredCursorPosition); + else + self:WriteLine("Can only /dump functions"); + end +end + +function APIDocumentationMixin:FindAPIByName(apiType, name, parentName) + local apiTable = self:GetAPITableByTypeName(apiType); + if apiTable then + for i, apiInfo in ipairs(apiTable) do + if apiInfo:MatchesName(name, parentName) then + return apiInfo; + end + end + end + return nil; +end + +function APIDocumentationMixin:GetAPITableByTypeName(apiType) + if apiType == "function" then + return self.functions; + elseif apiType == "table" then + return self.tables; + elseif apiType == "system" then + return self.systems; + elseif apiType == "field" then + return self.fields; + elseif apiType == "event" then + return self.events; + elseif apiType == "callback" then + return self.callbacks; + end + return nil; +end + +function APIDocumentationMixin:OutputUsage() + self:WriteLine("Usage:"); + + self:WriteLine("Search for API"); + self:WriteLine(self:GetIndentString() .. "/api search "); + self:WriteLine(self:GetIndentString() .. "or"); + self:WriteLine(self:GetIndentString() .. "/api s "); + self:WriteLine(self:GetIndentString() .. "Example: /api search item"); + self:WriteLine(" "); + + self:WriteLine("List all systems"); + self:WriteLine(self:GetIndentString() .. "/api system list"); + self:WriteLine(" "); + + self:WriteLine("Search system for API"); + self:WriteLine(self:GetIndentString() .. "/api search "); + self:WriteLine(self:GetIndentString() .. "or"); + self:WriteLine(self:GetIndentString() .. "/api s "); + self:WriteLine(self:GetIndentString() .. "Example: /api artifactui search relic"); + self:WriteLine(" "); + + self:WriteLine("List all API in a system"); + self:WriteLine(self:GetIndentString() .. "/api list"); + self:WriteLine(self:GetIndentString() .. "Example: /api artifactui list"); + self:WriteLine(" "); + self:WriteLine("All searches support Lua patterns."); +end + +function APIDocumentationMixin:OutputStats() + self:WriteLine("Stats:"); + self:WriteLineF("Total systems: %d", #self.systems); + local totalFunctions = 0; + local totalEvents = 0; + local totalTables = 0; + + for i, systemInfo in ipairs(self.systems) do + totalFunctions = totalFunctions + systemInfo:GetNumFunctions(); + totalEvents = totalEvents + systemInfo:GetNumEvents(); + totalTables = totalTables + systemInfo:GetNumTables(); + end + + self:WriteLineF("Total functions: %d", totalFunctions); + self:WriteLineF("Total events: %d", totalEvents); + self:WriteLineF("Total tables: %d", totalTables); +end + +function APIDocumentationMixin:OutputAllSystems() + self:WriteLineF("All systems (%d):", #self.systems); + for i, systemInfo in ipairs(self.systems) do + self:WriteLine(systemInfo:GetSingleOutputLine()); + end +end + +function APIDocumentationMixin:TryHandlingSystemSearchCommand(systemName, subCommand, apiToSearchFor) + local system = self:FindSystemByName(systemName); + if system then + if subCommand == nil then + self:WriteLine(system:GetSingleOutputLine()); + elseif subCommand == "s" or subCommand == "search" and apiToSearchFor then + self:OutputAllSystemAPIMatches(system, apiToSearchFor); + elseif subCommand == "list" then + self:OutputAllSystemAPI(system); + else + self:OutputUsage(); + end + else + self:WriteLineF("No system found (%s)", tostring(systemName)); + end +end + +function APIDocumentationMixin:OutputAPIMatches(apiMatches, headerName) + if apiMatches and #apiMatches > 0 then + self:WriteLineF("Found %d %s", #apiMatches, headerName); + for i, api in ipairs(apiMatches) do + self:WriteLine(self:GetIndentString() .. api:GetSingleOutputLine()); + end + end +end + +function APIDocumentationMixin:OutputAllAPIMatches(apiToSearchFor) + if not apiToSearchFor or apiToSearchFor == "" then + self:OutputUsage(); + return; + end + self:WriteLine(" "); + + local apiMatches = self:FindAllAPIMatches(apiToSearchFor); + if apiMatches then + local total = #apiMatches.tables + #apiMatches.functions + #apiMatches.events + #apiMatches.systems + #apiMatches.callbacks; + assert(total > 0); + self:WriteLineF("Found %d API that matches %q", total, apiToSearchFor); + + self:OutputAPIMatches(apiMatches.systems, "system(s)"); + self:OutputAPIMatches(apiMatches.functions, "function(s)"); + self:OutputAPIMatches(apiMatches.events, "events(s)"); + self:OutputAPIMatches(apiMatches.tables, "table(s)"); + self:OutputAPIMatches(apiMatches.callbacks, "callback(s)"); + else + self:WriteLineF("No API found that matches %q", apiToSearchFor); + end +end + +function APIDocumentationMixin:OutputAllSystemAPIMatches(system, apiToSearchFor) + local apiMatches = system:FindAllAPIMatches(apiToSearchFor); + if apiMatches then + local total = #apiMatches.tables + #apiMatches.functions + #apiMatches.events; + assert(total > 0); + self:WriteLineF("Found %d API that matches %q", total, apiToSearchFor); + + self:OutputAPIMatches(apiMatches.functions, "function(s)"); + self:OutputAPIMatches(apiMatches.events, "events(s)"); + self:OutputAPIMatches(apiMatches.tables, "table(s)"); + else + self:WriteLineF("No API found that matches %q in %s", apiToSearchFor, system:GenerateAPILink()); + end +end + +function APIDocumentationMixin:OutputAllSystemAPI(system) + local apiMatches = system:ListAllAPI(); + if apiMatches then + self:WriteLineF("All API in %s", system:GenerateAPILink()); + + self:OutputAPIMatches(apiMatches.functions, "function(s)"); + self:OutputAPIMatches(apiMatches.events, "events(s)"); + self:OutputAPIMatches(apiMatches.tables, "table(s)"); + else + self:WriteLineF("No API found in %s", system:GenerateAPILink()); + end +end + +--[[static]] function APIDocumentationMixin:AddAllMatches(apiContainer, matchesContainer, apiToSearchFor) + for i, apiInfo in ipairs(apiContainer) do + if apiInfo:MatchesSearchString(apiToSearchFor) then + table.insert(matchesContainer, apiInfo); + end + end +end + +function APIDocumentationMixin:FindAllAPIMatches(apiToSearchFor) + apiToSearchFor = apiToSearchFor:lower(); + + local matches = { + tables = {}, + functions = {}, + events = {}, + systems = {}, + callbacks = {}, + }; + + self:AddAllMatches(self.tables, matches.tables, apiToSearchFor); + self:AddAllMatches(self.functions, matches.functions, apiToSearchFor); + self:AddAllMatches(self.systems, matches.systems, apiToSearchFor); + self:AddAllMatches(self.events, matches.events, apiToSearchFor); + self:AddAllMatches(self.callbacks, matches.callbacks, apiToSearchFor); + + -- Only return something if we matched anything + for name, subTable in pairs(matches) do + if #subTable > 0 then + return matches; + end + end + + return nil; +end + +function APIDocumentationMixin:FindSystemByName(systemName) + systemName = systemName:lower(); + for i, systemInfo in ipairs(self.systems) do + if systemInfo:MatchesNameCaseInsenstive(systemName) then + return systemInfo; + end + end + return nil; +end + +local j = 1 +function APIDocumentationMixin:AddDocumentationTable(documentationInfo) + j = j + 1 + if documentationInfo.Name then + self:AddSystem(documentationInfo); + else + for i, tableInfo in ipairs(documentationInfo.Tables) do + self:AddTable(tableInfo); + end + end +end + +function APIDocumentationMixin:WriteLine(message) + if DEFAULT_CHAT_FRAME then + local info = ChatTypeInfo["SYSTEM"]; + DEFAULT_CHAT_FRAME:AddMessage(message, info.r, info.g, info.b, info.id); + else + print(message); + end +end + +function APIDocumentationMixin:WriteLineF(format, ...) + self:WriteLine(format:format(...)); +end + +function APIDocumentationMixin:WriteAllLines(lines) + for i, line in ipairs(lines) do + self:WriteLine(line); + end +end + +function APIDocumentationMixin:GetIndentString(numIndent) + return (" "):rep(numIndent or 1); +end + +-- "private" +function APIDocumentationMixin:AddTable(documentationInfo) + Private.Mixin(documentationInfo, TablesAPIMixin); + + table.insert(self.tables, documentationInfo); + + if documentationInfo.Fields then + for i, field in ipairs(documentationInfo.Fields) do + field.Table = documentationInfo; + self:AddField(field); + end + end +end + +function APIDocumentationMixin:AddFunction(documentationInfo) + Private.Mixin(documentationInfo, FunctionsAPIMixin); + + table.insert(self.functions, documentationInfo); + + if documentationInfo.Arguments then + for i, field in ipairs(documentationInfo.Arguments) do + field.Function = documentationInfo; + self:AddField(field); + end + end + + if documentationInfo.Returns then + for i, field in ipairs(documentationInfo.Returns) do + field.Function = documentationInfo; + self:AddField(field); + end + end +end + +function APIDocumentationMixin:AddEvent(documentationInfo) + Private.Mixin(documentationInfo, EventsAPIMixin); + + table.insert(self.events, documentationInfo); + + if documentationInfo.Payload then + for i, field in ipairs(documentationInfo.Payload) do + field.Event = documentationInfo; + self:AddField(field); + end + end +end + +function APIDocumentationMixin:AddField(documentationInfo) + Private.Mixin(documentationInfo, FieldsAPIMixin); + + table.insert(self.fields, documentationInfo); +end + +function APIDocumentationMixin:AddSystem(documentationInfo) + Private.Mixin(documentationInfo, SystemsAPIMixin); + + table.insert(self.systems, documentationInfo); + + for i, functionInfo in ipairs(documentationInfo.Functions) do + functionInfo.System = documentationInfo; + self:AddFunction(functionInfo); + end + + for i, eventInfo in ipairs(documentationInfo.Events) do + eventInfo.System = documentationInfo; + self:AddEvent(eventInfo); + end + + for i, tableInfo in ipairs(documentationInfo.Tables) do + tableInfo.System = documentationInfo; + self:AddTable(tableInfo); + end +end + +APIDocumentation = Private.CreateFromMixins(APIDocumentationMixin); +APIDocumentation:OnLoad(); + +SLASH_API1 = '/api' +SlashCmdList["API"] = function(msg) APIDocumentation:HandleSlashCommand(msg) end diff --git a/APIDocumentation/Documentation/AccountConstantsDocumentation.lua b/APIDocumentation/Documentation/AccountConstantsDocumentation.lua new file mode 100644 index 0000000..30c2c66 --- /dev/null +++ b/APIDocumentation/Documentation/AccountConstantsDocumentation.lua @@ -0,0 +1,115 @@ +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 new file mode 100644 index 0000000..c0dee9e --- /dev/null +++ b/APIDocumentation/Documentation/AccountInfoDocumentation.lua @@ -0,0 +1,62 @@ +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/AchievementInfoDocumentation.lua b/APIDocumentation/Documentation/AchievementInfoDocumentation.lua new file mode 100644 index 0000000..0733eda --- /dev/null +++ b/APIDocumentation/Documentation/AchievementInfoDocumentation.lua @@ -0,0 +1,164 @@ +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 new file mode 100644 index 0000000..793889e --- /dev/null +++ b/APIDocumentation/Documentation/ActionBarFrameDocumentation.lua @@ -0,0 +1,267 @@ +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 new file mode 100644 index 0000000..d120575 --- /dev/null +++ b/APIDocumentation/Documentation/ActionDocumentation.lua @@ -0,0 +1,8 @@ +local Action = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Action); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AddOnsDocumentation.lua b/APIDocumentation/Documentation/AddOnsDocumentation.lua new file mode 100644 index 0000000..d0c099a --- /dev/null +++ b/APIDocumentation/Documentation/AddOnsDocumentation.lua @@ -0,0 +1,63 @@ +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/AdventureJournalDocumentation.lua b/APIDocumentation/Documentation/AdventureJournalDocumentation.lua new file mode 100644 index 0000000..823126d --- /dev/null +++ b/APIDocumentation/Documentation/AdventureJournalDocumentation.lua @@ -0,0 +1,96 @@ +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 new file mode 100644 index 0000000..3135eab --- /dev/null +++ b/APIDocumentation/Documentation/AdventureMapDocumentation.lua @@ -0,0 +1,53 @@ +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 new file mode 100644 index 0000000..cc1bf6d --- /dev/null +++ b/APIDocumentation/Documentation/AppearanceSourceDocumentation.lua @@ -0,0 +1,30 @@ +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 new file mode 100644 index 0000000..ebb7ea9 --- /dev/null +++ b/APIDocumentation/Documentation/AreaPoiInfoDocumentation.lua @@ -0,0 +1,103 @@ +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/AuctionHouseConstants_ClassicDocumentation.lua b/APIDocumentation/Documentation/AuctionHouseConstants_ClassicDocumentation.lua new file mode 100644 index 0000000..56a1c8b --- /dev/null +++ b/APIDocumentation/Documentation/AuctionHouseConstants_ClassicDocumentation.lua @@ -0,0 +1,8 @@ +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 new file mode 100644 index 0000000..3bef3cf --- /dev/null +++ b/APIDocumentation/Documentation/AuctionHouseDocumentation.lua @@ -0,0 +1,105 @@ +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 new file mode 100644 index 0000000..bc08943 --- /dev/null +++ b/APIDocumentation/Documentation/AuctionHouseEnumsDocumentation.lua @@ -0,0 +1,137 @@ +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/AzeriteConstantsDocumentation.lua b/APIDocumentation/Documentation/AzeriteConstantsDocumentation.lua new file mode 100644 index 0000000..b427160 --- /dev/null +++ b/APIDocumentation/Documentation/AzeriteConstantsDocumentation.lua @@ -0,0 +1,22 @@ +local AzeriteConstants = +{ + Tables = + { + { + Name = "AzeriteEssenceSlot", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "MainSlot", Type = "AzeriteEssenceSlot", EnumValue = 0 }, + { Name = "PassiveOneSlot", Type = "AzeriteEssenceSlot", EnumValue = 1 }, + { Name = "PassiveTwoSlot", Type = "AzeriteEssenceSlot", EnumValue = 2 }, + { Name = "PassiveThreeSlot", Type = "AzeriteEssenceSlot", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(AzeriteConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua b/APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua new file mode 100644 index 0000000..afd96f4 --- /dev/null +++ b/APIDocumentation/Documentation/AzeriteEmpoweredItemDocumentation.lua @@ -0,0 +1,327 @@ +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 new file mode 100644 index 0000000..2931baf --- /dev/null +++ b/APIDocumentation/Documentation/AzeriteEssenceDocumentation.lua @@ -0,0 +1,326 @@ +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 new file mode 100644 index 0000000..165b628 --- /dev/null +++ b/APIDocumentation/Documentation/AzeriteItemDocumentation.lua @@ -0,0 +1,183 @@ +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 new file mode 100644 index 0000000..d8e429a --- /dev/null +++ b/APIDocumentation/Documentation/BagConstantsDocumentation.lua @@ -0,0 +1,26 @@ +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 new file mode 100644 index 0000000..ec2805d --- /dev/null +++ b/APIDocumentation/Documentation/BagIndexConstantsDocumentation.lua @@ -0,0 +1,46 @@ +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 new file mode 100644 index 0000000..fd98451 --- /dev/null +++ b/APIDocumentation/Documentation/BankDocumentation.lua @@ -0,0 +1,53 @@ +local Bank = +{ + Name = "Bank", + Type = "System", + Namespace = "C_Bank", + + Functions = + { + }, + + Events = + { + { + Name = "BankBagSlotFlagsUpdated", + Type = "Event", + LiteralName = "BANK_BAG_SLOT_FLAGS_UPDATED", + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + { + Name = "BankframeClosed", + Type = "Event", + LiteralName = "BANKFRAME_CLOSED", + }, + { + Name = "BankframeOpened", + Type = "Event", + LiteralName = "BANKFRAME_OPENED", + }, + { + Name = "PlayerbankbagslotsChanged", + Type = "Event", + LiteralName = "PLAYERBANKBAGSLOTS_CHANGED", + }, + { + Name = "PlayerbankslotsChanged", + Type = "Event", + LiteralName = "PLAYERBANKSLOTS_CHANGED", + Payload = + { + { Name = "slot", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Bank); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BarberShopDocumentation.lua b/APIDocumentation/Documentation/BarberShopDocumentation.lua new file mode 100644 index 0000000..6ea8633 --- /dev/null +++ b/APIDocumentation/Documentation/BarberShopDocumentation.lua @@ -0,0 +1,339 @@ +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/BaseDocumentation.lua b/APIDocumentation/Documentation/BaseDocumentation.lua new file mode 100644 index 0000000..fced442 --- /dev/null +++ b/APIDocumentation/Documentation/BaseDocumentation.lua @@ -0,0 +1,15 @@ +local Base = +{ + Tables = + { + { + Name = "ScriptObject", + Type = "Structure", + Fields = + { + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Base); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BattleNetDocumentation.lua b/APIDocumentation/Documentation/BattleNetDocumentation.lua new file mode 100644 index 0000000..de76e96 --- /dev/null +++ b/APIDocumentation/Documentation/BattleNetDocumentation.lua @@ -0,0 +1,172 @@ +local BattleNet = +{ + Name = "BattleNet", + Type = "System", + Namespace = "C_BattleNet", + + 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", + Type = "Function", + + Arguments = + { + { Name = "friendIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numGameAccounts", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetGameAccountInfoByGUID", + Type = "Function", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + }, + }, + { + Name = "GetGameAccountInfoByID", + Type = "Function", + + Arguments = + { + { Name = "id", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = true }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + { + Name = "BNetAccountInfo", + Type = "Structure", + Fields = + { + { Name = "bnetAccountID", Type = "number", Nilable = false }, + { Name = "accountName", Type = "string", Nilable = false }, + { Name = "battleTag", Type = "string", Nilable = false }, + { Name = "isFriend", Type = "bool", Nilable = false }, + { Name = "isBattleTagFriend", Type = "bool", Nilable = false }, + { Name = "lastOnlineTime", Type = "number", Nilable = false }, + { Name = "isAFK", Type = "bool", Nilable = false }, + { Name = "isDND", Type = "bool", Nilable = false }, + { Name = "isFavorite", Type = "bool", Nilable = false }, + { Name = "appearOffline", Type = "bool", Nilable = false }, + { Name = "customMessage", Type = "string", Nilable = false }, + { Name = "customMessageTime", Type = "number", Nilable = false }, + { Name = "note", Type = "string", Nilable = false }, + { Name = "rafLinkType", Type = "RafLinkType", Nilable = false }, + { Name = "gameAccountInfo", Type = "BNetGameAccountInfo", Nilable = false }, + }, + }, + { + Name = "BNetGameAccountInfo", + Type = "Structure", + Fields = + { + { Name = "gameAccountID", Type = "number", Nilable = false }, + { Name = "clientProgram", Type = "string", Nilable = false }, + { Name = "isOnline", Type = "bool", Nilable = false }, + { Name = "isGameBusy", Type = "bool", Nilable = false }, + { Name = "isGameAFK", Type = "bool", Nilable = false }, + { Name = "wowProjectID", Type = "number", Nilable = true }, + { Name = "characterName", Type = "string", Nilable = true }, + { Name = "realmName", Type = "string", Nilable = true }, + { Name = "realmDisplayName", Type = "string", Nilable = true }, + { Name = "realmID", Type = "number", Nilable = true }, + { Name = "factionName", Type = "string", Nilable = true }, + { Name = "raceName", Type = "string", Nilable = true }, + { Name = "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 diff --git a/APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua b/APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua new file mode 100644 index 0000000..61b2809 --- /dev/null +++ b/APIDocumentation/Documentation/BattlePetConstantsDocumentation.lua @@ -0,0 +1,396 @@ +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 new file mode 100644 index 0000000..7d12d2b --- /dev/null +++ b/APIDocumentation/Documentation/BattlePetDocumentation.lua @@ -0,0 +1,233 @@ +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/BehavioralMessagingDocumentation.lua b/APIDocumentation/Documentation/BehavioralMessagingDocumentation.lua new file mode 100644 index 0000000..b0c3f39 --- /dev/null +++ b/APIDocumentation/Documentation/BehavioralMessagingDocumentation.lua @@ -0,0 +1,41 @@ +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 new file mode 100644 index 0000000..e84d21d --- /dev/null +++ b/APIDocumentation/Documentation/BlackMarketInfoDocumentation.lua @@ -0,0 +1,70 @@ +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/Blizzard_APIDocumentationGenerated.toc b/APIDocumentation/Documentation/Blizzard_APIDocumentationGenerated.toc new file mode 100644 index 0000000..48c5593 --- /dev/null +++ b/APIDocumentation/Documentation/Blizzard_APIDocumentationGenerated.toc @@ -0,0 +1,278 @@ +## 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 new file mode 100644 index 0000000..40d5f20 --- /dev/null +++ b/APIDocumentation/Documentation/BountySharedDocumentation.lua @@ -0,0 +1,20 @@ +local BountyShared = +{ + Tables = + { + { + Name = "BountyInfo", + Type = "Structure", + Fields = + { + { Name = "questID", Type = "number", Nilable = false }, + { Name = "factionID", Type = "number", Nilable = false }, + { Name = "icon", Type = "fileID", Nilable = false }, + { Name = "numObjectives", Type = "number", Nilable = false }, + { Name = "turninRequirementText", Type = "cstring", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(BountyShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/BrowserDocumentation.lua b/APIDocumentation/Documentation/BrowserDocumentation.lua new file mode 100644 index 0000000..e13b2b2 --- /dev/null +++ b/APIDocumentation/Documentation/BrowserDocumentation.lua @@ -0,0 +1,39 @@ +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/BuildDocumentation.lua b/APIDocumentation/Documentation/BuildDocumentation.lua new file mode 100644 index 0000000..dd0ee87 --- /dev/null +++ b/APIDocumentation/Documentation/BuildDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..5092d50 --- /dev/null +++ b/APIDocumentation/Documentation/ButtonConstantsDocumentation.lua @@ -0,0 +1,8 @@ +local ButtonConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ButtonConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CVarDocumentation.lua b/APIDocumentation/Documentation/CVarDocumentation.lua new file mode 100644 index 0000000..2c932c0 --- /dev/null +++ b/APIDocumentation/Documentation/CVarDocumentation.lua @@ -0,0 +1,124 @@ +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 new file mode 100644 index 0000000..a2a78a1 --- /dev/null +++ b/APIDocumentation/Documentation/CalendarConstantsDocumentation.lua @@ -0,0 +1,337 @@ +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 new file mode 100644 index 0000000..109847d --- /dev/null +++ b/APIDocumentation/Documentation/CalendarDocumentation.lua @@ -0,0 +1,1112 @@ +local Calendar = +{ + Name = "Calendar", + Type = "System", + Namespace = "C_Calendar", + + Functions = + { + { + Name = "AddEvent", + Type = "Function", + }, + { + Name = "AreNamesReady", + Type = "Function", + + Returns = + { + { Name = "ready", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanAddEvent", + Type = "Function", + + Returns = + { + { Name = "canAddEvent", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CanSendInvite", + Type = "Function", + + Returns = + { + { Name = "canSendInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CloseEvent", + Type = "Function", + }, + { + Name = "ContextMenuEventCanComplain", + Type = "Function", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canComplain", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventCanEdit", + Type = "Function", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventCanRemove", + Type = "Function", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "canRemove", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventClipboard", + Type = "Function", + + Returns = + { + { Name = "exists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventCopy", + Type = "Function", + }, + { + Name = "ContextMenuEventGetCalendarType", + Type = "Function", + + Returns = + { + { Name = "calendarType", Type = "string", Nilable = true }, + }, + }, + { + Name = "ContextMenuEventPaste", + Type = "Function", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ContextMenuEventRemove", + Type = "Function", + }, + { + Name = "ContextMenuEventSignUp", + Type = "Function", + }, + { + Name = "ContextMenuGetEventIndex", + Type = "Function", + + Returns = + { + { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, + }, + }, + { + Name = "ContextMenuInviteAvailable", + Type = "Function", + }, + { + Name = "ContextMenuInviteDecline", + Type = "Function", + }, + { + Name = "ContextMenuInviteRemove", + Type = "Function", + }, + { + Name = "ContextMenuInviteTentative", + Type = "Function", + }, + { + Name = "ContextMenuSelectEvent", + Type = "Function", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CreateCommunitySignUpEvent", + Type = "Function", + }, + { + Name = "CreateGuildAnnouncementEvent", + Type = "Function", + }, + { + Name = "CreateGuildSignUpEvent", + Type = "Function", + }, + { + Name = "CreatePlayerEvent", + Type = "Function", + }, + { + Name = "EventAvailable", + Type = "Function", + }, + { + Name = "EventCanEdit", + Type = "Function", + + Returns = + { + { Name = "canEdit", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventClearAutoApprove", + Type = "Function", + }, + { + Name = "EventClearLocked", + Type = "Function", + }, + { + Name = "EventClearModerator", + Type = "Function", + + Arguments = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventDecline", + Type = "Function", + }, + { + Name = "EventGetCalendarType", + Type = "Function", + + Returns = + { + { Name = "calendarType", Type = "string", Nilable = true }, + }, + }, + { + Name = "EventGetClubId", + Type = "Function", + + Returns = + { + { Name = "info", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "EventGetInvite", + Type = "Function", + + Arguments = + { + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "CalendarEventInviteInfo", Nilable = false }, + }, + }, + { + Name = "EventGetInviteResponseTime", + Type = "Function", + + Arguments = + { + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "time", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "EventGetInviteSortCriterion", + Type = "Function", + + Returns = + { + { Name = "criterion", Type = "string", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventGetSelectedInvite", + Type = "Function", + + Returns = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = true }, + }, + }, + { + Name = "EventGetStatusOptions", + Type = "Function", + + 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", + Type = "Function", + + Returns = + { + { Name = "types", Type = "table", InnerType = "string", Nilable = false }, + }, + }, + { + Name = "EventGetTypesDisplayOrdered", + Type = "Function", + + Returns = + { + { Name = "infos", Type = "table", InnerType = "CalendarEventTypeDisplayInfo", Nilable = false }, + }, + }, + { + Name = "EventHasPendingInvite", + Type = "Function", + + Returns = + { + { Name = "hasPendingInvite", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventHaveSettingsChanged", + Type = "Function", + + Returns = + { + { Name = "haveSettingsChanged", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventInvite", + Type = "Function", + + Arguments = + { + { Name = "name", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EventRemoveInvite", + Type = "Function", + + Arguments = + { + { Name = "inviteIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "EventRemoveInviteByGuid", + Type = "Function", + + Arguments = + { + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "EventSelectInvite", + 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 = "year", Type = "number", Nilable = false }, + }, + }, + { + Name = "EventSetDescription", + Type = "Function", + + Arguments = + { + { Name = "description", Type = "cstring", 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", + Type = "Function", + + Arguments = + { + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + }, + }, + { + Name = "EventSetTitle", + Type = "Function", + + Arguments = + { + { Name = "title", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "EventSetType", + Type = "Function", + + Arguments = + { + { Name = "typeIndex", Type = "CalendarEventType", Nilable = false }, + }, + }, + { + Name = "EventSignUp", + Type = "Function", + }, + { + Name = "EventSortInvites", + Type = "Function", + + Arguments = + { + { Name = "criterion", Type = "cstring", Nilable = false }, + { Name = "reverse", Type = "bool", Nilable = false }, + }, + }, + { + Name = "EventTentative", + Type = "Function", + }, + { + Name = "GetClubCalendarEvents", + Type = "Function", + + Arguments = + { + { Name = "clubId", Type = "ClubId", Nilable = false }, + { Name = "startTime", Type = "CalendarTime", Nilable = false }, + { Name = "endTime", Type = "CalendarTime", Nilable = false }, + }, + + Returns = + { + { Name = "events", Type = "table", InnerType = "CalendarDayEvent", Nilable = false }, + }, + }, + { + Name = "GetDayEvent", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "event", Type = "CalendarDayEvent", Nilable = false }, + }, + }, + { + Name = "GetDefaultGuildFilter", + Type = "Function", + + Returns = + { + { Name = "info", Type = "CalendarGuildFilterInfo", Nilable = false }, + }, + }, + { + Name = "GetEventIndex", + Type = "Function", + + Returns = + { + { Name = "info", Type = "CalendarEventIndexInfo", Nilable = false }, + }, + }, + { + Name = "GetEventIndexInfo", + 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 = "GetEventInfo", + Type = "Function", + + Returns = + { + { Name = "info", Type = "CalendarEventInfo", 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", + Type = "Function", + + Arguments = + { + { Name = "monthOffset", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "index", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "event", Type = "CalendarHolidayInfo", Nilable = false }, + }, + }, + { + Name = "GetMaxCreateDate", + Type = "Function", + + Returns = + { + { Name = "maxCreateDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "GetMinDate", + Type = "Function", + + Returns = + { + { Name = "minDate", Type = "CalendarTime", Nilable = false }, + }, + }, + { + Name = "GetMonthInfo", + Type = "Function", + + Arguments = + { + { Name = "offsetMonths", Type = "number", Nilable = false, Default = 0 }, + }, + + Returns = + { + { Name = "monthInfo", Type = "CalendarMonthInfo", Nilable = false }, + }, + }, + { + Name = "GetNextClubId", + Type = "Function", + + Returns = + { + { Name = "clubId", Type = "ClubId", Nilable = true }, + }, + }, + { + Name = "GetNumDayEvents", + Type = "Function", + + 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", + Type = "Function", + + Arguments = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "maxRankOrder", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "OpenCalendar", + Type = "Function", + }, + { + Name = "OpenEvent", + Type = "Function", + + 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", + }, + }, + + Events = + { + { + Name = "CalendarActionPending", + Type = "Event", + LiteralName = "CALENDAR_ACTION_PENDING", + Payload = + { + { Name = "pending", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarCloseEvent", + Type = "Event", + LiteralName = "CALENDAR_CLOSE_EVENT", + }, + { + 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", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_EVENT", + }, + { + Name = "CalendarUpdateEventList", + 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", + Type = "Event", + LiteralName = "CALENDAR_UPDATE_PENDING_INVITES", + }, + }, + + Tables = + { + { + Name = "CalendarDayEvent", + Type = "Structure", + Fields = + { + { Name = "eventID", Type = "CalendarEventID", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "isCustomTitle", Type = "bool", Nilable = false }, + { Name = "startTime", Type = "CalendarTime", Nilable = false }, + { Name = "endTime", Type = "CalendarTime", Nilable = false }, + { Name = "calendarType", Type = "cstring", Nilable = false }, + { Name = "sequenceType", Type = "cstring", Nilable = false }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + { Name = "iconTexture", Type = "fileID", Nilable = true }, + { Name = "modStatus", Type = "cstring", Nilable = false }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = false }, + { Name = "invitedBy", Type = "string", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, + { Name = "inviteType", Type = "CalendarInviteType", Nilable = false }, + { Name = "sequenceIndex", Type = "luaIndex", Nilable = false }, + { Name = "numSequenceDays", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "cstring", Nilable = false }, + { Name = "dontDisplayBanner", Type = "bool", Nilable = false }, + { Name = "dontDisplayEnd", Type = "bool", Nilable = false }, + { Name = "clubID", Type = "ClubId", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "CalendarEventIndexInfo", + Type = "Structure", + Fields = + { + { Name = "offsetMonths", Type = "number", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "eventIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CalendarEventInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "description", Type = "string", Nilable = false }, + { Name = "creator", Type = "string", Nilable = true }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + { Name = "repeatOption", Type = "CalendarEventRepeatOptions", Nilable = false }, + { Name = "maxSize", Type = "number", Nilable = false }, + { Name = "textureIndex", Type = "luaIndex", Nilable = true }, + { Name = "time", Type = "CalendarTime", Nilable = false }, + { Name = "lockoutTime", Type = "CalendarTime", Nilable = false }, + { Name = "isLocked", Type = "bool", Nilable = false }, + { Name = "isAutoApprove", Type = "bool", Nilable = false }, + { Name = "hasPendingInvite", Type = "bool", Nilable = false }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = true }, + { Name = "inviteType", Type = "CalendarInviteType", Nilable = true }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "communityName", Type = "string", Nilable = true }, + }, + }, + { + Name = "CalendarEventInviteInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = true }, + { Name = "level", Type = "number", Nilable = false }, + { Name = "className", Type = "string", Nilable = true }, + { Name = "classFilename", Type = "string", Nilable = true }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = true }, + { Name = "modStatus", Type = "string", Nilable = true }, + { Name = "inviteIsMine", Type = "bool", Nilable = false }, + { Name = "type", Type = "CalendarInviteType", Nilable = false }, + { Name = "notes", Type = "string", Nilable = false }, + { Name = "classID", Type = "number", Nilable = true }, + { Name = "guid", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "CalendarEventStatusOption", + Type = "Structure", + Fields = + { + { Name = "status", Type = "CalendarStatus", Nilable = false }, + { Name = "statusString", Type = "string", Nilable = false }, + }, + }, + { + Name = "CalendarEventTextureInfo", + Type = "Structure", + Fields = + { + { Name = "title", Type = "string", Nilable = false }, + { Name = "iconTexture", Type = "fileID", Nilable = false }, + { Name = "expansionLevel", Type = "number", Nilable = false }, + { Name = "difficultyId", Type = "number", Nilable = true }, + { Name = "mapId", Type = "number", Nilable = true }, + { Name = "isLfr", Type = "bool", Nilable = true }, + }, + }, + { + Name = "CalendarEventTypeDisplayInfo", + Type = "Structure", + Fields = + { + { Name = "displayString", Type = "string", Nilable = false }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + }, + }, + { + Name = "CalendarGuildEventInfo", + Type = "Structure", + Fields = + { + { Name = "eventID", Type = "CalendarEventID", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "monthDay", Type = "luaIndex", Nilable = false }, + { Name = "weekday", Type = "luaIndex", Nilable = false }, + { Name = "hour", Type = "number", Nilable = false }, + { Name = "minute", Type = "number", Nilable = false }, + { Name = "eventType", Type = "CalendarEventType", Nilable = false }, + { Name = "title", Type = "string", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "inviteStatus", Type = "CalendarStatus", Nilable = false }, + { Name = "clubID", Type = "ClubId", Nilable = false }, + }, + }, + { + Name = "CalendarGuildFilterInfo", + Type = "Structure", + Fields = + { + { Name = "minLevel", Type = "number", Nilable = false }, + { Name = "maxLevel", Type = "number", Nilable = false }, + { Name = "rank", Type = "number", Nilable = false }, + }, + }, + { + Name = "CalendarHolidayInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "description", Type = "cstring", Nilable = false }, + { Name = "texture", Type = "fileID", Nilable = false }, + { Name = "startTime", Type = "CalendarTime", Nilable = true }, + { Name = "endTime", Type = "CalendarTime", Nilable = true }, + }, + }, + { + Name = "CalendarMonthInfo", + Type = "Structure", + Fields = + { + { Name = "month", Type = "luaIndex", Nilable = false }, + { Name = "year", Type = "number", Nilable = false }, + { Name = "numDays", Type = "number", Nilable = false }, + { Name = "firstWeekday", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "CalendarRaidInfo", + Type = "Structure", + Fields = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "calendarType", Type = "string", Nilable = false }, + { Name = "raidID", Type = "number", Nilable = false }, + { Name = "time", Type = "CalendarTime", Nilable = false }, + { Name = "difficulty", Type = "number", Nilable = false }, + { Name = "difficultyName", Type = "string", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Calendar); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CameraDocumentation.lua b/APIDocumentation/Documentation/CameraDocumentation.lua new file mode 100644 index 0000000..68c6b55 --- /dev/null +++ b/APIDocumentation/Documentation/CameraDocumentation.lua @@ -0,0 +1,31 @@ +local Camera = +{ + Name = "Camera", + Type = "System", + Namespace = "C_CameraDefaults", + + Functions = + { + { + Name = "GetCameraFOVDefaults", + Type = "Function", + + Returns = + { + { Name = "fieldOfViewDegreesDefault", Type = "number", Nilable = false }, + { Name = "fieldOfViewDegreesPlayerMin", Type = "number", Nilable = false }, + { Name = "fieldOfViewDegreesPlayerMax", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Camera); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua b/APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua new file mode 100644 index 0000000..06f8bb8 --- /dev/null +++ b/APIDocumentation/Documentation/CharacterCustomizationSharedDocumentation.lua @@ -0,0 +1,116 @@ +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 new file mode 100644 index 0000000..8985871 --- /dev/null +++ b/APIDocumentation/Documentation/ChatBubblesDocumentation.lua @@ -0,0 +1,34 @@ +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 new file mode 100644 index 0000000..81bc9f0 --- /dev/null +++ b/APIDocumentation/Documentation/ChatConstantsDocumentation.lua @@ -0,0 +1,156 @@ +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/ChatInfoDocumentation.lua b/APIDocumentation/Documentation/ChatInfoDocumentation.lua new file mode 100644 index 0000000..277aab1 --- /dev/null +++ b/APIDocumentation/Documentation/ChatInfoDocumentation.lua @@ -0,0 +1,2158 @@ +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 new file mode 100644 index 0000000..3797733 --- /dev/null +++ b/APIDocumentation/Documentation/CinematicDocumentation.lua @@ -0,0 +1,53 @@ +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/ClassTrialDocumentation.lua b/APIDocumentation/Documentation/ClassTrialDocumentation.lua new file mode 100644 index 0000000..1b3cf36 --- /dev/null +++ b/APIDocumentation/Documentation/ClassTrialDocumentation.lua @@ -0,0 +1,30 @@ +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/ClientDocumentation.lua b/APIDocumentation/Documentation/ClientDocumentation.lua new file mode 100644 index 0000000..566de27 --- /dev/null +++ b/APIDocumentation/Documentation/ClientDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..178573e --- /dev/null +++ b/APIDocumentation/Documentation/ClientSceneDocumentation.lua @@ -0,0 +1,46 @@ +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 new file mode 100644 index 0000000..86e3fbd --- /dev/null +++ b/APIDocumentation/Documentation/ClubDocumentation.lua @@ -0,0 +1,1634 @@ +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 new file mode 100644 index 0000000..75a2987 --- /dev/null +++ b/APIDocumentation/Documentation/ClubSharedDocumentation.lua @@ -0,0 +1,8 @@ +local ClubShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ClubShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ColorDocumentation.lua b/APIDocumentation/Documentation/ColorDocumentation.lua new file mode 100644 index 0000000..85a87d5 --- /dev/null +++ b/APIDocumentation/Documentation/ColorDocumentation.lua @@ -0,0 +1,8 @@ +local Color = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Color); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CombatLogDocumentation.lua b/APIDocumentation/Documentation/CombatLogDocumentation.lua new file mode 100644 index 0000000..10a726e --- /dev/null +++ b/APIDocumentation/Documentation/CombatLogDocumentation.lua @@ -0,0 +1,39 @@ +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/CommentatorFrameDocumentation.lua b/APIDocumentation/Documentation/CommentatorFrameDocumentation.lua new file mode 100644 index 0000000..ac38947 --- /dev/null +++ b/APIDocumentation/Documentation/CommentatorFrameDocumentation.lua @@ -0,0 +1,1569 @@ +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 new file mode 100644 index 0000000..409f5e3 --- /dev/null +++ b/APIDocumentation/Documentation/CommentatorSharedDocumentation.lua @@ -0,0 +1,23 @@ +local CommentatorShared = +{ + Tables = + { + { + Name = "TrackedSpellCategory", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "TrackedSpellCategory", EnumValue = 0 }, + { Name = "Offensive", Type = "TrackedSpellCategory", EnumValue = 1 }, + { Name = "Defensive", Type = "TrackedSpellCategory", EnumValue = 2 }, + { Name = "Debuff", Type = "TrackedSpellCategory", EnumValue = 3 }, + { Name = "RacialAbility", Type = "TrackedSpellCategory", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(CommentatorShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua b/APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua new file mode 100644 index 0000000..3692ae2 --- /dev/null +++ b/APIDocumentation/Documentation/CompactUnitFramesDocumentation.lua @@ -0,0 +1,25 @@ +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/ConfigurationWarningsDocumentation.lua b/APIDocumentation/Documentation/ConfigurationWarningsDocumentation.lua new file mode 100644 index 0000000..d4c2c45 --- /dev/null +++ b/APIDocumentation/Documentation/ConfigurationWarningsDocumentation.lua @@ -0,0 +1,89 @@ +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 new file mode 100644 index 0000000..4a2aa10 --- /dev/null +++ b/APIDocumentation/Documentation/ConsoleDocumentation.lua @@ -0,0 +1,202 @@ +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 new file mode 100644 index 0000000..6e03053 --- /dev/null +++ b/APIDocumentation/Documentation/ConsoleScriptCollectionDocumentation.lua @@ -0,0 +1,116 @@ +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 new file mode 100644 index 0000000..770e30a --- /dev/null +++ b/APIDocumentation/Documentation/ContainerDocumentation.lua @@ -0,0 +1,618 @@ +local Container = +{ + Name = "Container", + Type = "System", + Namespace = "C_Container", + + Functions = + { + { + Name = "ContainerIDToInventoryID", + Type = "Function", + + Arguments = + { + { Name = "containerID", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "inventoryID", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "ContainerRefundItemPurchase", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false, Default = false }, + }, + }, + { + Name = "GetBagName", + Type = "Function", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", 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 = "GetContainerFreeSlots", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "freeSlots", Type = "table", InnerType = "luaIndex", Nilable = false }, + }, + }, + { + Name = "GetContainerItemCooldown", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemDurability", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "durability", Type = "number", Nilable = false }, + { Name = "maxDurability", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemGems", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numGems", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemID", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "containerID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetContainerItemInfo", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "containerInfo", Type = "ContainerItemInfo", Nilable = false }, + }, + }, + { + Name = "GetContainerItemLink", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", 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 = "GetContainerItemPurchaseInfo", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "ItemPurchaseInfo", Nilable = false }, + }, + }, + { + Name = "GetContainerItemPurchaseItem", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "itemIndex", Type = "luaIndex", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "itemInfo", Type = "ItemPurchaseItem", Nilable = false }, + }, + }, + { + Name = "GetContainerItemQuestInfo", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "questInfo", Type = "ItemQuestInfo", Nilable = false }, + }, + }, + { + Name = "GetContainerNumFreeSlots", + Type = "Function", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numFreeSlots", Type = "number", Nilable = false }, + { Name = "bagFamily", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetContainerNumSlots", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + }, + + Returns = + { + { Name = "numSlots", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetInsertItemsLeftToRight", + Type = "Function", + + Returns = + { + { Name = "isEnabled", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemCooldown", + Type = "Function", + + Arguments = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "startTime", Type = "number", Nilable = false }, + { Name = "duration", Type = "number", Nilable = false }, + { Name = "enable", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsBagSlotFlagEnabledOnOtherBankBags", + Type = "Function", + + Arguments = + { + { Name = "bagIndex", Type = "BagIndex", Nilable = false }, + { Name = "flagIndex", Type = "luaIndex", 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", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "SetBagPortraitTexture", + Type = "Function", + + Arguments = + { + { Name = "texture", Type = "SimpleTexture", Nilable = false }, + { Name = "bagIndex", Type = "BagIndex", 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", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + }, + + Returns = + { + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SplitContainerItem", + Type = "Function", + + Arguments = + { + { Name = "containerIndex", Type = "BagIndex", Nilable = false }, + { Name = "slotIndex", Type = "luaIndex", Nilable = false }, + { Name = "amount", Type = "number", Nilable = false }, + }, + }, + { + Name = "UseContainerItem", + Type = "Function", + + 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 }, + }, + }, + }, + + Events = + { + { + Name = "BagClosed", + Type = "Event", + LiteralName = "BAG_CLOSED", + Payload = + { + { Name = "bagID", Type = "BagIndex", Nilable = false }, + }, + }, + { + Name = "BagContainerUpdate", + Type = "Event", + LiteralName = "BAG_CONTAINER_UPDATE", + }, + { + Name = "BagNewItemsUpdated", + Type = "Event", + LiteralName = "BAG_NEW_ITEMS_UPDATED", + }, + { + Name = "BagOpen", + Type = "Event", + LiteralName = "BAG_OPEN", + Payload = + { + { 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 = "BagUpdateCooldown", + 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 diff --git a/APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua b/APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua new file mode 100644 index 0000000..644e109 --- /dev/null +++ b/APIDocumentation/Documentation/ContentTrackingTypesDocumentation.lua @@ -0,0 +1,110 @@ +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 new file mode 100644 index 0000000..6782e42 --- /dev/null +++ b/APIDocumentation/Documentation/ContributionCollectorDocumentation.lua @@ -0,0 +1,75 @@ +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 new file mode 100644 index 0000000..131ce94 --- /dev/null +++ b/APIDocumentation/Documentation/CooldownFrameAPIDocumentation.lua @@ -0,0 +1,359 @@ +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 new file mode 100644 index 0000000..0f15e33 --- /dev/null +++ b/APIDocumentation/Documentation/CraftInfoDocumentation.lua @@ -0,0 +1,35 @@ +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 new file mode 100644 index 0000000..2ee3594 --- /dev/null +++ b/APIDocumentation/Documentation/CreatureInfoDocumentation.lua @@ -0,0 +1,91 @@ +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 new file mode 100644 index 0000000..d0ff4c4 --- /dev/null +++ b/APIDocumentation/Documentation/CurrencyConstantsDocumentation.lua @@ -0,0 +1,131 @@ +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 new file mode 100644 index 0000000..5c714d4 --- /dev/null +++ b/APIDocumentation/Documentation/CurrencyConstants_ClassicDocumentation.lua @@ -0,0 +1,83 @@ +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/CurrencyInfoDocumentation.lua b/APIDocumentation/Documentation/CurrencyInfoDocumentation.lua new file mode 100644 index 0000000..0c3db02 --- /dev/null +++ b/APIDocumentation/Documentation/CurrencyInfoDocumentation.lua @@ -0,0 +1,148 @@ +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 new file mode 100644 index 0000000..c6910a6 --- /dev/null +++ b/APIDocumentation/Documentation/CursorConstDocumentation.lua @@ -0,0 +1,96 @@ +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 new file mode 100644 index 0000000..b6db8bf --- /dev/null +++ b/APIDocumentation/Documentation/CursorDocumentation.lua @@ -0,0 +1,96 @@ +local Cursor = +{ + Name = "Cursor", + Type = "System", + Namespace = "C_Cursor", + + Functions = + { + { + Name = "GetCursorItem", + Type = "Function", + + Returns = + { + { Name = "item", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "BattlePetCursorClear", + 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", + }, + }, + + 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 diff --git a/APIDocumentation/Documentation/DamageConstantsDocumentation.lua b/APIDocumentation/Documentation/DamageConstantsDocumentation.lua new file mode 100644 index 0000000..6733a9c --- /dev/null +++ b/APIDocumentation/Documentation/DamageConstantsDocumentation.lua @@ -0,0 +1,105 @@ +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 new file mode 100644 index 0000000..cb5f262 --- /dev/null +++ b/APIDocumentation/Documentation/DateAndTimeDocumentation.lua @@ -0,0 +1,115 @@ +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 new file mode 100644 index 0000000..07c7acd --- /dev/null +++ b/APIDocumentation/Documentation/DeathInfoDocumentation.lua @@ -0,0 +1,206 @@ +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/DuelInfoDocumentation.lua b/APIDocumentation/Documentation/DuelInfoDocumentation.lua new file mode 100644 index 0000000..d9264f6 --- /dev/null +++ b/APIDocumentation/Documentation/DuelInfoDocumentation.lua @@ -0,0 +1,44 @@ +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 new file mode 100644 index 0000000..f2de8c7 --- /dev/null +++ b/APIDocumentation/Documentation/EditModeManagerDocumentation.lua @@ -0,0 +1,181 @@ +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 new file mode 100644 index 0000000..50ed9b0 --- /dev/null +++ b/APIDocumentation/Documentation/EditModeManagerSharedDocumentation.lua @@ -0,0 +1,507 @@ +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 new file mode 100644 index 0000000..160a521 --- /dev/null +++ b/APIDocumentation/Documentation/EncounterInfoDocumentation.lua @@ -0,0 +1,90 @@ +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 new file mode 100644 index 0000000..66283ad --- /dev/null +++ b/APIDocumentation/Documentation/EncounterJournalConstantsDocumentation.lua @@ -0,0 +1,126 @@ +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 new file mode 100644 index 0000000..2ccb3ba --- /dev/null +++ b/APIDocumentation/Documentation/EquipmentManagerDocumentation.lua @@ -0,0 +1,310 @@ +local EquipmentManager = +{ + Name = "EquipmentSet", + Type = "System", + Namespace = "C_EquipmentSet", + + 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 = "DeleteEquipmentSet", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "EquipmentSetContainsLockedItems", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", 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 = "GetEquipmentSetInfo", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "name", Type = "string", Nilable = false }, + { Name = "iconFileID", Type = "number", Nilable = false }, + { Name = "setID", Type = "number", Nilable = false }, + { Name = "isEquipped", Type = "bool", Nilable = false }, + { Name = "numItems", Type = "number", Nilable = false }, + { Name = "numEquipped", Type = "number", Nilable = false }, + { Name = "numInInventory", Type = "number", Nilable = false }, + { Name = "numLost", Type = "number", Nilable = false }, + { Name = "numIgnored", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetIgnoredSlots", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "slotIgnored", Type = "table", InnerType = "bool", Nilable = false }, + }, + }, + { + Name = "GetItemIDs", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "itemIDs", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetItemLocations", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "locations", Type = "table", InnerType = "number", Nilable = false }, + }, + }, + { + Name = "GetNumEquipmentSets", + Type = "Function", + + 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 = "PickupEquipmentSet", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + }, + }, + { + Name = "SaveEquipmentSet", + Type = "Function", + + Arguments = + { + { Name = "equipmentSetID", Type = "number", Nilable = false }, + { Name = "icon", Type = "cstring", Nilable = true }, + }, + }, + { + 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 }, + }, + }, + }, + + Events = + { + { + Name = "EquipmentSetsChanged", + Type = "Event", + LiteralName = "EQUIPMENT_SETS_CHANGED", + }, + { + 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 = + { + }, +}; + +APIDocumentation:AddDocumentationTable(EquipmentManager); \ No newline at end of file diff --git a/APIDocumentation/Documentation/EventUtilsDocumentation.lua b/APIDocumentation/Documentation/EventUtilsDocumentation.lua new file mode 100644 index 0000000..2a80c35 --- /dev/null +++ b/APIDocumentation/Documentation/EventUtilsDocumentation.lua @@ -0,0 +1,43 @@ +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 new file mode 100644 index 0000000..1eff160 --- /dev/null +++ b/APIDocumentation/Documentation/ExpansionDocumentation.lua @@ -0,0 +1,196 @@ +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 new file mode 100644 index 0000000..8ba748a --- /dev/null +++ b/APIDocumentation/Documentation/ExpansionLandingPageConstantsDocumentation.lua @@ -0,0 +1,20 @@ +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/FogOfWarDocumentation.lua b/APIDocumentation/Documentation/FogOfWarDocumentation.lua new file mode 100644 index 0000000..8143b60 --- /dev/null +++ b/APIDocumentation/Documentation/FogOfWarDocumentation.lua @@ -0,0 +1,31 @@ +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 new file mode 100644 index 0000000..697b6bd --- /dev/null +++ b/APIDocumentation/Documentation/FontDocumentation.lua @@ -0,0 +1,40 @@ +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 new file mode 100644 index 0000000..eccb47d --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPICharacterModelBaseDocumentation.lua @@ -0,0 +1,265 @@ +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 new file mode 100644 index 0000000..d66ceae --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPICinematicModelDocumentation.lua @@ -0,0 +1,185 @@ +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 new file mode 100644 index 0000000..b41eea7 --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPICooldownDocumentation.lua @@ -0,0 +1,359 @@ +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 new file mode 100644 index 0000000..ba4ab44 --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPIDressUpModelDocumentation.lua @@ -0,0 +1,99 @@ +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 new file mode 100644 index 0000000..03484c0 --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPIFogOfWarFrameDocumentation.lua @@ -0,0 +1,153 @@ +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 new file mode 100644 index 0000000..04fe047 --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPIModelSceneFrameDocumentation.lua @@ -0,0 +1,558 @@ +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 new file mode 100644 index 0000000..024d90c --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPIModelSceneFrameSharedDocumentation.lua @@ -0,0 +1,20 @@ +local FrameAPIModelSceneFrameShared = +{ + Tables = + { + { + Name = "ModelLightType", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Directional", Type = "ModelLightType", EnumValue = 0 }, + { Name = "Point", Type = "ModelLightType", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(FrameAPIModelSceneFrameShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua b/APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua new file mode 100644 index 0000000..4c7a590 --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPISimpleCheckoutDocumentation.lua @@ -0,0 +1,90 @@ +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 new file mode 100644 index 0000000..0bd5176 --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPITabardModelBaseDocumentation.lua @@ -0,0 +1,76 @@ +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 new file mode 100644 index 0000000..640b9aa --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPITabardModelDocumentation.lua @@ -0,0 +1,71 @@ +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 new file mode 100644 index 0000000..1c2386b --- /dev/null +++ b/APIDocumentation/Documentation/FrameAPIUnitPositionFrameDocumentation.lua @@ -0,0 +1,153 @@ +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 new file mode 100644 index 0000000..7334b1b --- /dev/null +++ b/APIDocumentation/Documentation/FrameScriptDocumentation.lua @@ -0,0 +1,33 @@ +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 new file mode 100644 index 0000000..c99d82b --- /dev/null +++ b/APIDocumentation/Documentation/FriendListDocumentation.lua @@ -0,0 +1,530 @@ +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 new file mode 100644 index 0000000..f1a6fa4 --- /dev/null +++ b/APIDocumentation/Documentation/GARRISON_FOLLOWER_TYPEConstantsDocumentation.lua @@ -0,0 +1,23 @@ +local GARRISON_FOLLOWER_TYPEConstants = +{ + Tables = + { + { + Name = "GarrisonFollowerType", + Type = "Enumeration", + NumValues = 5, + MinValue = 1, + MaxValue = 123, + Fields = + { + { Name = "FollowerType_6_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 1 }, + { Name = "FollowerType_6_0_Boat", Type = "GarrisonFollowerType", EnumValue = 2 }, + { Name = "FollowerType_7_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 4 }, + { Name = "FollowerType_8_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 22 }, + { Name = "FollowerType_9_0_GarrisonFollower", Type = "GarrisonFollowerType", EnumValue = 123 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GARRISON_FOLLOWER_TYPEConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua b/APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua new file mode 100644 index 0000000..61bd3ed --- /dev/null +++ b/APIDocumentation/Documentation/GARRISON_TYPEConstantsDocumentation.lua @@ -0,0 +1,22 @@ +local GARRISON_TYPEConstants = +{ + Tables = + { + { + Name = "GarrisonType", + Type = "Enumeration", + NumValues = 4, + MinValue = 2, + MaxValue = 111, + Fields = + { + { Name = "Type_6_0_Garrison", Type = "GarrisonType", EnumValue = 2 }, + { Name = "Type_7_0_Garrison", Type = "GarrisonType", EnumValue = 3 }, + { Name = "Type_8_0_Garrison", Type = "GarrisonType", EnumValue = 9 }, + { Name = "Type_9_0_Garrison", Type = "GarrisonType", EnumValue = 111 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GARRISON_TYPEConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GMTicketInfoDocumentation.lua b/APIDocumentation/Documentation/GMTicketInfoDocumentation.lua new file mode 100644 index 0000000..7ff87fe --- /dev/null +++ b/APIDocumentation/Documentation/GMTicketInfoDocumentation.lua @@ -0,0 +1,78 @@ +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 new file mode 100644 index 0000000..7fb5d54 --- /dev/null +++ b/APIDocumentation/Documentation/GamePadConstDocumentation.lua @@ -0,0 +1,24 @@ +local GamePadConst = +{ + Tables = + { + { + Name = "GamePadPowerLevel", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Critical", Type = "GamePadPowerLevel", EnumValue = 0 }, + { Name = "Low", Type = "GamePadPowerLevel", EnumValue = 1 }, + { Name = "Medium", Type = "GamePadPowerLevel", EnumValue = 2 }, + { Name = "High", Type = "GamePadPowerLevel", EnumValue = 3 }, + { Name = "Wired", Type = "GamePadPowerLevel", EnumValue = 4 }, + { Name = "Unknown", Type = "GamePadPowerLevel", EnumValue = 5 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(GamePadConst); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GamePadDocumentation.lua b/APIDocumentation/Documentation/GamePadDocumentation.lua new file mode 100644 index 0000000..f9c534c --- /dev/null +++ b/APIDocumentation/Documentation/GamePadDocumentation.lua @@ -0,0 +1,411 @@ +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 new file mode 100644 index 0000000..ece34c4 --- /dev/null +++ b/APIDocumentation/Documentation/GameRulesDocumentation.lua @@ -0,0 +1,20 @@ +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 new file mode 100644 index 0000000..db8d80f --- /dev/null +++ b/APIDocumentation/Documentation/GarrisonConstantsDocumentation.lua @@ -0,0 +1,365 @@ +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 new file mode 100644 index 0000000..fd5ca63 --- /dev/null +++ b/APIDocumentation/Documentation/GlueDocumentation.lua @@ -0,0 +1,19 @@ +local Glue = +{ + Name = "Glue", + Type = "System", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Glue); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GlyphInfoDocumentation.lua b/APIDocumentation/Documentation/GlyphInfoDocumentation.lua new file mode 100644 index 0000000..4b1c202 --- /dev/null +++ b/APIDocumentation/Documentation/GlyphInfoDocumentation.lua @@ -0,0 +1,70 @@ +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/GossipConstantsDocumentation.lua b/APIDocumentation/Documentation/GossipConstantsDocumentation.lua new file mode 100644 index 0000000..789dfee --- /dev/null +++ b/APIDocumentation/Documentation/GossipConstantsDocumentation.lua @@ -0,0 +1,95 @@ +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 new file mode 100644 index 0000000..5ffd07b --- /dev/null +++ b/APIDocumentation/Documentation/GossipInfoDocumentation.lua @@ -0,0 +1,328 @@ +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 new file mode 100644 index 0000000..8419449 --- /dev/null +++ b/APIDocumentation/Documentation/GuildBankDocumentation.lua @@ -0,0 +1,78 @@ +local GuildBank = +{ + Name = "GuildBank", + Type = "System", + Namespace = "C_GuildBank", + + Functions = + { + }, + + 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", + LiteralName = "GUILDBANKBAGSLOTS_CHANGED", + }, + { + Name = "GuildbankframeClosed", + Type = "Event", + LiteralName = "GUILDBANKFRAME_CLOSED", + }, + { + Name = "GuildbankframeOpened", + Type = "Event", + LiteralName = "GUILDBANKFRAME_OPENED", + }, + { + Name = "GuildbanklogUpdate", + Type = "Event", + LiteralName = "GUILDBANKLOG_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(GuildBank); \ No newline at end of file diff --git a/APIDocumentation/Documentation/GuildInfoDocumentation.lua b/APIDocumentation/Documentation/GuildInfoDocumentation.lua new file mode 100644 index 0000000..17a05a3 --- /dev/null +++ b/APIDocumentation/Documentation/GuildInfoDocumentation.lua @@ -0,0 +1,314 @@ +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 new file mode 100644 index 0000000..1dac70c --- /dev/null +++ b/APIDocumentation/Documentation/GuildInfoSharedDocumentation.lua @@ -0,0 +1,20 @@ +local GuildInfoShared = +{ + Tables = + { + { + Name = "GuildTabardInfo", + Type = "Structure", + Fields = + { + { Name = "backgroundColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "borderColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "emblemColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = false }, + { Name = "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 new file mode 100644 index 0000000..fd22f36 --- /dev/null +++ b/APIDocumentation/Documentation/HeirloomInfoDocumentation.lua @@ -0,0 +1,40 @@ +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/InputConstantsDocumentation.lua b/APIDocumentation/Documentation/InputConstantsDocumentation.lua new file mode 100644 index 0000000..f0d36b2 --- /dev/null +++ b/APIDocumentation/Documentation/InputConstantsDocumentation.lua @@ -0,0 +1,22 @@ +local InputConstants = +{ + Tables = + { + { + Name = "InputContext", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "InputContext", EnumValue = 0 }, + { Name = "Keyboard", Type = "InputContext", EnumValue = 1 }, + { Name = "Mouse", Type = "InputContext", EnumValue = 2 }, + { Name = "GamePad", Type = "InputContext", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(InputConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/InputDocumentation.lua b/APIDocumentation/Documentation/InputDocumentation.lua new file mode 100644 index 0000000..2a073d8 --- /dev/null +++ b/APIDocumentation/Documentation/InputDocumentation.lua @@ -0,0 +1,19 @@ +local Input = +{ + Name = "Input", + Type = "System", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Input); \ No newline at end of file diff --git a/APIDocumentation/Documentation/InstanceEncounterDocumentation.lua b/APIDocumentation/Documentation/InstanceEncounterDocumentation.lua new file mode 100644 index 0000000..a21cea1 --- /dev/null +++ b/APIDocumentation/Documentation/InstanceEncounterDocumentation.lua @@ -0,0 +1,63 @@ +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/ItemConstantsDocumentation.lua b/APIDocumentation/Documentation/ItemConstantsDocumentation.lua new file mode 100644 index 0000000..7cd93c4 --- /dev/null +++ b/APIDocumentation/Documentation/ItemConstantsDocumentation.lua @@ -0,0 +1,427 @@ +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 new file mode 100644 index 0000000..dc51ba9 --- /dev/null +++ b/APIDocumentation/Documentation/ItemConstants_ClassicDocumentation.lua @@ -0,0 +1,27 @@ +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 new file mode 100644 index 0000000..bba63ee --- /dev/null +++ b/APIDocumentation/Documentation/ItemDocumentation.lua @@ -0,0 +1,482 @@ +local Item = +{ + Name = "Item", + Type = "System", + Namespace = "C_Item", + + Functions = + { + { + Name = "DoesItemExist", + Type = "Function", + + Arguments = + { + { Name = "emptiableItemLocation", Type = "EmptiableItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "DoesItemExistByID", + Type = "Function", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "GetCurrentItemLevel", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "currentItemLevel", Type = "number", Nilable = true }, + }, + }, + { + Name = "GetItemGUID", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "GetItemID", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetItemIcon", + Type = "Function", + + 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 = "itemLink", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemMaxStackSize", + 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 = "itemName", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemNameByID", + Type = "Function", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemName", Type = "string", Nilable = true }, + }, + }, + { + Name = "GetItemQuality", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "itemQuality", Type = "ItemQuality", Nilable = true }, + }, + }, + { + Name = "GetItemQualityByID", + Type = "Function", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "itemQuality", Type = "ItemQuality", Nilable = true }, + }, + }, + { + Name = "GetStackCount", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "stackCount", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsBound", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isBound", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemDataCached", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isCached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsItemDataCachedByID", + Type = "Function", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + + Returns = + { + { Name = "isCached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsLocked", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + + Returns = + { + { Name = "isLocked", Type = "bool", Nilable = false }, + }, + }, + { + Name = "LockItem", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "LockItemByGUID", + Type = "Function", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + { + Name = "RequestLoadItemData", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "RequestLoadItemDataByID", + Type = "Function", + + Arguments = + { + { Name = "itemInfo", Type = "ItemInfo", Nilable = false }, + }, + }, + { + Name = "UnlockItem", + Type = "Function", + + Arguments = + { + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + { + Name = "UnlockItemByGUID", + Type = "Function", + + Arguments = + { + { Name = "itemGUID", Type = "WOWGUID", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "ActionWillBindItem", + Type = "Event", + LiteralName = "ACTION_WILL_BIND_ITEM", + }, + { + Name = "BindEnchant", + Type = "Event", + LiteralName = "BIND_ENCHANT", + }, + { + Name = "CharacterItemFixupNotification", + Type = "Event", + LiteralName = "CHARACTER_ITEM_FIXUP_NOTIFICATION", + Payload = + { + { Name = "fixupVersion", 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 = "EndBoundTradeable", + Type = "Event", + LiteralName = "END_BOUND_TRADEABLE", + Payload = + { + { Name = "reason", Type = "cstring", Nilable = false }, + }, + }, + { + Name = "GetItemInfoReceived", + Type = "Event", + LiteralName = "GET_ITEM_INFO_RECEIVED", + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "ItemDataLoadResult", + Type = "Event", + LiteralName = "ITEM_DATA_LOAD_RESULT", + Payload = + { + { Name = "itemID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + { + Name = "MerchantConfirmTradeTimerRemoval", + 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", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Item); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua b/APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua new file mode 100644 index 0000000..6caf9dc --- /dev/null +++ b/APIDocumentation/Documentation/ItemLocationSharedDocumentation.lua @@ -0,0 +1,8 @@ +local ItemLocationShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ItemLocationShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemSharedDocumentation.lua b/APIDocumentation/Documentation/ItemSharedDocumentation.lua new file mode 100644 index 0000000..e77ddde --- /dev/null +++ b/APIDocumentation/Documentation/ItemSharedDocumentation.lua @@ -0,0 +1,8 @@ +local ItemShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ItemShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua b/APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua new file mode 100644 index 0000000..a4b63a2 --- /dev/null +++ b/APIDocumentation/Documentation/ItemSocketInfoDocumentation.lua @@ -0,0 +1,54 @@ +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 new file mode 100644 index 0000000..67f4911 --- /dev/null +++ b/APIDocumentation/Documentation/ItemTextDocumentation.lua @@ -0,0 +1,44 @@ +local ItemText = +{ + Name = "ItemText", + Type = "System", + Namespace = "C_ItemText", + + Functions = + { + }, + + Events = + { + { + Name = "ItemTextBegin", + Type = "Event", + LiteralName = "ITEM_TEXT_BEGIN", + }, + { + Name = "ItemTextClosed", + Type = "Event", + LiteralName = "ITEM_TEXT_CLOSED", + }, + { + Name = "ItemTextReady", + Type = "Event", + LiteralName = "ITEM_TEXT_READY", + }, + { + Name = "ItemTextTranslation", + Type = "Event", + LiteralName = "ITEM_TEXT_TRANSLATION", + Payload = + { + { Name = "delay", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ItemText); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ItemUpgradeDocumentation.lua b/APIDocumentation/Documentation/ItemUpgradeDocumentation.lua new file mode 100644 index 0000000..df6b1f8 --- /dev/null +++ b/APIDocumentation/Documentation/ItemUpgradeDocumentation.lua @@ -0,0 +1,39 @@ +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 new file mode 100644 index 0000000..78a5112 --- /dev/null +++ b/APIDocumentation/Documentation/KeyBindingsDocumentation.lua @@ -0,0 +1,88 @@ +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/KnowledgeBaseDocumentation.lua b/APIDocumentation/Documentation/KnowledgeBaseDocumentation.lua new file mode 100644 index 0000000..0ee5985 --- /dev/null +++ b/APIDocumentation/Documentation/KnowledgeBaseDocumentation.lua @@ -0,0 +1,60 @@ +local KnowledgeBase = +{ + Name = "KnowledgeBase", + Type = "System", + Namespace = "C_KnowledgeBase", + + Functions = + { + }, + + Events = + { + { + Name = "KnowledgeBaseArticleLoadFailure", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE", + }, + { + Name = "KnowledgeBaseArticleLoadSuccess", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS", + }, + { + Name = "KnowledgeBaseQueryLoadFailure", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_QUERY_LOAD_FAILURE", + }, + { + Name = "KnowledgeBaseQueryLoadSuccess", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS", + }, + { + Name = "KnowledgeBaseServerMessage", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_SERVER_MESSAGE", + }, + { + Name = "KnowledgeBaseSetupLoadFailure", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_SETUP_LOAD_FAILURE", + }, + { + Name = "KnowledgeBaseSetupLoadSuccess", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS", + }, + { + Name = "KnowledgeBaseSystemMotdUpdated", + Type = "Event", + LiteralName = "KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(KnowledgeBase); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LFGConstantsDocumentation.lua b/APIDocumentation/Documentation/LFGConstantsDocumentation.lua new file mode 100644 index 0000000..4141bcc --- /dev/null +++ b/APIDocumentation/Documentation/LFGConstantsDocumentation.lua @@ -0,0 +1,30 @@ +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 new file mode 100644 index 0000000..d4b5aff --- /dev/null +++ b/APIDocumentation/Documentation/LFGInfoDocumentation.lua @@ -0,0 +1,234 @@ +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 new file mode 100644 index 0000000..a25adc4 --- /dev/null +++ b/APIDocumentation/Documentation/LFGListInfoDocumentation.lua @@ -0,0 +1,397 @@ +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 new file mode 100644 index 0000000..ca6d570 --- /dev/null +++ b/APIDocumentation/Documentation/LevelConstantsDocumentation.lua @@ -0,0 +1,17 @@ +local LevelConstants = +{ + Tables = + { + { + Name = "LevelConstsExposed", + Type = "Constants", + Values = + { + { Name = "MIN_RES_SICKNESS_LEVEL", Type = "number", Value = 10 }, + { Name = "MIN_ACHIEVEMENT_LEVEL", Type = "number", Value = 10 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(LevelConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LoadingScreenDocumentation.lua b/APIDocumentation/Documentation/LoadingScreenDocumentation.lua new file mode 100644 index 0000000..14afa7d --- /dev/null +++ b/APIDocumentation/Documentation/LoadingScreenDocumentation.lua @@ -0,0 +1,30 @@ +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 new file mode 100644 index 0000000..b9e6495 --- /dev/null +++ b/APIDocumentation/Documentation/LocaleDocumentation.lua @@ -0,0 +1,28 @@ +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/LocalizationDocumentation.lua b/APIDocumentation/Documentation/LocalizationDocumentation.lua new file mode 100644 index 0000000..11838cc --- /dev/null +++ b/APIDocumentation/Documentation/LocalizationDocumentation.lua @@ -0,0 +1,19 @@ +local Localization = +{ + Name = "Localization", + Type = "System", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Localization); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LootConstantsDocumentation.lua b/APIDocumentation/Documentation/LootConstantsDocumentation.lua new file mode 100644 index 0000000..7064aaf --- /dev/null +++ b/APIDocumentation/Documentation/LootConstantsDocumentation.lua @@ -0,0 +1,30 @@ +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 new file mode 100644 index 0000000..d4dad4c --- /dev/null +++ b/APIDocumentation/Documentation/LootDocumentation.lua @@ -0,0 +1,260 @@ +local Loot = +{ + Name = "Loot", + Type = "System", + Namespace = "C_Loot", + + Functions = + { + { + Name = "IsLegacyLootModeEnabled", + Type = "Function", + + Returns = + { + { Name = "isLegacyLootModeEnabled", 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", + LiteralName = "CANCEL_LOOT_ROLL", + Payload = + { + { Name = "rollID", Type = "number", Nilable = false }, + }, + }, + { + Name = "ConfirmLootRoll", + Type = "Event", + 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 = "LootBindConfirm", + Type = "Event", + LiteralName = "LOOT_BIND_CONFIRM", + Payload = + { + { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "LootClosed", + 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", + LiteralName = "LOOT_OPENED", + Payload = + { + { 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", + Type = "Event", + LiteralName = "LOOT_SLOT_CLEARED", + Payload = + { + { Name = "lootSlot", Type = "luaIndex", Nilable = false }, + }, + }, + { + Name = "OpenMasterLootList", + 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 = "TrialCapReachedMoney", + Type = "Event", + LiteralName = "TRIAL_CAP_REACHED_MONEY", + }, + { + Name = "UpdateMasterLootList", + Type = "Event", + LiteralName = "UPDATE_MASTER_LOOT_LIST", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Loot); \ No newline at end of file diff --git a/APIDocumentation/Documentation/LossOfControlDocumentation.lua b/APIDocumentation/Documentation/LossOfControlDocumentation.lua new file mode 100644 index 0000000..9bd4ef4 --- /dev/null +++ b/APIDocumentation/Documentation/LossOfControlDocumentation.lua @@ -0,0 +1,132 @@ +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/MailInfoDocumentation.lua b/APIDocumentation/Documentation/MailInfoDocumentation.lua new file mode 100644 index 0000000..26c7052 --- /dev/null +++ b/APIDocumentation/Documentation/MailInfoDocumentation.lua @@ -0,0 +1,125 @@ +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 new file mode 100644 index 0000000..6e235e6 --- /dev/null +++ b/APIDocumentation/Documentation/MapConstantsDocumentation.lua @@ -0,0 +1,82 @@ +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 new file mode 100644 index 0000000..8eea464 --- /dev/null +++ b/APIDocumentation/Documentation/MapDocumentation.lua @@ -0,0 +1,482 @@ +local Map = +{ + Name = "MapUI", + Type = "System", + Namespace = "C_Map", + + Functions = + { + { + Name = "GetAreaInfo", + Type = "Function", + + Arguments = + { + { 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", + Type = "Function", + + Returns = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapArtBackgroundAtlas", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "atlasName", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "GetMapArtHelpTextPosition", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "position", Type = "MapCanvasPosition", Nilable = false }, + }, + }, + { + Name = "GetMapArtID", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "uiMapArtID", Type = "number", Nilable = false }, + }, + }, + { + Name = "GetMapArtLayerTextures", + 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 = "GetMapInfo", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "info", Type = "UiMapDetails", Nilable = false }, + }, + }, + { + Name = "GetMapInfoAtPosition", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", Type = "number", Nilable = false }, + { Name = "ignoreZoneMapPositionData", Type = "bool", Nilable = true }, + }, + + Returns = + { + { Name = "info", Type = "UiMapDetails", Nilable = false }, + }, + }, + { + Name = "GetMapLevels", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "playerMinLevel", Type = "number", Nilable = false }, + { Name = "playerMaxLevel", Type = "number", Nilable = false }, + { Name = "petMinLevel", Type = "number", Nilable = false, Default = 0 }, + { Name = "petMaxLevel", Type = "number", Nilable = false, Default = 0 }, + }, + }, + { + Name = "GetMapLinksForMap", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "mapLinks", Type = "table", InnerType = "MapLinkInfo", Nilable = false }, + }, + }, + { + Name = "GetMapPosFromWorldPos", + 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 = "GetMapRectOnMap", + 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 = "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 }, + }, + + Returns = + { + { Name = "position", Type = "vector2", Mixin = "Vector2DMixin", Nilable = true }, + }, + }, + { + Name = "GetWorldPosFromMapPos", + Type = "Function", + + Arguments = + { + { Name = "uiMapID", Type = "number", Nilable = false }, + { Name = "mapPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + + Returns = + { + { Name = "continentID", Type = "number", Nilable = false }, + { Name = "worldPosition", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "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 = "textureX", Type = "number", Nilable = false }, + { Name = "textureY", Type = "number", Nilable = false }, + { Name = "scrollChildX", Type = "number", Nilable = false }, + { Name = "scrollChildY", Type = "number", Nilable = false }, + }, + }, + { + Name = "UiMapLayerInfo", + Type = "Structure", + Fields = + { + { Name = "layerWidth", Type = "number", Nilable = false }, + { Name = "layerHeight", Type = "number", Nilable = false }, + { Name = "tileWidth", Type = "number", Nilable = false }, + { Name = "tileHeight", Type = "number", Nilable = false }, + { Name = "minScale", Type = "number", Nilable = false }, + { Name = "maxScale", Type = "number", Nilable = false }, + { Name = "additionalZoomSteps", Type = "number", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(Map); \ No newline at end of file diff --git a/APIDocumentation/Documentation/MapExplorationDocumentation.lua b/APIDocumentation/Documentation/MapExplorationDocumentation.lua new file mode 100644 index 0000000..1b22bf4 --- /dev/null +++ b/APIDocumentation/Documentation/MapExplorationDocumentation.lua @@ -0,0 +1,80 @@ +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/MerchantFrameDocumentation.lua b/APIDocumentation/Documentation/MerchantFrameDocumentation.lua new file mode 100644 index 0000000..ba2681d --- /dev/null +++ b/APIDocumentation/Documentation/MerchantFrameDocumentation.lua @@ -0,0 +1,58 @@ +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/MinimapConstantsDocumentation.lua b/APIDocumentation/Documentation/MinimapConstantsDocumentation.lua new file mode 100644 index 0000000..b325630 --- /dev/null +++ b/APIDocumentation/Documentation/MinimapConstantsDocumentation.lua @@ -0,0 +1,40 @@ +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 new file mode 100644 index 0000000..ca07471 --- /dev/null +++ b/APIDocumentation/Documentation/MinimapDocumentation.lua @@ -0,0 +1,139 @@ +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 new file mode 100644 index 0000000..e38561b --- /dev/null +++ b/APIDocumentation/Documentation/MinimapFrameAPIDocumentation.lua @@ -0,0 +1,149 @@ +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 new file mode 100644 index 0000000..c30a462 --- /dev/null +++ b/APIDocumentation/Documentation/ModelSceneDocumentation.lua @@ -0,0 +1,8 @@ +local ModelScene = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ModelScene); \ No newline at end of file diff --git a/APIDocumentation/Documentation/MovieDocumentation.lua b/APIDocumentation/Documentation/MovieDocumentation.lua new file mode 100644 index 0000000..1cd074a --- /dev/null +++ b/APIDocumentation/Documentation/MovieDocumentation.lua @@ -0,0 +1,19 @@ +local Movie = +{ + Name = "Movie", + Type = "System", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Movie); \ No newline at end of file diff --git a/APIDocumentation/Documentation/NamePlateDocumentation.lua b/APIDocumentation/Documentation/NamePlateDocumentation.lua new file mode 100644 index 0000000..d8082ca --- /dev/null +++ b/APIDocumentation/Documentation/NamePlateDocumentation.lua @@ -0,0 +1,8 @@ +local NamePlate = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(NamePlate); \ No newline at end of file diff --git a/APIDocumentation/Documentation/NamePlateManagerDocumentation.lua b/APIDocumentation/Documentation/NamePlateManagerDocumentation.lua new file mode 100644 index 0000000..3dda698 --- /dev/null +++ b/APIDocumentation/Documentation/NamePlateManagerDocumentation.lua @@ -0,0 +1,74 @@ +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 new file mode 100644 index 0000000..5c6ac52 --- /dev/null +++ b/APIDocumentation/Documentation/NewItemsDocumentation.lua @@ -0,0 +1,49 @@ +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/OsDocumentation.lua b/APIDocumentation/Documentation/OsDocumentation.lua new file mode 100644 index 0000000..262b409 --- /dev/null +++ b/APIDocumentation/Documentation/OsDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..26bec2a --- /dev/null +++ b/APIDocumentation/Documentation/PVPMgrConstantsDocumentation.lua @@ -0,0 +1,8 @@ +local PVPMgrConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PVPMgrConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PaperDollInfoDocumentation.lua b/APIDocumentation/Documentation/PaperDollInfoDocumentation.lua new file mode 100644 index 0000000..34b7f82 --- /dev/null +++ b/APIDocumentation/Documentation/PaperDollInfoDocumentation.lua @@ -0,0 +1,229 @@ +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 new file mode 100644 index 0000000..0c82020 --- /dev/null +++ b/APIDocumentation/Documentation/ParentalControlsDocumentation.lua @@ -0,0 +1,19 @@ +local ParentalControls = +{ + Name = "ParentalControls", + Type = "System", + + Functions = + { + }, + + Events = + { + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ParentalControls); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PartyInfoDocumentation.lua b/APIDocumentation/Documentation/PartyInfoDocumentation.lua new file mode 100644 index 0000000..cce5322 --- /dev/null +++ b/APIDocumentation/Documentation/PartyInfoDocumentation.lua @@ -0,0 +1,240 @@ +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 new file mode 100644 index 0000000..eb835df --- /dev/null +++ b/APIDocumentation/Documentation/PartyPoseUIDocumentation.lua @@ -0,0 +1,46 @@ +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 new file mode 100644 index 0000000..474973a --- /dev/null +++ b/APIDocumentation/Documentation/PerksVendorConstantsDocumentation.lua @@ -0,0 +1,24 @@ +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 new file mode 100644 index 0000000..cec09b6 --- /dev/null +++ b/APIDocumentation/Documentation/PetBattleConstantsDocumentation.lua @@ -0,0 +1,354 @@ +local PetBattleConstants = +{ + Tables = + { + { + Name = "PetBattleQueueStatus", + Type = "Enumeration", + NumValues = 22, + MinValue = 0, + MaxValue = 21, + Fields = + { + { Name = "None", Type = "PetBattleQueueStatus", EnumValue = 0 }, + { Name = "Queued", Type = "PetBattleQueueStatus", EnumValue = 1 }, + { Name = "QueuedUpdate", Type = "PetBattleQueueStatus", EnumValue = 2 }, + { Name = "AlreadyQueued", Type = "PetBattleQueueStatus", EnumValue = 3 }, + { Name = "JoinFailed", Type = "PetBattleQueueStatus", EnumValue = 4 }, + { Name = "JoinFailedSlots", Type = "PetBattleQueueStatus", EnumValue = 5 }, + { Name = "JoinFailedJournalLock", Type = "PetBattleQueueStatus", EnumValue = 6 }, + { Name = "JoinFailedNeutral", Type = "PetBattleQueueStatus", EnumValue = 7 }, + { Name = "MatchAccepted", Type = "PetBattleQueueStatus", EnumValue = 8 }, + { Name = "MatchDeclined", Type = "PetBattleQueueStatus", EnumValue = 9 }, + { Name = "MatchOpponentDeclined", Type = "PetBattleQueueStatus", EnumValue = 10 }, + { Name = "ProposalTimedOut", Type = "PetBattleQueueStatus", EnumValue = 11 }, + { Name = "Removed", Type = "PetBattleQueueStatus", EnumValue = 12 }, + { Name = "RequeuedAfterInternalError", Type = "PetBattleQueueStatus", EnumValue = 13 }, + { Name = "RequeuedAfterOpponentRemoved", Type = "PetBattleQueueStatus", EnumValue = 14 }, + { Name = "Matchmaking", Type = "PetBattleQueueStatus", EnumValue = 15 }, + { Name = "LostConnection", Type = "PetBattleQueueStatus", EnumValue = 16 }, + { Name = "Shutdown", Type = "PetBattleQueueStatus", EnumValue = 17 }, + { Name = "Suspended", Type = "PetBattleQueueStatus", EnumValue = 18 }, + { Name = "Unsuspended", Type = "PetBattleQueueStatus", EnumValue = 19 }, + { Name = "InBattle", Type = "PetBattleQueueStatus", EnumValue = 20 }, + { Name = "NoBattlingHere", Type = "PetBattleQueueStatus", EnumValue = 21 }, + }, + }, + { + Name = "PetbattleAuraStateFlags", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 32, + Fields = + { + { Name = "None", Type = "PetbattleAuraStateFlags", EnumValue = 0 }, + { Name = "Infinite", Type = "PetbattleAuraStateFlags", EnumValue = 1 }, + { Name = "Canceled", Type = "PetbattleAuraStateFlags", EnumValue = 2 }, + { Name = "InitDisabled", Type = "PetbattleAuraStateFlags", EnumValue = 4 }, + { Name = "CountdownFirstRound", Type = "PetbattleAuraStateFlags", EnumValue = 8 }, + { Name = "JustApplied", Type = "PetbattleAuraStateFlags", EnumValue = 16 }, + { Name = "RemoveEventHandled", Type = "PetbattleAuraStateFlags", EnumValue = 32 }, + }, + }, + { + Name = "PetbattleCheatFlags", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "None", Type = "PetbattleCheatFlags", EnumValue = 0 }, + { Name = "AutoPlay", Type = "PetbattleCheatFlags", EnumValue = 1 }, + }, + }, + { + Name = "PetbattleEffectFlags", + Type = "Enumeration", + NumValues = 15, + MinValue = 0, + MaxValue = 8192, + Fields = + { + { Name = "None", Type = "PetbattleEffectFlags", EnumValue = 0 }, + { Name = "InvalidTarget", Type = "PetbattleEffectFlags", EnumValue = 1 }, + { Name = "Miss", Type = "PetbattleEffectFlags", EnumValue = 2 }, + { Name = "Crit", Type = "PetbattleEffectFlags", EnumValue = 4 }, + { Name = "Blocked", Type = "PetbattleEffectFlags", EnumValue = 8 }, + { Name = "Dodge", Type = "PetbattleEffectFlags", EnumValue = 16 }, + { Name = "Heal", Type = "PetbattleEffectFlags", EnumValue = 32 }, + { Name = "Unkillable", Type = "PetbattleEffectFlags", EnumValue = 64 }, + { Name = "Reflect", Type = "PetbattleEffectFlags", EnumValue = 128 }, + { Name = "Absorb", Type = "PetbattleEffectFlags", EnumValue = 256 }, + { Name = "Immune", Type = "PetbattleEffectFlags", EnumValue = 512 }, + { Name = "Strong", Type = "PetbattleEffectFlags", EnumValue = 1024 }, + { Name = "Weak", Type = "PetbattleEffectFlags", EnumValue = 2048 }, + { Name = "SuccessChain", Type = "PetbattleEffectFlags", EnumValue = 4096 }, + { Name = "AuraReapply", Type = "PetbattleEffectFlags", EnumValue = 8192 }, + }, + }, + { + Name = "PetbattleEffectType", + Type = "Enumeration", + NumValues = 18, + MinValue = 0, + MaxValue = 17, + Fields = + { + { Name = "SetHealth", Type = "PetbattleEffectType", EnumValue = 0 }, + { Name = "AuraApply", Type = "PetbattleEffectType", EnumValue = 1 }, + { Name = "AuraCancel", Type = "PetbattleEffectType", EnumValue = 2 }, + { Name = "AuraChange", Type = "PetbattleEffectType", EnumValue = 3 }, + { Name = "PetSwap", Type = "PetbattleEffectType", EnumValue = 4 }, + { Name = "StatusChange", Type = "PetbattleEffectType", EnumValue = 5 }, + { Name = "SetState", Type = "PetbattleEffectType", EnumValue = 6 }, + { Name = "SetMaxHealth", Type = "PetbattleEffectType", EnumValue = 7 }, + { Name = "SetSpeed", Type = "PetbattleEffectType", EnumValue = 8 }, + { Name = "SetPower", Type = "PetbattleEffectType", EnumValue = 9 }, + { Name = "TriggerAbility", Type = "PetbattleEffectType", EnumValue = 10 }, + { Name = "AbilityChange", Type = "PetbattleEffectType", EnumValue = 11 }, + { Name = "NpcEmote", Type = "PetbattleEffectType", EnumValue = 12 }, + { Name = "AuraProcessingBegin", Type = "PetbattleEffectType", EnumValue = 13 }, + { Name = "AuraProcessingEnd", Type = "PetbattleEffectType", EnumValue = 14 }, + { Name = "ReplacePet", Type = "PetbattleEffectType", EnumValue = 15 }, + { Name = "OverrideAbility", Type = "PetbattleEffectType", EnumValue = 16 }, + { Name = "WorldStateUpdate", Type = "PetbattleEffectType", EnumValue = 17 }, + }, + }, + { + Name = "PetbattleEnviros", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Pad0", Type = "PetbattleEnviros", EnumValue = 0 }, + { Name = "Pad1", Type = "PetbattleEnviros", EnumValue = 1 }, + { Name = "Weather", Type = "PetbattleEnviros", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleInputMoveMsgDebugFlag", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "PetbattleInputMoveMsgDebugFlag", EnumValue = 0 }, + { Name = "DontValidate", Type = "PetbattleInputMoveMsgDebugFlag", EnumValue = 1 }, + { Name = "EnemyCast", Type = "PetbattleInputMoveMsgDebugFlag", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleMoveType", + Type = "Enumeration", + NumValues = 6, + MinValue = 0, + MaxValue = 5, + Fields = + { + { Name = "Quit", Type = "PetbattleMoveType", EnumValue = 0 }, + { Name = "Ability", Type = "PetbattleMoveType", EnumValue = 1 }, + { Name = "Swap", Type = "PetbattleMoveType", EnumValue = 2 }, + { Name = "Trap", Type = "PetbattleMoveType", EnumValue = 3 }, + { Name = "FinalRoundOk", Type = "PetbattleMoveType", EnumValue = 4 }, + { Name = "Pass", Type = "PetbattleMoveType", EnumValue = 5 }, + }, + }, + { + Name = "PetbattlePboid", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "P0Pet_0", Type = "PetbattlePboid", EnumValue = 0 }, + { Name = "P0Pet_1", Type = "PetbattlePboid", EnumValue = 1 }, + { Name = "P0Pet_2", Type = "PetbattlePboid", EnumValue = 2 }, + { Name = "P1Pet_0", Type = "PetbattlePboid", EnumValue = 3 }, + { Name = "P1Pet_1", Type = "PetbattlePboid", EnumValue = 4 }, + { Name = "P1Pet_2", Type = "PetbattlePboid", EnumValue = 5 }, + { Name = "EnvPad_0", Type = "PetbattlePboid", EnumValue = 6 }, + { Name = "EnvPad_1", Type = "PetbattlePboid", EnumValue = 7 }, + { Name = "EnvWeather", Type = "PetbattlePboid", EnumValue = 8 }, + }, + }, + { + Name = "PetbattlePetStatus", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "FlagNone", Type = "PetbattlePetStatus", EnumValue = 0 }, + { Name = "FlagTrapped", Type = "PetbattlePetStatus", EnumValue = 1 }, + { Name = "Stunned", Type = "PetbattlePetStatus", EnumValue = 2 }, + { Name = "SwapOutLocked", Type = "PetbattlePetStatus", EnumValue = 4 }, + { Name = "SwapInLocked", Type = "PetbattlePetStatus", EnumValue = 8 }, + }, + }, + { + Name = "PetbattlePlayer", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Player_0", Type = "PetbattlePlayer", EnumValue = 0 }, + { Name = "Player_1", Type = "PetbattlePlayer", EnumValue = 1 }, + }, + }, + { + Name = "PetbattlePlayerInputFlags", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "None", Type = "PetbattlePlayerInputFlags", EnumValue = 0 }, + { Name = "TurnInProgress", Type = "PetbattlePlayerInputFlags", EnumValue = 1 }, + { Name = "AbilityLocked", Type = "PetbattlePlayerInputFlags", EnumValue = 2 }, + { Name = "SwapLocked", Type = "PetbattlePlayerInputFlags", EnumValue = 4 }, + { Name = "WaitingForPet", Type = "PetbattlePlayerInputFlags", EnumValue = 8 }, + }, + }, + { + Name = "PetbattleResult", + Type = "Enumeration", + NumValues = 24, + MinValue = 0, + MaxValue = 23, + Fields = + { + { Name = "FailUnknown", Type = "PetbattleResult", EnumValue = 0 }, + { Name = "FailNotHere", Type = "PetbattleResult", EnumValue = 1 }, + { Name = "FailNotHereOnTransport", Type = "PetbattleResult", EnumValue = 2 }, + { Name = "FailNotHereUnevenGround", Type = "PetbattleResult", EnumValue = 3 }, + { Name = "FailNotHereObstructed", Type = "PetbattleResult", EnumValue = 4 }, + { Name = "FailNotWhileInCombat", Type = "PetbattleResult", EnumValue = 5 }, + { Name = "FailNotWhileDead", Type = "PetbattleResult", EnumValue = 6 }, + { Name = "FailNotWhileFlying", Type = "PetbattleResult", EnumValue = 7 }, + { Name = "FailTargetInvalid", Type = "PetbattleResult", EnumValue = 8 }, + { Name = "FailTargetOutOfRange", Type = "PetbattleResult", EnumValue = 9 }, + { Name = "FailTargetNotCapturable", Type = "PetbattleResult", EnumValue = 10 }, + { Name = "FailNotATrainer", Type = "PetbattleResult", EnumValue = 11 }, + { Name = "FailDeclined", Type = "PetbattleResult", EnumValue = 12 }, + { Name = "FailInBattle", Type = "PetbattleResult", EnumValue = 13 }, + { Name = "FailInvalidLoadout", Type = "PetbattleResult", EnumValue = 14 }, + { Name = "FailInvalidLoadoutAllDead", Type = "PetbattleResult", EnumValue = 15 }, + { Name = "FailInvalidLoadoutNoneSlotted", Type = "PetbattleResult", EnumValue = 16 }, + { Name = "FailNoJournalLock", Type = "PetbattleResult", EnumValue = 17 }, + { Name = "FailWildPetTapped", Type = "PetbattleResult", EnumValue = 18 }, + { Name = "FailRestrictedAccount", Type = "PetbattleResult", EnumValue = 19 }, + { Name = "FailOpponentNotAvailable", Type = "PetbattleResult", EnumValue = 20 }, + { Name = "FailLogout", Type = "PetbattleResult", EnumValue = 21 }, + { Name = "FailDisconnect", Type = "PetbattleResult", EnumValue = 22 }, + { Name = "Success", Type = "PetbattleResult", EnumValue = 23 }, + }, + }, + { + Name = "PetbattleSlot", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Slot_0", Type = "PetbattleSlot", EnumValue = 0 }, + { Name = "Slot_1", Type = "PetbattleSlot", EnumValue = 1 }, + { Name = "Slot_2", Type = "PetbattleSlot", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleSlotAbility", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Ability_0", Type = "PetbattleSlotAbility", EnumValue = 0 }, + { Name = "Ability_1", Type = "PetbattleSlotAbility", EnumValue = 1 }, + { Name = "Ability_2", Type = "PetbattleSlotAbility", EnumValue = 2 }, + }, + }, + { + Name = "PetbattleSlotResult", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Success", Type = "PetbattleSlotResult", EnumValue = 0 }, + { Name = "SlotLocked", Type = "PetbattleSlotResult", EnumValue = 1 }, + { Name = "SlotEmpty", Type = "PetbattleSlotResult", EnumValue = 2 }, + { Name = "NoTracker", Type = "PetbattleSlotResult", EnumValue = 3 }, + { Name = "NoSpeciesRec", Type = "PetbattleSlotResult", EnumValue = 4 }, + { Name = "CantBattle", Type = "PetbattleSlotResult", EnumValue = 5 }, + { Name = "Revoked", Type = "PetbattleSlotResult", EnumValue = 6 }, + { Name = "Dead", Type = "PetbattleSlotResult", EnumValue = 7 }, + { Name = "NoPet", Type = "PetbattleSlotResult", EnumValue = 8 }, + }, + }, + { + Name = "PetbattleState", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "Created", Type = "PetbattleState", EnumValue = 0 }, + { Name = "WaitingPreBattle", Type = "PetbattleState", EnumValue = 1 }, + { Name = "RoundInProgress", Type = "PetbattleState", EnumValue = 2 }, + { Name = "WaitingForFrontPets", Type = "PetbattleState", EnumValue = 3 }, + { Name = "CreatedFailed", Type = "PetbattleState", EnumValue = 4 }, + { Name = "FinalRound", Type = "PetbattleState", EnumValue = 5 }, + { Name = "Finished", Type = "PetbattleState", EnumValue = 6 }, + }, + }, + { + Name = "PetbattleTrapstatus", + Type = "Enumeration", + NumValues = 9, + MinValue = 0, + MaxValue = 8, + Fields = + { + { Name = "Invalid", Type = "PetbattleTrapstatus", EnumValue = 0 }, + { Name = "CanTrap", Type = "PetbattleTrapstatus", EnumValue = 1 }, + { Name = "CantTrapNewbie", Type = "PetbattleTrapstatus", EnumValue = 2 }, + { Name = "CantTrapPetDead", Type = "PetbattleTrapstatus", EnumValue = 3 }, + { Name = "CantTrapPetHealth", Type = "PetbattleTrapstatus", EnumValue = 4 }, + { Name = "CantTrapNoRoomInJournal", Type = "PetbattleTrapstatus", EnumValue = 5 }, + { Name = "CantTrapPetNotCapturable", Type = "PetbattleTrapstatus", EnumValue = 6 }, + { Name = "CantTrapTrainerBattle", Type = "PetbattleTrapstatus", EnumValue = 7 }, + { Name = "CantTrapTwice", Type = "PetbattleTrapstatus", EnumValue = 8 }, + }, + }, + { + Name = "PetbattleType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "PvE", Type = "PetbattleType", EnumValue = 0 }, + { Name = "PvP", Type = "PetbattleType", EnumValue = 1 }, + { Name = "Lfpb", Type = "PetbattleType", EnumValue = 2 }, + { Name = "Npc", Type = "PetbattleType", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PetBattleConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PetInfoDocumentation.lua b/APIDocumentation/Documentation/PetInfoDocumentation.lua new file mode 100644 index 0000000..14b2f47 --- /dev/null +++ b/APIDocumentation/Documentation/PetInfoDocumentation.lua @@ -0,0 +1,100 @@ +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 new file mode 100644 index 0000000..c069596 --- /dev/null +++ b/APIDocumentation/Documentation/PetJournalInfoDocumentation.lua @@ -0,0 +1,39 @@ +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 new file mode 100644 index 0000000..d900a41 --- /dev/null +++ b/APIDocumentation/Documentation/PetScalingConstantsDocumentation.lua @@ -0,0 +1,8 @@ +local PetScalingConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(PetScalingConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PingConstantsDocumentation.lua b/APIDocumentation/Documentation/PingConstantsDocumentation.lua new file mode 100644 index 0000000..148a9cf --- /dev/null +++ b/APIDocumentation/Documentation/PingConstantsDocumentation.lua @@ -0,0 +1,22 @@ +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 new file mode 100644 index 0000000..554701d --- /dev/null +++ b/APIDocumentation/Documentation/PlatformDocumentation.lua @@ -0,0 +1,32 @@ +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 new file mode 100644 index 0000000..a003b95 --- /dev/null +++ b/APIDocumentation/Documentation/PlayerDocumentation.lua @@ -0,0 +1,8 @@ +local Player = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Player); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlayerInfoDocumentation.lua b/APIDocumentation/Documentation/PlayerInfoDocumentation.lua new file mode 100644 index 0000000..86ae92d --- /dev/null +++ b/APIDocumentation/Documentation/PlayerInfoDocumentation.lua @@ -0,0 +1,85 @@ +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 new file mode 100644 index 0000000..45ffffb --- /dev/null +++ b/APIDocumentation/Documentation/PlayerInfoSharedDocumentation.lua @@ -0,0 +1,31 @@ +local PlayerInfoShared = +{ + Tables = + { + { + Name = "CharacterAlternateFormData", + Type = "Structure", + Fields = + { + { Name = "raceID", Type = "number", Nilable = false }, + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "fileName", Type = "cstring", Nilable = false }, + { Name = "createScreenIconAtlas", Type = "textureAtlas", Nilable = false }, + }, + }, + { + Name = "PlayerInfoCharacterData", + Type = "Structure", + Fields = + { + { Name = "name", Type = "cstring", Nilable = false }, + { Name = "fileName", Type = "cstring", Nilable = false }, + { Name = "alternateFormRaceData", Type = "CharacterAlternateFormData", Nilable = true }, + { Name = "createScreenIconAtlas", Type = "textureAtlas", Nilable = false }, + { Name = "sex", Type = "UnitSex", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerInfoShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua b/APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua new file mode 100644 index 0000000..5a49924 --- /dev/null +++ b/APIDocumentation/Documentation/PlayerInteractionManagerConstantsDocumentation.lua @@ -0,0 +1,83 @@ +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 new file mode 100644 index 0000000..09716f1 --- /dev/null +++ b/APIDocumentation/Documentation/PlayerInteractionManagerDocumentation.lua @@ -0,0 +1,113 @@ +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 new file mode 100644 index 0000000..7da9c86 --- /dev/null +++ b/APIDocumentation/Documentation/PlayerLocationDocumentation.lua @@ -0,0 +1,120 @@ +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 new file mode 100644 index 0000000..bc91308 --- /dev/null +++ b/APIDocumentation/Documentation/PlayerMentorshipConstantsDocumentation.lua @@ -0,0 +1,34 @@ +local PlayerMentorshipConstants = +{ + Tables = + { + { + Name = "PlayerMentorshipApplicationResult", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Success", Type = "PlayerMentorshipApplicationResult", EnumValue = 0 }, + { Name = "AlreadyMentor", Type = "PlayerMentorshipApplicationResult", EnumValue = 1 }, + { Name = "Ineligible", Type = "PlayerMentorshipApplicationResult", EnumValue = 2 }, + }, + }, + { + Name = "PlayerMentorshipStatus", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "None", Type = "PlayerMentorshipStatus", EnumValue = 0 }, + { Name = "Newcomer", Type = "PlayerMentorshipStatus", EnumValue = 1 }, + { Name = "Mentor", Type = "PlayerMentorshipStatus", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PlayerMentorshipConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PortraitDocumentation.lua b/APIDocumentation/Documentation/PortraitDocumentation.lua new file mode 100644 index 0000000..37ced4e --- /dev/null +++ b/APIDocumentation/Documentation/PortraitDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..9249abb --- /dev/null +++ b/APIDocumentation/Documentation/ProfessionConstantsDocumentation.lua @@ -0,0 +1,318 @@ +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 new file mode 100644 index 0000000..0775a5f --- /dev/null +++ b/APIDocumentation/Documentation/PvPFactionConstantsDocumentation.lua @@ -0,0 +1,20 @@ +local PvPFactionConstants = +{ + Tables = + { + { + Name = "PvPFaction", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "Horde", Type = "PvPFaction", EnumValue = 0 }, + { Name = "Alliance", Type = "PvPFaction", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(PvPFactionConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua b/APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua new file mode 100644 index 0000000..7c3619a --- /dev/null +++ b/APIDocumentation/Documentation/PvpInfoConstantsDocumentation.lua @@ -0,0 +1,16 @@ +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 new file mode 100644 index 0000000..716f0e4 --- /dev/null +++ b/APIDocumentation/Documentation/PvpInfoDocumentation.lua @@ -0,0 +1,461 @@ +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 new file mode 100644 index 0000000..01c0eda --- /dev/null +++ b/APIDocumentation/Documentation/QuestConstantsDocumentation.lua @@ -0,0 +1,78 @@ +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 new file mode 100644 index 0000000..a08eeb9 --- /dev/null +++ b/APIDocumentation/Documentation/QuestConstants_ClassicDocumentation.lua @@ -0,0 +1,8 @@ +local QuestConstants_Classic = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(QuestConstants_Classic); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua b/APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua new file mode 100644 index 0000000..f46ea39 --- /dev/null +++ b/APIDocumentation/Documentation/QuestInfoSystemDocumentation.lua @@ -0,0 +1,93 @@ +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 new file mode 100644 index 0000000..b593944 --- /dev/null +++ b/APIDocumentation/Documentation/QuestLineInfoDocumentation.lua @@ -0,0 +1,49 @@ +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 new file mode 100644 index 0000000..9080aff --- /dev/null +++ b/APIDocumentation/Documentation/QuestLogDocumentation.lua @@ -0,0 +1,256 @@ +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 new file mode 100644 index 0000000..411d3ac --- /dev/null +++ b/APIDocumentation/Documentation/QuestOfferDocumentation.lua @@ -0,0 +1,50 @@ +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 new file mode 100644 index 0000000..45d1dac --- /dev/null +++ b/APIDocumentation/Documentation/QuestRewardsDocumentation.lua @@ -0,0 +1,17 @@ +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 new file mode 100644 index 0000000..433d536 --- /dev/null +++ b/APIDocumentation/Documentation/QuestSessionConstantsDocumentation.lua @@ -0,0 +1,67 @@ +local QuestSessionConstants = +{ + Tables = + { + { + Name = "QuestSessionCommand", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "QuestSessionCommand", EnumValue = 0 }, + { Name = "Start", Type = "QuestSessionCommand", EnumValue = 1 }, + { Name = "Stop", Type = "QuestSessionCommand", EnumValue = 2 }, + { Name = "SessionActiveNoCommand", Type = "QuestSessionCommand", EnumValue = 3 }, + }, + }, + { + Name = "QuestSessionResult", + Type = "Enumeration", + NumValues = 35, + MinValue = 0, + MaxValue = 34, + Fields = + { + { Name = "Ok", Type = "QuestSessionResult", EnumValue = 0 }, + { Name = "NotInParty", Type = "QuestSessionResult", EnumValue = 1 }, + { Name = "InvalidOwner", Type = "QuestSessionResult", EnumValue = 2 }, + { Name = "AlreadyActive", Type = "QuestSessionResult", EnumValue = 3 }, + { Name = "NotActive", Type = "QuestSessionResult", EnumValue = 4 }, + { Name = "InRaid", Type = "QuestSessionResult", EnumValue = 5 }, + { Name = "OwnerRefused", Type = "QuestSessionResult", EnumValue = 6 }, + { Name = "Timeout", Type = "QuestSessionResult", EnumValue = 7 }, + { Name = "Disabled", Type = "QuestSessionResult", EnumValue = 8 }, + { Name = "Started", Type = "QuestSessionResult", EnumValue = 9 }, + { Name = "Stopped", Type = "QuestSessionResult", EnumValue = 10 }, + { Name = "Joined", Type = "QuestSessionResult", EnumValue = 11 }, + { Name = "Left", Type = "QuestSessionResult", EnumValue = 12 }, + { Name = "OwnerLeft", Type = "QuestSessionResult", EnumValue = 13 }, + { Name = "ReadyCheckFailed", Type = "QuestSessionResult", EnumValue = 14 }, + { Name = "PartyDestroyed", Type = "QuestSessionResult", EnumValue = 15 }, + { Name = "MemberTimeout", Type = "QuestSessionResult", EnumValue = 16 }, + { Name = "AlreadyMember", Type = "QuestSessionResult", EnumValue = 17 }, + { Name = "NotOwner", Type = "QuestSessionResult", EnumValue = 18 }, + { Name = "AlreadyOwner", Type = "QuestSessionResult", EnumValue = 19 }, + { Name = "AlreadyJoined", Type = "QuestSessionResult", EnumValue = 20 }, + { Name = "NotMember", Type = "QuestSessionResult", EnumValue = 21 }, + { Name = "Busy", Type = "QuestSessionResult", EnumValue = 22 }, + { Name = "JoinRejected", Type = "QuestSessionResult", EnumValue = 23 }, + { Name = "Logout", Type = "QuestSessionResult", EnumValue = 24 }, + { Name = "Empty", Type = "QuestSessionResult", EnumValue = 25 }, + { Name = "QuestNotCompleted", Type = "QuestSessionResult", EnumValue = 26 }, + { Name = "Resync", Type = "QuestSessionResult", EnumValue = 27 }, + { Name = "Restricted", Type = "QuestSessionResult", EnumValue = 28 }, + { Name = "InPetBattle", Type = "QuestSessionResult", EnumValue = 29 }, + { Name = "InvalidPublicParty", Type = "QuestSessionResult", EnumValue = 30 }, + { Name = "Unknown", Type = "QuestSessionResult", EnumValue = 31 }, + { Name = "InCombat", Type = "QuestSessionResult", EnumValue = 32 }, + { Name = "MemberInCombat", Type = "QuestSessionResult", EnumValue = 33 }, + { Name = "RestrictedCrossFaction", Type = "QuestSessionResult", EnumValue = 34 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QuestSessionConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/QuestSessionDocumentation.lua b/APIDocumentation/Documentation/QuestSessionDocumentation.lua new file mode 100644 index 0000000..7dad579 --- /dev/null +++ b/APIDocumentation/Documentation/QuestSessionDocumentation.lua @@ -0,0 +1,200 @@ +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 new file mode 100644 index 0000000..02d4add --- /dev/null +++ b/APIDocumentation/Documentation/QuestTaskInfoDocumentation.lua @@ -0,0 +1,200 @@ +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 new file mode 100644 index 0000000..e1baf4a --- /dev/null +++ b/APIDocumentation/Documentation/QueueSpecificDocumentation.lua @@ -0,0 +1,25 @@ +local QueueSpecific = +{ + Tables = + { + { + Name = "QueueSpecificInfo", + Type = "Structure", + Fields = + { + { Name = "queueType", Type = "cstring", Nilable = false }, + { Name = "lfgIDs", Type = "table", InnerType = "number", Nilable = true }, + { Name = "lfgListID", Type = "number", Nilable = true }, + { Name = "activityID", Type = "number", Nilable = true }, + { Name = "battlefieldType", Type = "cstring", Nilable = true }, + { Name = "listID", Type = "number", Nilable = true }, + { Name = "mapName", Type = "cstring", Nilable = true }, + { Name = "rated", Type = "bool", Nilable = true }, + { Name = "isBrawl", Type = "bool", Nilable = true }, + { Name = "teamSize", Type = "number", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(QueueSpecific); \ No newline at end of file diff --git a/APIDocumentation/Documentation/RaidLocksDocumentation.lua b/APIDocumentation/Documentation/RaidLocksDocumentation.lua new file mode 100644 index 0000000..87740c5 --- /dev/null +++ b/APIDocumentation/Documentation/RaidLocksDocumentation.lua @@ -0,0 +1,36 @@ +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/RecruitAFriendSharedDocumentation.lua b/APIDocumentation/Documentation/RecruitAFriendSharedDocumentation.lua new file mode 100644 index 0000000..78f28a3 --- /dev/null +++ b/APIDocumentation/Documentation/RecruitAFriendSharedDocumentation.lua @@ -0,0 +1,36 @@ +local RecruitAFriendShared = +{ + Tables = + { + { + Name = "RafLinkType", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "RafLinkType", EnumValue = 0 }, + { Name = "Recruit", Type = "RafLinkType", EnumValue = 1 }, + { Name = "Friend", Type = "RafLinkType", EnumValue = 2 }, + { Name = "Both", Type = "RafLinkType", EnumValue = 3 }, + }, + }, + { + Name = "RecruitAFriendRewardsVersion", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "InvalidVersion", Type = "RecruitAFriendRewardsVersion", EnumValue = 0 }, + { Name = "UnusedVersionOne", Type = "RecruitAFriendRewardsVersion", EnumValue = 1 }, + { Name = "VersionTwo", Type = "RecruitAFriendRewardsVersion", EnumValue = 2 }, + { Name = "VersionThree", Type = "RecruitAFriendRewardsVersion", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(RecruitAFriendShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua b/APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua new file mode 100644 index 0000000..6bfdb03 --- /dev/null +++ b/APIDocumentation/Documentation/ReportSystemConstantsDocumentation.lua @@ -0,0 +1,73 @@ +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 new file mode 100644 index 0000000..746abcd --- /dev/null +++ b/APIDocumentation/Documentation/ReportSystemDocumentation.lua @@ -0,0 +1,134 @@ +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 new file mode 100644 index 0000000..eb391e0 --- /dev/null +++ b/APIDocumentation/Documentation/ReputationInfoDocumentation.lua @@ -0,0 +1,70 @@ +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 new file mode 100644 index 0000000..6974657 --- /dev/null +++ b/APIDocumentation/Documentation/RestrictedActionsDocumentation.lua @@ -0,0 +1,58 @@ +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 new file mode 100644 index 0000000..c396b87 --- /dev/null +++ b/APIDocumentation/Documentation/ScreenDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..0aa577a --- /dev/null +++ b/APIDocumentation/Documentation/ScriptRegionSharedDocumentation.lua @@ -0,0 +1,8 @@ +local ScriptRegionShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(ScriptRegionShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/ScriptWarningsDocumentation.lua b/APIDocumentation/Documentation/ScriptWarningsDocumentation.lua new file mode 100644 index 0000000..e3fb029 --- /dev/null +++ b/APIDocumentation/Documentation/ScriptWarningsDocumentation.lua @@ -0,0 +1,30 @@ +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 new file mode 100644 index 0000000..84b34e5 --- /dev/null +++ b/APIDocumentation/Documentation/ScriptedAnimationsDocumentation.lua @@ -0,0 +1,107 @@ +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 new file mode 100644 index 0000000..c2fa4c2 --- /dev/null +++ b/APIDocumentation/Documentation/SeasonsConstantsDocumentation.lua @@ -0,0 +1,21 @@ +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 new file mode 100644 index 0000000..03e9e24 --- /dev/null +++ b/APIDocumentation/Documentation/SeasonsDocumentation.lua @@ -0,0 +1,38 @@ +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/SecureTransferDocumentation.lua b/APIDocumentation/Documentation/SecureTransferDocumentation.lua new file mode 100644 index 0000000..bf40fe4 --- /dev/null +++ b/APIDocumentation/Documentation/SecureTransferDocumentation.lua @@ -0,0 +1,35 @@ +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 new file mode 100644 index 0000000..b271b9b --- /dev/null +++ b/APIDocumentation/Documentation/SharedScriptObjectModelLightDocumentation.lua @@ -0,0 +1,21 @@ +local SharedScriptObjectModelLight = +{ + Tables = + { + { + Name = "ModelLight", + Type = "Structure", + Fields = + { + { Name = "omnidirectional", Type = "bool", Nilable = false, Default = false }, + { Name = "point", Type = "vector3", Mixin = "Vector3DMixin", Nilable = false, Documentation = { "If this light is omnidirectional then point refers to a position, otherwise it refers to a direction" } }, + { Name = "ambientIntensity", Type = "number", Nilable = false, Default = 0 }, + { Name = "ambientColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + { Name = "diffuseIntensity", Type = "number", Nilable = false, Default = 0 }, + { Name = "diffuseColor", Type = "colorRGB", Mixin = "ColorMixin", Nilable = true }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SharedScriptObjectModelLight); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua b/APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua new file mode 100644 index 0000000..ac17963 --- /dev/null +++ b/APIDocumentation/Documentation/SharedScriptObjectUnitPositionFrameDocumentation.lua @@ -0,0 +1,21 @@ +local SharedScriptObjectUnitPositionFrame = +{ + Tables = + { + { + Name = "PingTextureType", + Type = "Enumeration", + NumValues = 3, + MinValue = 0, + MaxValue = 2, + Fields = + { + { Name = "Center", Type = "PingTextureType", EnumValue = 0 }, + { Name = "Expand", Type = "PingTextureType", EnumValue = 1 }, + { Name = "Rotation", Type = "PingTextureType", EnumValue = 2 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SharedScriptObjectUnitPositionFrame); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SharedTraitsDocumentation.lua b/APIDocumentation/Documentation/SharedTraitsDocumentation.lua new file mode 100644 index 0000000..dbfe11d --- /dev/null +++ b/APIDocumentation/Documentation/SharedTraitsDocumentation.lua @@ -0,0 +1,822 @@ +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 new file mode 100644 index 0000000..e8ea08d --- /dev/null +++ b/APIDocumentation/Documentation/SharedTraitsEnumsDocumentation.lua @@ -0,0 +1,8 @@ +local SharedTraitsEnums = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(SharedTraitsEnums); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua new file mode 100644 index 0000000..d30f8c4 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimAPIDocumentation.lua @@ -0,0 +1,441 @@ +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 new file mode 100644 index 0000000..77c882a --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimAlphaAPIDocumentation.lua @@ -0,0 +1,63 @@ +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 new file mode 100644 index 0000000..0cd6180 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimFlipBookAPIDocumentation.lua @@ -0,0 +1,129 @@ +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 new file mode 100644 index 0000000..90ea8c5 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimGroupAPIDocumentation.lua @@ -0,0 +1,342 @@ +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 new file mode 100644 index 0000000..32f1d65 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimPathAPIDocumentation.lua @@ -0,0 +1,83 @@ +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 new file mode 100644 index 0000000..966ec88 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimRotationAPIDocumentation.lua @@ -0,0 +1,89 @@ +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 new file mode 100644 index 0000000..9872adb --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimScaleAPIDocumentation.lua @@ -0,0 +1,117 @@ +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 new file mode 100644 index 0000000..e1054b2 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimScaleLineAPIDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..bf50085 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimTextureCoordTranslationAPIDocumentation.lua @@ -0,0 +1,43 @@ +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 new file mode 100644 index 0000000..78e8d3e --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimTranslationAPIDocumentation.lua @@ -0,0 +1,43 @@ +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 new file mode 100644 index 0000000..54219bb --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimTranslationLineAPIDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..2dc3585 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleAnimatableObjectAPIDocumentation.lua @@ -0,0 +1,55 @@ +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 new file mode 100644 index 0000000..2215c7e --- /dev/null +++ b/APIDocumentation/Documentation/SimpleBrowserAPIDocumentation.lua @@ -0,0 +1,128 @@ +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 new file mode 100644 index 0000000..02b042c --- /dev/null +++ b/APIDocumentation/Documentation/SimpleButtonAPIDocumentation.lua @@ -0,0 +1,482 @@ +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 new file mode 100644 index 0000000..aa659fa --- /dev/null +++ b/APIDocumentation/Documentation/SimpleCheckboxAPIDocumentation.lua @@ -0,0 +1,85 @@ +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 new file mode 100644 index 0000000..0a1f5ab --- /dev/null +++ b/APIDocumentation/Documentation/SimpleColorSelectAPIDocumentation.lua @@ -0,0 +1,167 @@ +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 new file mode 100644 index 0000000..d29c36a --- /dev/null +++ b/APIDocumentation/Documentation/SimpleControlPointAPIDocumentation.lua @@ -0,0 +1,75 @@ +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 new file mode 100644 index 0000000..6634a8d --- /dev/null +++ b/APIDocumentation/Documentation/SimpleEditBoxAPIDocumentation.lua @@ -0,0 +1,839 @@ +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 new file mode 100644 index 0000000..fc94384 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleFontAPIDocumentation.lua @@ -0,0 +1,266 @@ +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 new file mode 100644 index 0000000..2b8184f --- /dev/null +++ b/APIDocumentation/Documentation/SimpleFontStringAPIDocumentation.lua @@ -0,0 +1,544 @@ +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 new file mode 100644 index 0000000..afc53a7 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleFrameAPIDocumentation.lua @@ -0,0 +1,1072 @@ +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 new file mode 100644 index 0000000..64cbccf --- /dev/null +++ b/APIDocumentation/Documentation/SimpleFrameScriptObjectAPIDocumentation.lua @@ -0,0 +1,80 @@ +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 new file mode 100644 index 0000000..5c7a76f --- /dev/null +++ b/APIDocumentation/Documentation/SimpleHTMLAPIDocumentation.lua @@ -0,0 +1,311 @@ +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 new file mode 100644 index 0000000..c043fe7 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleHTMLSharedDocumentation.lua @@ -0,0 +1,18 @@ +local SimpleHTMLShared = +{ + Tables = + { + { + Name = "HTMLContentNode", + Type = "Structure", + Fields = + { + { Name = "text", Type = "cstring", Nilable = false }, + { Name = "type", Type = "HTMLTextType", Nilable = false }, + { Name = "align", Type = "TBFStyleFlags", Nilable = false }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SimpleHTMLShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua b/APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua new file mode 100644 index 0000000..add9288 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleLineAPIDocumentation.lua @@ -0,0 +1,105 @@ +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 new file mode 100644 index 0000000..0a1eb72 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleMaskTextureAPIDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..8a7ef04 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleMessageFrameAPIDocumentation.lua @@ -0,0 +1,404 @@ +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 new file mode 100644 index 0000000..611aa84 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleModelAPIDocumentation.lua @@ -0,0 +1,723 @@ +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 new file mode 100644 index 0000000..1451df3 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleModelFFXAPIDocumentation.lua @@ -0,0 +1,57 @@ +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 new file mode 100644 index 0000000..5c91a0f --- /dev/null +++ b/APIDocumentation/Documentation/SimpleMovieAPIDocumentation.lua @@ -0,0 +1,69 @@ +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 new file mode 100644 index 0000000..30b0f92 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleObjectAPIDocumentation.lua @@ -0,0 +1,68 @@ +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 new file mode 100644 index 0000000..d4a0fe4 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleOffScreenFrameAPIDocumentation.lua @@ -0,0 +1,120 @@ +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 new file mode 100644 index 0000000..720e661 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleRegionAPIDocumentation.lua @@ -0,0 +1,185 @@ +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 new file mode 100644 index 0000000..4fb1258 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleScriptRegionAPIDocumentation.lua @@ -0,0 +1,485 @@ +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 new file mode 100644 index 0000000..45fffe0 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleScriptRegionResizingAPIDocumentation.lua @@ -0,0 +1,154 @@ +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 new file mode 100644 index 0000000..a425d89 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleScrollFrameAPIDocumentation.lua @@ -0,0 +1,119 @@ +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 new file mode 100644 index 0000000..62ddee4 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleSliderAPIDocumentation.lua @@ -0,0 +1,227 @@ +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 new file mode 100644 index 0000000..8ff757c --- /dev/null +++ b/APIDocumentation/Documentation/SimpleStatusBarAPIDocumentation.lua @@ -0,0 +1,259 @@ +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 new file mode 100644 index 0000000..bdbb124 --- /dev/null +++ b/APIDocumentation/Documentation/SimpleTextureAPIDocumentation.lua @@ -0,0 +1,64 @@ +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 new file mode 100644 index 0000000..d06fc6f --- /dev/null +++ b/APIDocumentation/Documentation/SimpleTextureBaseAPIDocumentation.lua @@ -0,0 +1,384 @@ +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/SkillInfoDocumentation.lua b/APIDocumentation/Documentation/SkillInfoDocumentation.lua new file mode 100644 index 0000000..5db428d --- /dev/null +++ b/APIDocumentation/Documentation/SkillInfoDocumentation.lua @@ -0,0 +1,25 @@ +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/SocialInfoDocumentation.lua b/APIDocumentation/Documentation/SocialInfoDocumentation.lua new file mode 100644 index 0000000..1b764d7 --- /dev/null +++ b/APIDocumentation/Documentation/SocialInfoDocumentation.lua @@ -0,0 +1,56 @@ +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 new file mode 100644 index 0000000..58bad1e --- /dev/null +++ b/APIDocumentation/Documentation/SocialQueueDocumentation.lua @@ -0,0 +1,87 @@ +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 new file mode 100644 index 0000000..2fe74db --- /dev/null +++ b/APIDocumentation/Documentation/SocialRestrictionsDocumentation.lua @@ -0,0 +1,92 @@ +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/SoftTargetConstantsDocumentation.lua b/APIDocumentation/Documentation/SoftTargetConstantsDocumentation.lua new file mode 100644 index 0000000..ac20d70 --- /dev/null +++ b/APIDocumentation/Documentation/SoftTargetConstantsDocumentation.lua @@ -0,0 +1,22 @@ +local SoftTargetConstants = +{ + Tables = + { + { + Name = "SoftTargetEnableFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "None", Type = "SoftTargetEnableFlags", EnumValue = 0 }, + { Name = "Gamepad", Type = "SoftTargetEnableFlags", EnumValue = 1 }, + { Name = "Kbm", Type = "SoftTargetEnableFlags", EnumValue = 2 }, + { Name = "Any", Type = "SoftTargetEnableFlags", EnumValue = 3 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(SoftTargetConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SoundDocumentation.lua b/APIDocumentation/Documentation/SoundDocumentation.lua new file mode 100644 index 0000000..2f4a1d8 --- /dev/null +++ b/APIDocumentation/Documentation/SoundDocumentation.lua @@ -0,0 +1,72 @@ +local Sound = +{ + Name = "Sound", + Type = "System", + Namespace = "C_Sound", + + Functions = + { + { + Name = "GetSoundScaledVolume", + Type = "Function", + + Arguments = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "scaledVolume", Type = "number", Nilable = false }, + }, + }, + { + Name = "IsPlaying", + Type = "Function", + + Arguments = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isPlaying", Type = "bool", Nilable = false }, + }, + }, + { + Name = "PlayItemSound", + Type = "Function", + + Arguments = + { + { Name = "soundType", Type = "ItemSoundType", Nilable = false }, + { Name = "itemLocation", Type = "ItemLocation", Mixin = "ItemLocationMixin", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SoundDeviceUpdate", + Type = "Event", + LiteralName = "SOUND_DEVICE_UPDATE", + }, + { + Name = "SoundkitFinished", + Type = "Event", + LiteralName = "SOUNDKIT_FINISHED", + Payload = + { + { Name = "soundHandle", Type = "number", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Sound); \ No newline at end of file diff --git a/APIDocumentation/Documentation/SpecializationInfoDocumentation.lua b/APIDocumentation/Documentation/SpecializationInfoDocumentation.lua new file mode 100644 index 0000000..c75f3d5 --- /dev/null +++ b/APIDocumentation/Documentation/SpecializationInfoDocumentation.lua @@ -0,0 +1,76 @@ +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 new file mode 100644 index 0000000..f298249 --- /dev/null +++ b/APIDocumentation/Documentation/SpecializationSharedDocumentation.lua @@ -0,0 +1,35 @@ +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 new file mode 100644 index 0000000..34b5e87 --- /dev/null +++ b/APIDocumentation/Documentation/SpellActivationOverlayDocumentation.lua @@ -0,0 +1,62 @@ +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 new file mode 100644 index 0000000..db87653 --- /dev/null +++ b/APIDocumentation/Documentation/SpellBookDocumentation.lua @@ -0,0 +1,149 @@ +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 new file mode 100644 index 0000000..f736f1f --- /dev/null +++ b/APIDocumentation/Documentation/SpellDocumentation.lua @@ -0,0 +1,67 @@ +local Spell = +{ + Name = "Spell", + Type = "System", + Namespace = "C_Spell", + + Functions = + { + { + Name = "DoesSpellExist", + Type = "Function", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "spellExists", Type = "bool", Nilable = false }, + }, + }, + { + Name = "IsSpellDataCached", + Type = "Function", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "isCached", Type = "bool", Nilable = false }, + }, + }, + { + Name = "RequestLoadSpellData", + Type = "Function", + + Arguments = + { + { Name = "spellID", Type = "number", Nilable = false }, + }, + }, + }, + + Events = + { + { + Name = "SpellDataLoadResult", + Type = "Event", + LiteralName = "SPELL_DATA_LOAD_RESULT", + Payload = + { + { Name = "spellID", Type = "number", Nilable = false }, + { Name = "success", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Spell); \ No newline at end of file diff --git a/APIDocumentation/Documentation/StableInfoDocumentation.lua b/APIDocumentation/Documentation/StableInfoDocumentation.lua new file mode 100644 index 0000000..e71c0e1 --- /dev/null +++ b/APIDocumentation/Documentation/StableInfoDocumentation.lua @@ -0,0 +1,58 @@ +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/StorePublicUIDocumentation.lua b/APIDocumentation/Documentation/StorePublicUIDocumentation.lua new file mode 100644 index 0000000..3e3cac4 --- /dev/null +++ b/APIDocumentation/Documentation/StorePublicUIDocumentation.lua @@ -0,0 +1,61 @@ +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 new file mode 100644 index 0000000..fecd0c6 --- /dev/null +++ b/APIDocumentation/Documentation/StringUtilDocumentation.lua @@ -0,0 +1,37 @@ +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 new file mode 100644 index 0000000..c00741f --- /dev/null +++ b/APIDocumentation/Documentation/SummonInfoDocumentation.lua @@ -0,0 +1,73 @@ +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/SystemDocumentation.lua b/APIDocumentation/Documentation/SystemDocumentation.lua new file mode 100644 index 0000000..6355804 --- /dev/null +++ b/APIDocumentation/Documentation/SystemDocumentation.lua @@ -0,0 +1,201 @@ +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 new file mode 100644 index 0000000..2aca88b --- /dev/null +++ b/APIDocumentation/Documentation/SystemTimeDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..71b7c20 --- /dev/null +++ b/APIDocumentation/Documentation/TTSSettingsDocumentation.lua @@ -0,0 +1,218 @@ +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/TaxiMapDocumentation.lua b/APIDocumentation/Documentation/TaxiMapDocumentation.lua new file mode 100644 index 0000000..b1dc30a --- /dev/null +++ b/APIDocumentation/Documentation/TaxiMapDocumentation.lua @@ -0,0 +1,116 @@ +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/TextureSharedDocumentation.lua b/APIDocumentation/Documentation/TextureSharedDocumentation.lua new file mode 100644 index 0000000..85b8b97 --- /dev/null +++ b/APIDocumentation/Documentation/TextureSharedDocumentation.lua @@ -0,0 +1,8 @@ +local TextureShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(TextureShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TextureUtilsDocumentation.lua b/APIDocumentation/Documentation/TextureUtilsDocumentation.lua new file mode 100644 index 0000000..2501d16 --- /dev/null +++ b/APIDocumentation/Documentation/TextureUtilsDocumentation.lua @@ -0,0 +1,134 @@ +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/TimeDocumentation.lua b/APIDocumentation/Documentation/TimeDocumentation.lua new file mode 100644 index 0000000..4f0336c --- /dev/null +++ b/APIDocumentation/Documentation/TimeDocumentation.lua @@ -0,0 +1,22 @@ +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 new file mode 100644 index 0000000..c78db48 --- /dev/null +++ b/APIDocumentation/Documentation/TooltipComparisonDocumentation.lua @@ -0,0 +1,44 @@ +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 new file mode 100644 index 0000000..ba565b4 --- /dev/null +++ b/APIDocumentation/Documentation/TooltipConstantsDocumentation.lua @@ -0,0 +1,51 @@ +local TooltipConstants = +{ + Tables = + { + { + Name = "TooltipSide", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 3, + Fields = + { + { Name = "Left", Type = "TooltipSide", EnumValue = 0 }, + { Name = "Right", Type = "TooltipSide", EnumValue = 1 }, + { Name = "Top", Type = "TooltipSide", EnumValue = 2 }, + { Name = "Bottom", Type = "TooltipSide", EnumValue = 3 }, + }, + }, + { + Name = "TooltipTextureAnchor", + Type = "Enumeration", + NumValues = 7, + MinValue = 0, + MaxValue = 6, + Fields = + { + { Name = "LeftTop", Type = "TooltipTextureAnchor", EnumValue = 0 }, + { Name = "LeftCenter", Type = "TooltipTextureAnchor", EnumValue = 1 }, + { Name = "LeftBottom", Type = "TooltipTextureAnchor", EnumValue = 2 }, + { Name = "RightTop", Type = "TooltipTextureAnchor", EnumValue = 3 }, + { Name = "RightCenter", Type = "TooltipTextureAnchor", EnumValue = 4 }, + { Name = "RightBottom", Type = "TooltipTextureAnchor", EnumValue = 5 }, + { Name = "All", Type = "TooltipTextureAnchor", EnumValue = 6 }, + }, + }, + { + Name = "TooltipTextureRelativeRegion", + Type = "Enumeration", + NumValues = 2, + MinValue = 0, + MaxValue = 1, + Fields = + { + { Name = "LeftLine", Type = "TooltipTextureRelativeRegion", EnumValue = 0 }, + { Name = "RightLine", Type = "TooltipTextureRelativeRegion", EnumValue = 1 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(TooltipConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TooltipInfoDocumentation.lua b/APIDocumentation/Documentation/TooltipInfoDocumentation.lua new file mode 100644 index 0000000..f702dd4 --- /dev/null +++ b/APIDocumentation/Documentation/TooltipInfoDocumentation.lua @@ -0,0 +1,44 @@ +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 new file mode 100644 index 0000000..8759ed7 --- /dev/null +++ b/APIDocumentation/Documentation/TooltipInfoSharedDocumentation.lua @@ -0,0 +1,128 @@ +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 new file mode 100644 index 0000000..551862d --- /dev/null +++ b/APIDocumentation/Documentation/ToyBoxInfoDocumentation.lua @@ -0,0 +1,63 @@ +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/TradeInfoDocumentation.lua b/APIDocumentation/Documentation/TradeInfoDocumentation.lua new file mode 100644 index 0000000..3eee5ae --- /dev/null +++ b/APIDocumentation/Documentation/TradeInfoDocumentation.lua @@ -0,0 +1,96 @@ +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 new file mode 100644 index 0000000..f749511 --- /dev/null +++ b/APIDocumentation/Documentation/TradeSkillUIDocumentation.lua @@ -0,0 +1,86 @@ +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 new file mode 100644 index 0000000..5f61704 --- /dev/null +++ b/APIDocumentation/Documentation/TradeSkillUITypesDocumentation.lua @@ -0,0 +1,72 @@ +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/TrainerDocumentation.lua b/APIDocumentation/Documentation/TrainerDocumentation.lua new file mode 100644 index 0000000..ed2fca8 --- /dev/null +++ b/APIDocumentation/Documentation/TrainerDocumentation.lua @@ -0,0 +1,45 @@ +local Trainer = +{ + Name = "Trainer", + Type = "System", + Namespace = "C_Trainer", + + Functions = + { + }, + + Events = + { + { + Name = "TrainerClosed", + Type = "Event", + LiteralName = "TRAINER_CLOSED", + }, + { + Name = "TrainerDescriptionUpdate", + Type = "Event", + LiteralName = "TRAINER_DESCRIPTION_UPDATE", + }, + { + Name = "TrainerServiceInfoNameUpdate", + Type = "Event", + LiteralName = "TRAINER_SERVICE_INFO_NAME_UPDATE", + }, + { + Name = "TrainerShow", + Type = "Event", + LiteralName = "TRAINER_SHOW", + }, + { + Name = "TrainerUpdate", + Type = "Event", + LiteralName = "TRAINER_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Trainer); \ No newline at end of file diff --git a/APIDocumentation/Documentation/TraitConfigDocumentation.lua b/APIDocumentation/Documentation/TraitConfigDocumentation.lua new file mode 100644 index 0000000..8dd4973 --- /dev/null +++ b/APIDocumentation/Documentation/TraitConfigDocumentation.lua @@ -0,0 +1,20 @@ +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 new file mode 100644 index 0000000..75b51dc --- /dev/null +++ b/APIDocumentation/Documentation/TraitConstantsDocumentation.lua @@ -0,0 +1,299 @@ +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 new file mode 100644 index 0000000..887b5b9 --- /dev/null +++ b/APIDocumentation/Documentation/TransmogSharedDocumentation.lua @@ -0,0 +1,122 @@ +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 new file mode 100644 index 0000000..c594428 --- /dev/null +++ b/APIDocumentation/Documentation/TutorialDocumentation.lua @@ -0,0 +1,30 @@ +local Tutorial = +{ + Name = "Tutorial", + Type = "System", + Namespace = "C_Tutorial", + + Functions = + { + }, + + Events = + { + { + Name = "TutorialTrigger", + Type = "Event", + LiteralName = "TUTORIAL_TRIGGER", + Payload = + { + { Name = "tutorialIndex", Type = "number", Nilable = false }, + { Name = "forceShow", Type = "bool", Nilable = false }, + }, + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Tutorial); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIColorDocumentation.lua b/APIDocumentation/Documentation/UIColorDocumentation.lua new file mode 100644 index 0000000..d8d5fd1 --- /dev/null +++ b/APIDocumentation/Documentation/UIColorDocumentation.lua @@ -0,0 +1,38 @@ +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 new file mode 100644 index 0000000..2fc16f6 --- /dev/null +++ b/APIDocumentation/Documentation/UIFileAssetSharedDocumentation.lua @@ -0,0 +1,8 @@ +local UIFileAssetShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UIFileAssetShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua b/APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua new file mode 100644 index 0000000..dcaa2f7 --- /dev/null +++ b/APIDocumentation/Documentation/UIGenericWidgetDisplayDocumentation.lua @@ -0,0 +1,51 @@ +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 new file mode 100644 index 0000000..499979e --- /dev/null +++ b/APIDocumentation/Documentation/UIMacrosDocumentation.lua @@ -0,0 +1,43 @@ +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 new file mode 100644 index 0000000..df7cedd --- /dev/null +++ b/APIDocumentation/Documentation/UIManagerDocumentation.lua @@ -0,0 +1,80 @@ +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 new file mode 100644 index 0000000..ebee40a --- /dev/null +++ b/APIDocumentation/Documentation/UIModelInfoDocumentation.lua @@ -0,0 +1,231 @@ +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 new file mode 100644 index 0000000..0670831 --- /dev/null +++ b/APIDocumentation/Documentation/UIModelInfoSharedDocumentation.lua @@ -0,0 +1,8 @@ +local UIModelInfoShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UIModelInfoShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UISharedDocumentation.lua b/APIDocumentation/Documentation/UISharedDocumentation.lua new file mode 100644 index 0000000..c0f6de4 --- /dev/null +++ b/APIDocumentation/Documentation/UISharedDocumentation.lua @@ -0,0 +1,31 @@ +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 new file mode 100644 index 0000000..4dbfa51 --- /dev/null +++ b/APIDocumentation/Documentation/UISystemVisibilityManagerDocumentation.lua @@ -0,0 +1,50 @@ +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 new file mode 100644 index 0000000..70e36d9 --- /dev/null +++ b/APIDocumentation/Documentation/UITextureAssetSharedDocumentation.lua @@ -0,0 +1,8 @@ +local UITextureAssetShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UITextureAssetShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UITimerDocumentation.lua b/APIDocumentation/Documentation/UITimerDocumentation.lua new file mode 100644 index 0000000..23a485f --- /dev/null +++ b/APIDocumentation/Documentation/UITimerDocumentation.lua @@ -0,0 +1,74 @@ +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 new file mode 100644 index 0000000..328d9f0 --- /dev/null +++ b/APIDocumentation/Documentation/UIWidgetManagerDocumentation.lua @@ -0,0 +1,501 @@ +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 new file mode 100644 index 0000000..bf275f3 --- /dev/null +++ b/APIDocumentation/Documentation/UIWidgetManagerSharedDocumentation.lua @@ -0,0 +1,74 @@ +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 new file mode 100644 index 0000000..3e53664 --- /dev/null +++ b/APIDocumentation/Documentation/URLDocumentation.lua @@ -0,0 +1,19 @@ +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 new file mode 100644 index 0000000..8b91f35 --- /dev/null +++ b/APIDocumentation/Documentation/UiModelSceneConstantsDocumentation.lua @@ -0,0 +1,33 @@ +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/UnitAuraDocumentation.lua b/APIDocumentation/Documentation/UnitAuraDocumentation.lua new file mode 100644 index 0000000..5ba67a9 --- /dev/null +++ b/APIDocumentation/Documentation/UnitAuraDocumentation.lua @@ -0,0 +1,28 @@ +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 new file mode 100644 index 0000000..b8aef54 --- /dev/null +++ b/APIDocumentation/Documentation/UnitConstantsDocumentation.lua @@ -0,0 +1,8 @@ +local UnitConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UnitConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UnitDocumentation.lua b/APIDocumentation/Documentation/UnitDocumentation.lua new file mode 100644 index 0000000..3347bad --- /dev/null +++ b/APIDocumentation/Documentation/UnitDocumentation.lua @@ -0,0 +1,1217 @@ +local Unit = +{ + Name = "Unit", + Type = "System", + + Functions = + { + { + Name = "IsPlayerInGuildFromGUID", + Type = "Function", + + Arguments = + { + { Name = "playerGUID", Type = "WOWGUID", Nilable = false }, + }, + + Returns = + { + { Name = "IsInGuild", Type = "bool", Nilable = false }, + }, + }, + { + Name = "SetPortraitTexture", + Type = "Function", + + 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 = "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", + Type = "Function", + Documentation = { "Whether the player would have been able to know the unit's exact health value in the original game release." }, + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "shouldKnowUnitHealth", Type = "bool", Nilable = false }, + }, + }, + { + Name = "UnitClass", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "className", Type = "cstring", Nilable = false }, + { Name = "classFilename", Type = "cstring", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitClassBase", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "classFilename", Type = "cstring", Nilable = false }, + { Name = "classID", Type = "number", Nilable = false }, + }, + }, + { + Name = "UnitIsConnected", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "isConnected", Type = "bool", Nilable = false }, + }, + }, + { + 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", + Type = "Function", + + Arguments = + { + { Name = "unit", Type = "UnitToken", Nilable = false }, + }, + + Returns = + { + { Name = "sex", Type = "number", Nilable = true }, + }, + }, + }, + + 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 = "UnitAttackPower", + Type = "Event", + LiteralName = "UNIT_ATTACK_POWER", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitAttackSpeed", + Type = "Event", + LiteralName = "UNIT_ATTACK_SPEED", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitCheatToggleEvent", + Type = "Event", + LiteralName = "UNIT_CHEAT_TOGGLE_EVENT", + }, + { + Name = "UnitClassificationChanged", + Type = "Event", + LiteralName = "UNIT_CLASSIFICATION_CHANGED", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitCombat", + 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 }, + }, + }, + { + Name = "UnitDamage", + Type = "Event", + LiteralName = "UNIT_DAMAGE", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitDefense", + Type = "Event", + LiteralName = "UNIT_DEFENSE", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitDisplaypower", + Type = "Event", + LiteralName = "UNIT_DISPLAYPOWER", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitFaction", + Type = "Event", + LiteralName = "UNIT_FACTION", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitFlags", + Type = "Event", + 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 = "UnitHealth", + Type = "Event", + 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 = "UnitLevel", + Type = "Event", + LiteralName = "UNIT_LEVEL", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitMana", + Type = "Event", + LiteralName = "UNIT_MANA", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitMaxhealth", + Type = "Event", + 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 = "UnitModelChanged", + Type = "Event", + LiteralName = "UNIT_MODEL_CHANGED", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitNameUpdate", + Type = "Event", + 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 = "UnitPet", + Type = "Event", + LiteralName = "UNIT_PET", + Payload = + { + { Name = "unitTarget", 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", + Type = "Event", + LiteralName = "UNIT_PORTRAIT_UPDATE", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitPowerBarHide", + Type = "Event", + LiteralName = "UNIT_POWER_BAR_HIDE", + 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 = "UnitRangeddamage", + Type = "Event", + LiteralName = "UNIT_RANGEDDAMAGE", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitResistances", + Type = "Event", + 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 = "UnitStats", + Type = "Event", + LiteralName = "UNIT_STATS", + Payload = + { + { Name = "unitTarget", Type = "UnitToken", Nilable = false }, + }, + }, + { + Name = "UnitTarget", + Type = "Event", + LiteralName = "UNIT_TARGET", + Payload = + { + { Name = "unitTarget", 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 diff --git a/APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua b/APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua new file mode 100644 index 0000000..b966433 --- /dev/null +++ b/APIDocumentation/Documentation/UnitSexConstantsDocumentation.lua @@ -0,0 +1,23 @@ +local UnitSexConstants = +{ + Tables = + { + { + Name = "UnitSex", + Type = "Enumeration", + NumValues = 5, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "Male", Type = "UnitSex", EnumValue = 0 }, + { Name = "Female", Type = "UnitSex", EnumValue = 1 }, + { Name = "None", Type = "UnitSex", EnumValue = 2 }, + { Name = "Both", Type = "UnitSex", EnumValue = 3 }, + { Name = "Neutral", Type = "UnitSex", EnumValue = 4 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(UnitSexConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UnitSharedDocumentation.lua b/APIDocumentation/Documentation/UnitSharedDocumentation.lua new file mode 100644 index 0000000..594bf8f --- /dev/null +++ b/APIDocumentation/Documentation/UnitSharedDocumentation.lua @@ -0,0 +1,8 @@ +local UnitShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(UnitShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/UserFeedbackDocumentation.lua b/APIDocumentation/Documentation/UserFeedbackDocumentation.lua new file mode 100644 index 0000000..15951b2 --- /dev/null +++ b/APIDocumentation/Documentation/UserFeedbackDocumentation.lua @@ -0,0 +1,49 @@ +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/ValidateNameConstantsDocumentation.lua b/APIDocumentation/Documentation/ValidateNameConstantsDocumentation.lua new file mode 100644 index 0000000..1ac31fe --- /dev/null +++ b/APIDocumentation/Documentation/ValidateNameConstantsDocumentation.lua @@ -0,0 +1,50 @@ +local ValidateNameConstants = +{ + Tables = + { + { + Name = "ScrubStringFlags", + Type = "Enumeration", + NumValues = 4, + MinValue = 0, + MaxValue = 4, + Fields = + { + { Name = "None", Type = "ScrubStringFlags", EnumValue = 0 }, + { Name = "TruncateNewLines", Type = "ScrubStringFlags", EnumValue = 1 }, + { Name = "AllowBarCodes", Type = "ScrubStringFlags", EnumValue = 2 }, + { Name = "StripControlCodes", Type = "ScrubStringFlags", EnumValue = 4 }, + }, + }, + { + Name = "ValidateNameResult", + Type = "Enumeration", + NumValues = 18, + MinValue = 0, + MaxValue = 17, + Fields = + { + { Name = "Success", Type = "ValidateNameResult", EnumValue = 0 }, + { Name = "Failure", Type = "ValidateNameResult", EnumValue = 1 }, + { Name = "NoName", Type = "ValidateNameResult", EnumValue = 2 }, + { Name = "TooShort", Type = "ValidateNameResult", EnumValue = 3 }, + { Name = "TooLong", Type = "ValidateNameResult", EnumValue = 4 }, + { Name = "InvalidCharacter", Type = "ValidateNameResult", EnumValue = 5 }, + { Name = "MixedLanguages", Type = "ValidateNameResult", EnumValue = 6 }, + { Name = "Profane", Type = "ValidateNameResult", EnumValue = 7 }, + { Name = "Reserved", Type = "ValidateNameResult", EnumValue = 8 }, + { Name = "InvalidApostrophe", Type = "ValidateNameResult", EnumValue = 9 }, + { Name = "MultipleApostrophes", Type = "ValidateNameResult", EnumValue = 10 }, + { Name = "ThreeConsecutive", Type = "ValidateNameResult", EnumValue = 11 }, + { Name = "InvalidSpace", Type = "ValidateNameResult", EnumValue = 12 }, + { Name = "ConsecutiveSpaces", Type = "ValidateNameResult", EnumValue = 13 }, + { Name = "RussianConsecutiveSilentCharacters", Type = "ValidateNameResult", EnumValue = 14 }, + { Name = "RussianSilentCharacterAtBeginningOrEnd", Type = "ValidateNameResult", EnumValue = 15 }, + { Name = "DeclensionDoesntMatchBaseName", Type = "ValidateNameResult", EnumValue = 16 }, + { Name = "SpacesDisallowed", Type = "ValidateNameResult", EnumValue = 17 }, + }, + }, + }, +}; + +APIDocumentation:AddDocumentationTable(ValidateNameConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VectorSharedDocumentation.lua b/APIDocumentation/Documentation/VectorSharedDocumentation.lua new file mode 100644 index 0000000..3376142 --- /dev/null +++ b/APIDocumentation/Documentation/VectorSharedDocumentation.lua @@ -0,0 +1,8 @@ +local VectorShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(VectorShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VehicleConstantsDocumentation.lua b/APIDocumentation/Documentation/VehicleConstantsDocumentation.lua new file mode 100644 index 0000000..a27360c --- /dev/null +++ b/APIDocumentation/Documentation/VehicleConstantsDocumentation.lua @@ -0,0 +1,8 @@ +local VehicleConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(VehicleConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VehicleDocumentation.lua b/APIDocumentation/Documentation/VehicleDocumentation.lua new file mode 100644 index 0000000..0d7d7d2 --- /dev/null +++ b/APIDocumentation/Documentation/VehicleDocumentation.lua @@ -0,0 +1,115 @@ +local Vehicle = +{ + Name = "Vehicle", + Type = "System", + Namespace = "C_Vehicle", + + Functions = + { + }, + + Events = + { + { + 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 = "VehiclePassengersChanged", + Type = "Event", + LiteralName = "VEHICLE_PASSENGERS_CHANGED", + }, + { + Name = "VehiclePowerShow", + Type = "Event", + LiteralName = "VEHICLE_POWER_SHOW", + Payload = + { + { Name = "shouldShow", Type = "number", Nilable = true }, + }, + }, + { + Name = "VehicleUpdate", + Type = "Event", + LiteralName = "VEHICLE_UPDATE", + }, + }, + + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(Vehicle); \ No newline at end of file diff --git a/APIDocumentation/Documentation/VideoDocumentation.lua b/APIDocumentation/Documentation/VideoDocumentation.lua new file mode 100644 index 0000000..5855530 --- /dev/null +++ b/APIDocumentation/Documentation/VideoDocumentation.lua @@ -0,0 +1,174 @@ +local Video = +{ + Name = "Video", + Type = "System", + Namespace = "C_VideoOptions", + + Functions = + { + { + Name = "GetCurrentGameWindowSize", + Type = "Function", + + Returns = + { + { Name = "size", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetDefaultGameWindowSize", + Type = "Function", + + Arguments = + { + { Name = "monitor", Type = "number", Nilable = false }, + }, + + Returns = + { + { Name = "size", Type = "vector2", Mixin = "Vector2DMixin", Nilable = false }, + }, + }, + { + Name = "GetGameWindowSizes", + Type = "Function", + + Arguments = + { + { Name = "monitor", Type = "number", Nilable = false }, + { Name = "fullscreen", Type = "bool", Nilable = false }, + }, + + Returns = + { + { Name = "sizes", Type = "table", InnerType = "vector2", Nilable = false }, + }, + }, + { + Name = "GetGxAdapterInfo", + Type = "Function", + + Returns = + { + { Name = "adapters", Type = "table", InnerType = "GxAdapterInfoDetails", Nilable = false }, + }, + }, + { + Name = "SetGameWindowSize", + Type = "Function", + + Arguments = + { + { Name = "x", Type = "number", Nilable = false }, + { Name = "y", 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 diff --git a/APIDocumentation/Documentation/VignetteConstantsDocumentation.lua b/APIDocumentation/Documentation/VignetteConstantsDocumentation.lua new file mode 100644 index 0000000..bbfcd19 --- /dev/null +++ b/APIDocumentation/Documentation/VignetteConstantsDocumentation.lua @@ -0,0 +1,23 @@ +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 new file mode 100644 index 0000000..da0978d --- /dev/null +++ b/APIDocumentation/Documentation/VignetteInfoDocumentation.lua @@ -0,0 +1,40 @@ +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 new file mode 100644 index 0000000..c914e11 --- /dev/null +++ b/APIDocumentation/Documentation/VoiceChatDocumentation.lua @@ -0,0 +1,1344 @@ +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/VoidStorageInfoDocumentation.lua b/APIDocumentation/Documentation/VoidStorageInfoDocumentation.lua new file mode 100644 index 0000000..6b05e5c --- /dev/null +++ b/APIDocumentation/Documentation/VoidStorageInfoDocumentation.lua @@ -0,0 +1,59 @@ +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 new file mode 100644 index 0000000..99a8a70 --- /dev/null +++ b/APIDocumentation/Documentation/WeeklyRewardsSharedDocumentation.lua @@ -0,0 +1,8 @@ +local WeeklyRewardsShared = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WeeklyRewardsShared); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WoWGuidDocumentation.lua b/APIDocumentation/Documentation/WoWGuidDocumentation.lua new file mode 100644 index 0000000..61cf328 --- /dev/null +++ b/APIDocumentation/Documentation/WoWGuidDocumentation.lua @@ -0,0 +1,8 @@ +local WoWGuid = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WoWGuid); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WorldStateInfoDocumentation.lua b/APIDocumentation/Documentation/WorldStateInfoDocumentation.lua new file mode 100644 index 0000000..6b2a5e7 --- /dev/null +++ b/APIDocumentation/Documentation/WorldStateInfoDocumentation.lua @@ -0,0 +1,58 @@ +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 new file mode 100644 index 0000000..fe98703 --- /dev/null +++ b/APIDocumentation/Documentation/WowEntitlementInfoDocumentation.lua @@ -0,0 +1,67 @@ +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 new file mode 100644 index 0000000..eb626b8 --- /dev/null +++ b/APIDocumentation/Documentation/WowLabsConstantsDocumentation.lua @@ -0,0 +1,8 @@ +local WowLabsConstants = +{ + Tables = + { + }, +}; + +APIDocumentation:AddDocumentationTable(WowLabsConstants); \ No newline at end of file diff --git a/APIDocumentation/Documentation/WowTokenUIDocumentation.lua b/APIDocumentation/Documentation/WowTokenUIDocumentation.lua new file mode 100644 index 0000000..c036212 --- /dev/null +++ b/APIDocumentation/Documentation/WowTokenUIDocumentation.lua @@ -0,0 +1,119 @@ +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 new file mode 100644 index 0000000..e1a418f --- /dev/null +++ b/APIDocumentation/Documentation/XMLUtilDocumentation.lua @@ -0,0 +1,75 @@ +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/EventsAPIMixin.lua b/APIDocumentation/EventsAPIMixin.lua new file mode 100644 index 0000000..e0bb762 --- /dev/null +++ b/APIDocumentation/EventsAPIMixin.lua @@ -0,0 +1,92 @@ +local addonName, Private = ... + +EventsAPIMixin = Private.CreateFromMixins(BaseAPIMixin); + +function EventsAPIMixin:GetParentName() -- override + if self.System then + return self.System:GetName(); + end + + return ""; +end + +function EventsAPIMixin:GetType() -- override + return "event"; +end + +function EventsAPIMixin:GetLinkHexColor() + return "77ff22"; +end + +function EventsAPIMixin:GetClipboardString() + local lines = {}; + table.insert(lines, ([[if event == "%s" then]]):format(self.LiteralName)); + table.insert(lines, ("\tlocal %s = ...;"):format(self:GetPayloadString(false, false))); + table.insert(lines, "end"); + return table.concat(lines, "\r\n"); +end + +function EventsAPIMixin:GetFullName(decorateOptionals, includeColorCodes) -- override + if self.System then + return ("Event.%s.%s -> %s"):format(self.System:GetName(), self:GetName(), self:GetPayloadString(decorateOptionals, includeColorCodes)); + end + return ("Event.%s -> %s"):format(self:GetName(), self:GetPayloadString(decorateOptionals, includeColorCodes)); +end + +function EventsAPIMixin:MatchesSearchString(searchString) -- override + if self:GetLoweredName():match(searchString) then + return true; + end + + if self.System and self.System:GetLoweredName():match(searchString) then + return true; + end + + if self.LiteralName:lower():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + if self:MatchesAnyAPI(self.Payload, searchString) then + return true + end + + return false; +end + +function EventsAPIMixin:GetPayloadString(decorateOptionals, includeColorCodes) -- override + if self.Payload then + local values = {}; + for i, payloadInfo in ipairs(self.Payload) do + if includeColorCodes ~= false then + table.insert(values, ("%s|cff%s"):format(payloadInfo:GetPayloadString(decorateOptionals, includeColorCodes), self:GetLinkHexColor())); + else + table.insert(values, payloadInfo:GetPayloadString(decorateOptionals, includeColorCodes)); + end + end + return table.concat(values, ", "); + end + return ""; +end + +function EventsAPIMixin:GetDetailedOutputLines() -- override + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddSystemTag(lines); + self:AddDocumentationTags(lines); + + table.insert(lines, APIDocumentation:GetIndentString() .. "Literal Name: \"" .. self.LiteralName .. "\""); + + if self.Payload then + table.insert(lines, APIDocumentation:GetIndentString() .. "Payload"); + for i, payloadInfo in ipairs(self.Payload) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. ("%d. %s"):format(i, payloadInfo:GetSingleOutputLine())); + end + end + + return lines; +end \ No newline at end of file diff --git a/APIDocumentation/FieldsAPIMixin.lua b/APIDocumentation/FieldsAPIMixin.lua new file mode 100644 index 0000000..4713bcd --- /dev/null +++ b/APIDocumentation/FieldsAPIMixin.lua @@ -0,0 +1,87 @@ +local addonName, Private = ... + +FieldsAPIMixin = Private.CreateFromMixins(BaseAPIMixin); + +function FieldsAPIMixin:GetParentName() + if self.Function then + return self.Function:GetName(); + end + + if self.Table then + return self.Table:GetName(); + end + return ""; +end + +function FieldsAPIMixin:GetType() + return "field"; +end + +function FieldsAPIMixin:GetLinkHexColor() + return "ffdd55"; +end + +function FieldsAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + return false; +end + +function FieldsAPIMixin:GetLuaType() + if self.InnerType then + local complexType = APIDocumentation:FindAPIByName("table", self.InnerType); + return ("%s of %s"):format(self.Type, complexType and complexType:GenerateAPILink() or self.InnerType) + end + + if self.EnumValue then + return self.EnumValue; + end + + local complexType = APIDocumentation:FindAPIByName("table", self.Type); + return complexType and complexType:GenerateAPILink() or self.Type; +end + +function FieldsAPIMixin:GetStrideIndex() + return self.StrideIndex; +end + +function FieldsAPIMixin:IsOptional() + return self.Default ~= nil or self.Nilable; +end + +function FieldsAPIMixin:GetSingleOutputLine() + local optionalString = ""; + if self:IsOptional() then + if self.Default ~= nil then + optionalString = ("(default:%s) "):format(tostring(self.Default)); + else + optionalString = "(optional) "; + end + end + if self.Documentation then + return ("%s%s %s - %s"):format(optionalString, self:GetLuaType(), self:GenerateAPILink(), table.concat(self.Documentation, " ")); + end + return ("%s%s %s"):format(optionalString, self:GetLuaType(), self:GenerateAPILink()); +end + +function FieldsAPIMixin:GetArgumentString(decorateOptionals, includeColorCodes) + local prefix = decorateOptionals ~= false and self:IsOptional() and "optional " or ""; + if includeColorCodes ~= false then + return ("|cff%s%s%s|r"):format(self:GetLinkHexColor(), prefix, self:GetName()); + end + return ("%s%s"):format(prefix, self:GetName()); +end + +function FieldsAPIMixin:GetReturnString(decorateOptionals, includeColorCodes) + return self:GetArgumentString(decorateOptionals, includeColorCodes); -- Nothing special currently +end + +function FieldsAPIMixin:GetPayloadString(decorateOptionals, includeColorCodes) + return self:GetReturnString(decorateOptionals, includeColorCodes); -- Nothing special currently +end \ No newline at end of file diff --git a/APIDocumentation/FunctionsAPIMixin.lua b/APIDocumentation/FunctionsAPIMixin.lua new file mode 100644 index 0000000..6aa6977 --- /dev/null +++ b/APIDocumentation/FunctionsAPIMixin.lua @@ -0,0 +1,114 @@ +local addonName, Private = ... + +FunctionsAPIMixin = Private.CreateFromMixins(BaseAPIMixin); + +function FunctionsAPIMixin:GetParentName() + if self.System then + return self.System:GetName(); + end + + return ""; +end + +function FunctionsAPIMixin:GetType() + return "function"; +end + +function FunctionsAPIMixin:GetLinkHexColor() + return "55ddff"; +end + +function FunctionsAPIMixin:GetFullName(decorateOptionals, includeColorCodes) + if self.System and self.System:GetNamespaceName() ~= "" then + return ("%s.%s(%s)"):format(self.System:GetNamespaceName(), self:GetName(), self:GetArgumentString(decorateOptionals, includeColorCodes)); + end + return ("%s(%s)"):format(self:GetName(), self:GetArgumentString(decorateOptionals, includeColorCodes)); +end + +function FunctionsAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + if self:MatchesAnyAPI(self.Arguments, searchString) then + return true + end + + if self:MatchesAnyAPI(self.Returns, searchString) then + return true + end + + return false; +end + +function FunctionsAPIMixin:GetArgumentString(decorateOptionals, includeColorCodes) + if self.Arguments then + local values = {}; + for i, argumentInfo in ipairs(self.Arguments) do + if includeColorCodes ~= false then + table.insert(values, ("%s|cff%s"):format(argumentInfo:GetArgumentString(decorateOptionals, includeColorCodes), self:GetLinkHexColor())); + else + table.insert(values, argumentInfo:GetArgumentString(decorateOptionals, includeColorCodes)); + end + end + return table.concat(values, ", "); + end + return ""; +end + +function FunctionsAPIMixin:GetReturnString(decorateOptionals, includeColorCodes) + if self.Returns then + local values = {}; + for i, returnInfo in ipairs(self.Returns) do + if includeColorCodes ~= false then + table.insert(values, ("%s|cff%s"):format(returnInfo:GetReturnString(decorateOptionals, includeColorCodes), self:GetLinkHexColor())); + else + table.insert(values, returnInfo:GetReturnString(decorateOptionals, includeColorCodes)); + end + end + return table.concat(values, ", "); + end + return ""; +end + +function FunctionsAPIMixin:GetClipboardString() + if self.Returns then + return ("local %s = %s"):format(self:GetReturnString(false, false), self:GetFullName(false, false)); + end + return self:GetFullName(false, false); +end + +function FunctionsAPIMixin:GetDetailedOutputLines() + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddSystemTag(lines); + self:AddDocumentationTags(lines); + + if self.Arguments then + table.insert(lines, APIDocumentation:GetIndentString() .. "Arguments"); + for i, argumentInfo in ipairs(self.Arguments) do + if argumentInfo:GetStrideIndex() == 1 then + table.insert(lines, APIDocumentation:GetIndentString(2) .. "(Variable arguments)"); + end + + table.insert(lines, APIDocumentation:GetIndentString(2) .. ("%d. %s"):format(i, argumentInfo:GetSingleOutputLine())); + end + end + + if self.Returns then + table.insert(lines, APIDocumentation:GetIndentString() .. "Returns"); + for i, returnInfo in ipairs(self.Returns) do + if returnInfo:GetStrideIndex() == 1 then + table.insert(lines, APIDocumentation:GetIndentString(2) .. "(Variable returns)"); + end + table.insert(lines, APIDocumentation:GetIndentString(2) .. ("%d. %s"):format(i, returnInfo:GetSingleOutputLine())); + end + end + + return lines; +end \ No newline at end of file diff --git a/APIDocumentation/SystemsAPIMixin.lua b/APIDocumentation/SystemsAPIMixin.lua new file mode 100644 index 0000000..bd65669 --- /dev/null +++ b/APIDocumentation/SystemsAPIMixin.lua @@ -0,0 +1,144 @@ +local addonName, Private = ... + +SystemsAPIMixin = Private.CreateFromMixins(BaseAPIMixin); + +function SystemsAPIMixin:GetType() + return "system"; +end + +function SystemsAPIMixin:GetLinkHexColor() + return "ff55dd"; +end + +function SystemsAPIMixin:GetNamespaceName() + return self.Namespace or ""; +end + +function SystemsAPIMixin:GetLoweredNamespaceName() + if not self.loweredNamespaceName then + self.loweredNamespaceName = self:GetNamespaceName():lower(); + end + return self.loweredNamespaceName; +end + +function SystemsAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + return false; +end + +function SystemsAPIMixin:GetSingleOutputLine() + if self.Namespace then + return ("%s %s (%s)"):format(self:GetPrettyType(), self:GenerateAPILink(), self.Namespace); + end + return BaseAPIMixin.GetSingleOutputLine(self); +end + +function SystemsAPIMixin:GetDetailedOutputLines() + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddDocumentationTags(lines); + + if self.Functions and #self.Functions > 0 then + table.insert(lines, APIDocumentation:GetIndentString() .. "Functions"); + for i, functionInfo in ipairs(self.Functions) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. functionInfo:GetSingleOutputLine()); + end + end + + if self.Events and #self.Events > 0 then + table.insert(lines, APIDocumentation:GetIndentString() .. "Events"); + for i, eventInfo in ipairs(self.Events) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. eventInfo:GetSingleOutputLine()); + end + end + + if self.Tables and #self.Tables > 0 then + table.insert(lines, APIDocumentation:GetIndentString() .. "Tables"); + for i, tableInfo in ipairs(self.Tables) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. tableInfo:GetSingleOutputLine()); + end + end + + return lines; +end + +function SystemsAPIMixin:MatchesName(name, parentName) + if BaseAPIMixin.MatchesName(self, name, parentName) then + return true; + end + + return name == self:GetNamespaceName(); +end + +function SystemsAPIMixin:MatchesNameCaseInsenstive(name, parentName) + if BaseAPIMixin.MatchesNameCaseInsenstive(self, name, parentName) then + return true; + end + + return name == self:GetLoweredNamespaceName(); +end + +function SystemsAPIMixin:FindAllAPIMatches(apiToSearchFor) + apiToSearchFor = apiToSearchFor:lower(); + + local matches = { + tables = {}, + functions = {}, + events = {}, + }; + + APIDocumentationMixin:AddAllMatches(self.Tables, matches.tables, apiToSearchFor); + APIDocumentationMixin:AddAllMatches(self.Functions, matches.functions, apiToSearchFor); + APIDocumentationMixin:AddAllMatches(self.Events, matches.events, apiToSearchFor); + + -- Only return something if we matched anything + for name, subTable in pairs(matches) do + if #subTable > 0 then + return matches; + end + end + + return nil; +end + +local function AddAll(apiContainer, matchesContainer) + if apiContainer then + for i, apiInfo in ipairs(apiContainer) do + table.insert(matchesContainer, apiInfo); + end + end +end + +function SystemsAPIMixin:ListAllAPI() + local allAPI = { + tables = {}, + functions = {}, + events = {}, + }; + + AddAll(self.Tables, allAPI.tables); + AddAll(self.Functions, allAPI.functions); + AddAll(self.Events, allAPI.events); + + return allAPI; +end + +function SystemsAPIMixin:GetNumTables() + return self.Tables and #self.Tables or 0; +end + +function SystemsAPIMixin:GetNumFunctions() + return self.Functions and #self.Functions or 0; +end + +function SystemsAPIMixin:GetNumEvents() + return self.Events and #self.Events or 0; +end \ No newline at end of file diff --git a/APIDocumentation/TablesAPIMixin.lua b/APIDocumentation/TablesAPIMixin.lua new file mode 100644 index 0000000..91701c0 --- /dev/null +++ b/APIDocumentation/TablesAPIMixin.lua @@ -0,0 +1,71 @@ +local addonName, Private = ... + +TablesAPIMixin = Private.CreateFromMixins(BaseAPIMixin); + +function TablesAPIMixin:GetParentName() + if self.System then + return self.System:GetName(); + end + + return ""; +end + +function TablesAPIMixin:GetType() + return "table"; +end + +function TablesAPIMixin:GetPrettyType() + return self.Type:lower(); +end + +function TablesAPIMixin:GetLinkHexColor() + return "55ffdd"; +end + +function TablesAPIMixin:GetFullName() -- override + if self.Type == "Enumeration" then + return ("Enum.%s"):format(self:GetName()); + end + + return BaseAPIMixin.GetFullName(self); +end + +function TablesAPIMixin:MatchesSearchString(searchString) + if self:GetLoweredName():match(searchString) then + return true; + end + + if self:MatchesAnyDocumentation(searchString) then + return true; + end + + if self:MatchesAnyAPI(self.Fields, searchString) then + return true + end + return false; +end + +function TablesAPIMixin:GetDetailedOutputLines() + local lines = {}; + table.insert(lines, self:GetSingleOutputLine()); + + self:AddSystemTag(lines); + self:AddDocumentationTags(lines); + + if self.Fields then + if self.Type == "Enumeration" then + table.insert(lines, APIDocumentation:GetIndentString() .. "Num Values: " .. self.NumValues); + table.insert(lines, APIDocumentation:GetIndentString() .. "Min Value: " .. self.MinValue); + table.insert(lines, APIDocumentation:GetIndentString() .. "Max Value: " .. self.MaxValue); + table.insert(lines, APIDocumentation:GetIndentString() .. "Values"); + else + table.insert(lines, APIDocumentation:GetIndentString() .. "Fields"); + end + + for i, fieldInfo in ipairs(self.Fields) do + table.insert(lines, APIDocumentation:GetIndentString(2) .. fieldInfo:GetSingleOutputLine()); + end + end + + return lines; +end \ No newline at end of file diff --git a/WeakAuras/Locales/zLocales.lua b/WeakAuras/Locales/zLocales.lua index 3f5eca1..7c5e099 100644 --- a/WeakAuras/Locales/zLocales.lua +++ b/WeakAuras/Locales/zLocales.lua @@ -6,6 +6,11 @@ local locale = GAME_LOCALE or GetLocale() -- Specializations, Creature Types, Creature Families, and Time Formats if (locale == "enUS" or locale == "enGB") then L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." + L["AddOn: APIDocumentation is %s."] = "AddOn: APIDocumentation is %s." + L["Please install it."] = "Please install it." + L["Please enable it in your AddOn list."] = "Please enable it in your AddOn list." + L["AddOn: APIDocumentation is not loaded correctly."] = "AddOn: APIDocumentation is not loaded correctly." + L["Affliction"] = "Affliction" L["Arcane"] = "Arcane" L["Arms"] = "Arms" @@ -114,7 +119,12 @@ if (locale == "enUS" or locale == "enGB") then elseif (locale == "deDE") then - --[[Translation missing --]] + L["AddOn: APIDocumentation is %s."] = "AddOn: APIDocumentation ist %s." + L["Please install it."] = "Bitte installiere es." + L["Please enable it in your AddOn list."] = "Bitte aktiviere es in deiner AddOn-Liste." + L["AddOn: APIDocumentation is not loaded correctly."] = "AddOn: APIDocumentation wurde nicht korrekt geladen." + + --[[Translation missing --]] L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." L["Affliction"] = "Gebrechen" L["Arcane"] = "Arkan" @@ -224,6 +234,11 @@ elseif (locale == "deDE") then elseif (locale == "esES") then + L["AddOn: APIDocumentation is %s."] = "AddOn: APIDocumentation está %s." + L["Please install it."] = "Por favor, instálalo." + L["Please enable it in your AddOn list."] = "Por favor, actívalo en tu lista de AddOns." + L["AddOn: APIDocumentation is not loaded correctly."] = "AddOn: APIDocumentation no se ha cargado correctamente." + L["Requires syncing the specialization via LibGroupTalents."] = "Requiere sincronizar la especialización mediante LibGroupTalents." L["Affliction"] = "Aflicción" L["Arcane"] = "Arcano" @@ -333,6 +348,11 @@ elseif (locale == "esES") then elseif (locale == "esMX") then + L["AddOn: APIDocumentation is %s."] = "AddOn: APIDocumentation está %s." + L["Please install it."] = "Por favor, instálalo." + L["Please enable it in your AddOn list."] = "Por favor, actívalo en tu lista de AddOns." + L["AddOn: APIDocumentation is not loaded correctly."] = "AddOn: APIDocumentation no se ha cargado correctamente." + L["Requires syncing the specialization via LibGroupTalents."] = "Requiere sincronizar la especialización mediante LibGroupTalents." L["Affliction"] = "Aflicción" L["Arcane"] = "Arcano" @@ -442,7 +462,12 @@ elseif (locale == "esMX") then elseif (locale == "frFR") then - --[[Translation missing --]] + L["AddOn: APIDocumentation is %s."] = "Addon: APIDocumentation est %s." + L["Please install it."] = "Veuillez l'installer." + L["Please enable it in your AddOn list."] = "Veuillez l'activer dans votre liste d'Addons." + L["AddOn: APIDocumentation is not loaded correctly."] = "Addon: APIDocumentation n'a pas été chargé correctement." + + --[[Translation missing --]] L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." L["Affliction"] = "Affliction" L["Arcane"] = "Arcane" @@ -552,7 +577,14 @@ elseif (locale == "frFR") then elseif (locale == "itIT") then - --[[Translation missing --]] + --[[Translation missing --]] + L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." + L["AddOn: APIDocumentation is %s."] = "AddOn: APIDocumentation is %s." + L["Please install it."] = "Please install it." + L["Please enable it in your AddOn list."] = "Please enable it in your AddOn list." + L["AddOn: APIDocumentation is not loaded correctly."] = "AddOn: APIDocumentation is not loaded correctly." + + --[[Translation missing --]] L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." L["Affliction"] = "Affliction" L["Arcane"] = "Arcane" @@ -664,6 +696,11 @@ elseif (locale == "itIT") then elseif (locale == "koKR") then + L["AddOn: APIDocumentation is %s."] = "애드온: APIDocumentation이(가) %s입니다." + L["Please install it."] = "설치해 주십시오." + L["Please enable it in your AddOn list."] = "애드온 목록에서 활성화해 주십시오." + L["AddOn: APIDocumentation is not loaded correctly."] = "애드온: APIDocumentation이(가) 제대로 로드되지 않았습니다." + L["Requires syncing the specialization via LibGroupTalents."] = "LibGroupTalents을 통해 전문화를 동기화해야 합니다." L["Affliction"] = "고통" L["Arcane"] = "비전" @@ -773,7 +810,14 @@ elseif (locale == "koKR") then elseif (locale == "ptBR") then - --[[Translation missing --]] + --[[Translation missing --]] + L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." + L["AddOn: APIDocumentation is %s."] = "AddOn: APIDocumentation is %s." + L["Please install it."] = "Please install it." + L["Please enable it in your AddOn list."] = "Please enable it in your AddOn list." + L["AddOn: APIDocumentation is not loaded correctly."] = "AddOn: APIDocumentation is not loaded correctly." + + --[[Translation missing --]] L["Requires syncing the specialization via LibGroupTalents."] = "Requires syncing the specialization via LibGroupTalents." L["Affliction"] = "Affliction" L["Arcane"] = "Arcane" @@ -883,6 +927,11 @@ elseif (locale == "ptBR") then elseif (locale == "ruRU") then + L["AddOn: APIDocumentation is %s."] = "Аддон: APIDocumentation %s." + L["Please install it."] = "Пожалуйста, установите его." + L["Please enable it in your AddOn list."] = "Пожалуйста, включите его в вашем списке аддонов." + L["AddOn: APIDocumentation is not loaded correctly."] = "Аддон: APIDocumentation загружен некорректно." + L["Requires syncing the specialization via LibGroupTalents."] = "Требуется синхронизация специализации через LibGroupTalents." L["Affliction"] = "Колдовство" L["Arcane"] = "Тайная магия" @@ -992,6 +1041,11 @@ elseif (locale == "ruRU") then elseif (locale == "zhCN") then + L["AddOn: APIDocumentation is %s."] = "插件：APIDocumentation %s。" + L["Please install it."] = "请安装它。" + L["Please enable it in your AddOn list."] = "请在你的插件列表中启用它。" + L["AddOn: APIDocumentation is not loaded correctly."] = "插件：APIDocumentation 未正确加载。" + L["Requires syncing the specialization via LibGroupTalents."] = "需要通过LibGroupTalents同步专精。" L["Affliction"] = "痛苦" L["Arcane"] = "奥术" @@ -1101,6 +1155,11 @@ elseif (locale == "zhCN") then elseif (locale == "zhTW") then + L["AddOn: APIDocumentation is %s."] = "插件：APIDocumentation %s。" + L["Please install it."] = "請安裝它。" + L["Please enable it in your AddOn list."] = "請在你的插件清單中啟用它。" + L["AddOn: APIDocumentation is not loaded correctly."] = "插件：APIDocumentation 未正確載入。" + L["Requires syncing the specialization via LibGroupTalents."] = "需要透由LibGroupTalents同步專精。" L["Affliction"] = "痛苦" L["Arcane"] = "秘法" diff --git a/WeakAurasOptions/OptionsFrames/TextEditor.lua b/WeakAurasOptions/OptionsFrames/TextEditor.lua index 17e31cf..4ec9ee6 100644 --- a/WeakAurasOptions/OptionsFrames/TextEditor.lua +++ b/WeakAurasOptions/OptionsFrames/TextEditor.lua @@ -417,25 +417,15 @@ local function ConstructTextEditor(frame) end end + local apiSearchFrame + -- Make sidebar for snippets local snippetsFrame = CreateFrame("Frame", "WeakAurasSnippets", group.frame, "WA_PortraitFrameTemplate") snippetsFrame:HidePortrait() snippetsFrame:SetPoint("TOPLEFT", group.frame, "TOPRIGHT", 20, 0) snippetsFrame:SetPoint("BOTTOMLEFT", group.frame, "BOTTOMRIGHT", 20, 0) snippetsFrame:SetWidth(250) - --[[ - snippetsFrame:SetBackdrop( - { - bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background", - edgeFile = "Interface\\DialogFrame\\UI-DialogBox-Border", - tile = true, - tileSize = 32, - edgeSize = 32, - insets = {left = 8, right = 8, top = 8, bottom = 8} - } - ) - snippetsFrame:SetBackdropColor(0, 0, 0, 1) - ]] + -- Add button to save new snippet local AddSnippetButton = CreateFrame("Button", nil, snippetsFrame, "UIPanelButtonTemplate") AddSnippetButton:SetPoint("TOPLEFT", snippetsFrame, "TOPLEFT", 13, -25) @@ -472,6 +462,9 @@ local function ConstructTextEditor(frame) function(self, button, down) if not snippetsFrame:IsShown() then snippetsFrame:Show() + if apiSearchFrame and apiSearchFrame:IsShown() then + apiSearchFrame:Hide() + end UpdateSnippets(snippetsScroll) else snippetsFrame:Hide() @@ -502,6 +495,288 @@ local function ConstructTextEditor(frame) end ) + -- Make ApiSearch button + local apiSearchButton = CreateFrame("Button", "WAAPISearchButton", group.frame, "UIPanelButtonTemplate") + apiSearchButton:SetPoint("BOTTOMRIGHT", editor.frame, "TOPRIGHT", -20, 15) + apiSearchButton:SetFrameLevel(group.frame:GetFrameLevel() + 2) + apiSearchButton:SetHeight(20) + apiSearchButton:SetWidth(100) + apiSearchButton:SetText(L["Search API"]) + apiSearchButton:RegisterForClicks("LeftButtonUp") + + -- Make sidebar for apiSearch + apiSearchFrame = CreateFrame("Frame", "WeakAurasAPISearchFrame", group.frame, "WA_PortraitFrameTemplate") + apiSearchFrame:HidePortrait() + apiSearchFrame:SetWidth(350) + + local makeAPISearch + local APISearchTextChangeDelay = 0.3 + local APISearchCTimer + + -- filter line + local filterInput = CreateFrame("EditBox", "WeakAurasAPISearchFilterInput", apiSearchFrame, "WA_InputBoxTemplate") + filterInput:SetAutoFocus(false) + filterInput:SetTextInsets(16, 20, 0, 0) + + filterInput.Instructions = filterInput:CreateFontString(nil, "ARTWORK", "GameFontDisableSmall") + filterInput.Instructions:SetText(SEARCH) + filterInput.Instructions:SetPoint("TOPLEFT", filterInput, "TOPLEFT", 16, 0) + filterInput.Instructions:SetPoint("BOTTOMRIGHT", filterInput, "BOTTOMRIGHT", -20, 0) + filterInput.Instructions:SetTextColor(0.35, 0.35, 0.35) + filterInput.Instructions:SetJustifyH("LEFT") + filterInput.Instructions:SetJustifyV("MIDDLE") + + filterInput.searchIcon = filterInput:CreateTexture(nil, "OVERLAY") + filterInput.searchIcon:SetTexture("Interface\\Common\\UI-Searchbox-Icon") + filterInput.searchIcon:SetVertexColor(0.6, 0.6, 0.6) + filterInput.searchIcon:SetSize(14, 14) + filterInput.searchIcon:SetPoint("LEFT", 0, -2) + + filterInput.clearButton = CreateFrame("Button", nil, filterInput) + filterInput.clearButton:SetSize(14, 14) + filterInput.clearButton:SetPoint("RIGHT", -3, 0) + + filterInput.clearButton.texture = filterInput.clearButton:CreateTexture() + filterInput.clearButton.texture:SetTexture("Interface\\FriendsFrame\\ClearBroadcastIcon") + filterInput.clearButton.texture:SetAlpha(0.5) + filterInput.clearButton.texture:SetSize(17, 17) + filterInput.clearButton.texture:SetPoint("CENTER", 0, 0) + + filterInput.clearButton:SetScript("OnEnter", function(self) self.texture:SetAlpha(1.0) end) + filterInput.clearButton:SetScript("OnLeave", function(self) self.texture:SetAlpha(0.5) end) + filterInput.clearButton:SetScript("OnMouseDown", function(self) if self:IsEnabled() then self.texture:SetPoint("CENTER", 1, -1) end end) + filterInput.clearButton:SetScript("OnMouseUp", function(self) self.texture:SetPoint("CENTER") end) + filterInput.clearButton:SetScript("OnClick", function(self) + local editBox = self:GetParent() + editBox:SetText("") + editBox:ClearFocus() + end) + filterInput:SetScript("OnEditFocusLost", function(self) + if self:GetText() == "" then + self.searchIcon:SetVertexColor(0.6, 0.6, 0.6) + self.clearButton:Hide() + end + end) + filterInput:SetScript("OnEditFocusGained", function(self) + self.searchIcon:SetVertexColor(1.0, 1.0, 1.0) + self.clearButton:Show() + end) + filterInput:SetScript("OnTextChanged", function(self) + if APISearchCTimer and WeakAuras.timer:TimeLeft(APISearchCTimer) then + WeakAuras.timer:CancelTimer(APISearchCTimer) + end + APISearchCTimer = WeakAuras.timer:ScheduleTimer( + function() + makeAPISearch(filterInput:GetText()) + end, + APISearchTextChangeDelay + ) + end) + filterInput:HookScript("OnTextChanged", function(self) + if not self:HasFocus() and self:GetText() == "" then + self.searchIcon:SetVertexColor(0.6, 0.6, 0.6) + self.clearButton:Hide() + else + self.searchIcon:SetVertexColor(1.0, 1.0, 1.0) + self.clearButton:Show() + end + if self:GetText() == "" then + self.Instructions:Show() + else + self.Instructions:Hide() + end + end) + filterInput:SetHeight(15) + filterInput:SetPoint("TOPLEFT", apiSearchFrame, "TOPLEFT", 17, -30) + filterInput:SetPoint("TOPRIGHT", apiSearchFrame, "TOPRIGHT", -10, -30) + filterInput:SetFont(STANDARD_TEXT_FONT, 10) + + local apiSearchScrollContainer = AceGUI:Create("SimpleGroup") + apiSearchScrollContainer:SetFullWidth(true) + apiSearchScrollContainer:SetFullHeight(true) + apiSearchScrollContainer:SetLayout("Fill") + apiSearchScrollContainer.frame:SetParent(apiSearchFrame) + apiSearchScrollContainer.frame:SetPoint("TOPLEFT", apiSearchFrame, "TOPLEFT", 17, -50) + apiSearchScrollContainer.frame:SetPoint("BOTTOMRIGHT", apiSearchFrame, "BOTTOMRIGHT", -10, 10) + + local apiSearchScroll = AceGUI:Create("ScrollFrame") + apiSearchScroll:SetLayout("List") + apiSearchScrollContainer:AddChild(apiSearchScroll) + apiSearchScroll:FixScroll(true) + apiSearchScroll.scrollframe:SetScript( + "OnScrollRangeChanged", + function(frame) + frame.obj:DoLayout() + end + ) + + local snippetOnClickCallback = function(self) + if self.isSystem then + filterInput:SetText(self.name) + else + self.editor.editBox:Insert(self.name) + self.editor:SetFocus() + end + end + + local function loadBlizzardAPIDocumentation() + local apiAddonName = "APIDocumentation" + local _, loaded = IsAddOnLoaded(apiAddonName) + if not loaded then + local ok, ret = LoadAddOn(apiAddonName) + if not ok then + local messages = { L["AddOn: APIDocumentation is %s."]:format(ret) } + if ret == "DISABLED" then + table.insert(messages, L["Please enable it in your AddOn list."]) + elseif ret == "MISSING" then + table.insert(messages, L["Please install it."]) + end + WeakAuras.prettyPrint(table.concat(messages, " ")) + return + end + end + if type(APIDocumentation) ~= "table" or type(APIDocumentation.systems) ~= "table" then + WeakAuras.prettyPrint(L["AddOn: APIDocumentation is not loaded correctly."]) + return + end + if #APIDocumentation.systems == 0 then + APIDocumentation:OnLoad() + end + return true + end + + local function addLine(results, apiInfo) + local name + if apiInfo.Type == "System" then + name = apiInfo.Namespace + elseif apiInfo.Type == "Function" then + name = apiInfo:GetFullName() + elseif apiInfo.Type == "Event" then + name = apiInfo.LiteralName + end + table.insert(results, { name = name, apiInfo = apiInfo }) + end + + local function APIListSystems() + local results = {} + for i, systemInfo in ipairs(APIDocumentation.systems) do + if systemInfo.Namespace and #systemInfo.Functions > 0 then + addLine(results, systemInfo) + end + end + table.sort(results, function(a, b) + return a.name < b.name + end) + return results + end + + local function APISearch(word) + local lowerWord = word:lower() + local results = {} + + -- if search match name of namespace, show all functions & events for the namespace, and also show all other functions & events matching the search + -- if search is composed with name of a namespace and a word separated by a dot, show matching function for matching namespace + + local nsName, rest = lowerWord:match("^([%w%_]+)(.*)") + local funcName = rest and rest:match("^%.([%w%_]+)") + + for _, systemInfo in ipairs(APIDocumentation.systems) do + -- search for namespaceName or namespaceName.functionName + local systemMatch = nsName and #nsName >= 4 + and systemInfo.Namespace and systemInfo.Namespace:lower():match(nsName) + + for _, apiInfo in ipairs(systemInfo.Functions) do + if systemMatch then + if funcName then + if apiInfo:MatchesSearchString(funcName) then + addLine(results, apiInfo) + end + else + addLine(results, apiInfo) + end + else + if apiInfo:MatchesSearchString(lowerWord) then + addLine(results, apiInfo) + end + end + end + + if systemMatch and rest == "" then + for _, apiInfo in ipairs(systemInfo.Events) do + addLine(results, apiInfo) + end + else + for _, apiInfo in ipairs(systemInfo.Events) do + if apiInfo:MatchesSearchString(lowerWord) then + addLine(results, apiInfo) + end + end + end + end + + return results + end + + local lastSearch = nil + makeAPISearch = function(apiToSearchFor) + if not loadBlizzardAPIDocumentation() then + return + end + local results + if not apiToSearchFor or #apiToSearchFor < 4 then + if lastSearch == "" then return end + results = APIListSystems() + lastSearch = "" + else + if lastSearch == apiToSearchFor then return end + results = APISearch(apiToSearchFor) + lastSearch = apiToSearchFor + end + apiSearchScroll:ReleaseChildren() + for _, element in ipairs(results) do + local apiInfo = element.apiInfo + if apiInfo then + local button = AceGUI:Create("WeakAurasSnippetButton") + button:SetTitle(element.name) + button:SetEditable(false) + button:SetHeight(20) + button:SetRelativeWidth(1) + if apiInfo.Type ~= "System" and apiInfo.GetDetailedOutputLines then + local desc = table.concat(apiInfo:GetDetailedOutputLines(), "\n") + button:SetDescription(desc) + else + button:SetDescription() + end + button.name = element.name + button.editor = editor + button.isSystem = apiInfo.Type == "System" + button:SetCallback("OnClick", snippetOnClickCallback) + apiSearchScroll:AddChild(button) + end + end + end + + apiSearchFrame:Hide() + + -- Toggle the side bar on click + apiSearchButton:SetScript( + "OnClick", + function() + if apiSearchFrame:IsShown() then + apiSearchFrame:Hide() + else + apiSearchFrame:Show() + apiSearchFrame:ClearAllPoints() + apiSearchFrame:SetPoint("TOPLEFT", group.frame, "TOPRIGHT", 20, 0) + apiSearchFrame:SetPoint("BOTTOMLEFT", group.frame, "BOTTOMRIGHT", 20, 0) + filterInput:SetFocus() + if snippetsFrame and snippetsFrame:IsShown() then + snippetsFrame:Hide() + end + end + end + ) + editor.editBox.timeMachine = {} editor.editBox.timeMachinePos = 1 local TimeMachineMaximumRollback = 10