local PetJournalInfo = { Name = "PetJournalInfo", Type = "System", Namespace = "C_PetJournal", Environment = "All", Functions = { { Name = "ClearHoveredBattlePet", Type = "Function", }, { Name = "ClearSearchFilter", Type = "Function", }, { Name = "DismissSummonedPet", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "petID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "GetDisplayIDByIndex", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "speciesID", Type = "number", Nilable = false }, { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { { Name = "displayID", Type = "number", Nilable = true }, }, }, { Name = "GetDisplayProbabilityByIndex", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "speciesID", Type = "number", Nilable = false }, { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { { Name = "displayProbability", Type = "number", Nilable = true }, }, }, { Name = "GetNonBattlePetLinkByIndex", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "index", Type = "luaIndex", Nilable = false }, }, Returns = { { Name = "link", Type = "cstring", Nilable = false }, }, }, { Name = "GetNumDisplays", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "speciesID", Type = "number", Nilable = false }, }, Returns = { { Name = "numDisplays", Type = "number", Nilable = true }, }, }, { Name = "GetNumPetsInJournal", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "creatureID", Type = "number", Nilable = false }, }, Returns = { { Name = "maxAllowed", Type = "number", Nilable = false }, { Name = "numPets", Type = "number", Nilable = false }, }, }, { Name = "GetOwnedPetIDs", Type = "Function", Returns = { { Name = "ownedPetIDs", Type = "table", InnerType = "WOWGUID", Nilable = false }, }, }, { Name = "GetPetAbilityInfo", Type = "Function", MayReturnNothing = true, SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "abilityID", Type = "number", Nilable = false }, }, Returns = { { Name = "name", Type = "string", Nilable = false }, { Name = "icon", Type = "fileID", Nilable = false }, { Name = "petType", Type = "number", Nilable = false }, }, }, { Name = "GetPetAbilityListTable", Type = "Function", MayReturnNothing = true, SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "speciesID", Type = "number", Nilable = false }, }, Returns = { { Name = "info", Type = "table", InnerType = "PetAbilityLevelInfo", Nilable = false }, }, }, { Name = "GetPetInfoTableByPetID", Type = "Function", MayReturnNothing = true, SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "petID", Type = "WOWGUID", Nilable = false }, }, Returns = { { Name = "info", Type = "PetJournalPetInfo", Nilable = false }, }, }, { Name = "GetPetInfoTableBySpeciesID", Type = "Function", MayReturnNothing = true, SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "speciesID", Type = "number", Nilable = false }, }, Returns = { { Name = "petInfo", Type = "PetJournalPetInfo", Nilable = false }, }, }, { Name = "GetPetLoadOutInfo", Type = "Function", MayReturnNothing = true, SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "slot", Type = "luaIndex", Nilable = false }, }, Returns = { { Name = "petID", Type = "WOWGUID", Nilable = true }, { Name = "ability1ID", Type = "number", Nilable = false }, { Name = "ability2ID", Type = "number", Nilable = false }, { Name = "ability3ID", Type = "number", Nilable = false }, { Name = "locked", Type = "bool", Nilable = false }, }, }, { Name = "GetPetSummonInfo", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, Returns = { { Name = "isSummonable", Type = "bool", Nilable = false }, { Name = "error", Type = "PetJournalError", Nilable = false }, { Name = "errorText", Type = "cstring", Nilable = false }, }, }, { Name = "GetSearchFilter", Type = "Function", Returns = { { Name = "filterText", Type = "cstring", Nilable = false }, }, }, { Name = "HasFavoritePets", Type = "Function", Returns = { { Name = "hasFavorites", Type = "bool", Nilable = false }, }, }, { Name = "IsCurrentlySummoned", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "petID", Type = "WOWGUID", Nilable = false }, }, Returns = { { Name = "isSummoned", Type = "bool", Nilable = false }, }, }, { Name = "IsUsingDefaultFilters", Type = "Function", Returns = { { Name = "isUsingDefaultFilters", Type = "bool", Nilable = false }, }, }, { Name = "PetIsSummonable", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, Returns = { { Name = "isSummonable", Type = "bool", Nilable = false }, }, }, { Name = "PetUsesRandomDisplay", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "speciesID", Type = "number", Nilable = false }, }, Returns = { { Name = "usesRandomDisplay", Type = "bool", Nilable = true }, }, }, { Name = "SetDefaultFilters", Type = "Function", }, { Name = "SetHoveredBattlePet", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "SetSearchFilter", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "filterText", Type = "cstring", Nilable = false }, }, }, { Name = "SpellTargetBattlePet", Type = "Function", SecretArguments = "AllowedWhenUntainted", Arguments = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, }, Events = { { Name = "BattlepetForceNameDeclension", Type = "Event", LiteralName = "BATTLEPET_FORCE_NAME_DECLENSION", SynchronousEvent = true, Payload = { { Name = "name", Type = "cstring", Nilable = false }, { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "CompanionLearned", Type = "Event", LiteralName = "COMPANION_LEARNED", SynchronousEvent = true, }, { Name = "CompanionUnlearned", Type = "Event", LiteralName = "COMPANION_UNLEARNED", SynchronousEvent = true, }, { Name = "CompanionUpdate", Type = "Event", LiteralName = "COMPANION_UPDATE", SynchronousEvent = true, Payload = { { Name = "companionType", Type = "cstring", Nilable = true }, }, }, { Name = "NewPetAdded", Type = "Event", LiteralName = "NEW_PET_ADDED", SynchronousEvent = true, Payload = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "PetJournalAutoSlottedPet", Type = "Event", LiteralName = "PET_JOURNAL_AUTO_SLOTTED_PET", SynchronousEvent = true, Payload = { { Name = "slotIndex", Type = "number", Nilable = false }, { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "PetJournalCageFailed", Type = "Event", LiteralName = "PET_JOURNAL_CAGE_FAILED", SynchronousEvent = true, }, { Name = "PetJournalListUpdate", Type = "Event", LiteralName = "PET_JOURNAL_LIST_UPDATE", SynchronousEvent = true, UniqueEvent = true, }, { Name = "PetJournalNewBattleSlot", Type = "Event", LiteralName = "PET_JOURNAL_NEW_BATTLE_SLOT", SynchronousEvent = true, }, { Name = "PetJournalPetDeleted", Type = "Event", LiteralName = "PET_JOURNAL_PET_DELETED", SynchronousEvent = true, Payload = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "PetJournalPetRestored", Type = "Event", LiteralName = "PET_JOURNAL_PET_RESTORED", SynchronousEvent = true, Payload = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "PetJournalPetRevoked", Type = "Event", LiteralName = "PET_JOURNAL_PET_REVOKED", SynchronousEvent = true, Payload = { { Name = "battlePetGUID", Type = "WOWGUID", Nilable = false }, }, }, { Name = "PetJournalPetsHealed", Type = "Event", LiteralName = "PET_JOURNAL_PETS_HEALED", SynchronousEvent = true, }, { Name = "PetJournalTrapLevelSet", Type = "Event", LiteralName = "PET_JOURNAL_TRAP_LEVEL_SET", SynchronousEvent = true, Payload = { { Name = "trapLevel", Type = "number", Nilable = false }, }, }, { Name = "UpdateSummonpetsAction", Type = "Event", LiteralName = "UPDATE_SUMMONPETS_ACTION", SynchronousEvent = true, }, }, Tables = { { Name = "PetJournalError", Type = "Enumeration", NumValues = 6, MinValue = 0, MaxValue = 5, Fields = { { Name = "None", Type = "PetJournalError", EnumValue = 0 }, { Name = "PetIsDead", Type = "PetJournalError", EnumValue = 1 }, { Name = "JournalIsLocked", Type = "PetJournalError", EnumValue = 2 }, { Name = "InvalidFaction", Type = "PetJournalError", EnumValue = 3 }, { Name = "NoFavoritesToSummon", Type = "PetJournalError", EnumValue = 4 }, { Name = "NoValidRandomSummon", Type = "PetJournalError", EnumValue = 5 }, }, }, { Name = "PetAbilityLevelInfo", Type = "Structure", Fields = { { Name = "abilityID", Type = "number", Nilable = false }, { Name = "level", Type = "number", Nilable = false }, }, }, { Name = "PetJournalPetInfo", Type = "Structure", Fields = { { Name = "speciesID", Type = "number", Nilable = false }, { Name = "customName", Type = "cstring", Nilable = true }, { Name = "petLevel", Type = "number", Nilable = true }, { Name = "xp", Type = "number", Nilable = true }, { Name = "maxXP", Type = "number", Nilable = true }, { Name = "displayID", Type = "number", Nilable = true }, { Name = "isFavorite", Type = "bool", Nilable = true }, { Name = "icon", Type = "fileID", Nilable = false }, { Name = "petType", Type = "luaIndex", Nilable = false }, { Name = "creatureID", Type = "number", Nilable = false }, { Name = "name", Type = "cstring", Nilable = true }, { Name = "sourceText", Type = "cstring", Nilable = false }, { Name = "description", Type = "cstring", Nilable = false }, { Name = "isWild", Type = "bool", Nilable = true }, { Name = "canBattle", Type = "bool", Nilable = false }, { Name = "tradable", Type = "bool", Nilable = false }, { Name = "unique", Type = "bool", Nilable = false }, { Name = "obtainable", Type = "bool", Nilable = false }, { Name = "canAttachToDecor", Type = "bool", Nilable = false }, { Name = "creatureModelScale", Type = "number", Nilable = true }, }, }, }, Predicates = { }, }; APIDocumentation:AddDocumentationTable(PetJournalInfo);