C_MountJournal

namespaceavailable in: camelot

Status in wowlua

50 functions: 19 implemented, 3 recorded, 28 guessed. 4 events, 2 of them fired by the emulator on its own.

Functions

function	what it does	status
`ApplyMountEquipment`	Applies a mount equipment item to the player's mounts and returns whether it worked. · by wowlua `(itemLocation: ItemLocationMixin): boolean`	guessed
`AreMountEquipmentEffectsSuppressed`	Whether the applied mount equipment's effects are suppressed. · by wowlua `(): boolean`	guessed
`ClearFanfare`	Marks a new mount as seen so it stops showing as new. · by wowlua `(mountID: number)`	guessed
`ClearRecentFanfares`	Marks all new mounts as seen. · by wowlua `()`	guessed
`Dismiss`	Dismisses the currently summoned mount. `()`	guessed
`GetAllCreatureDisplayIDsForMountID`	Returns the IDs of all the looks a mount can have. · by wowlua `(mountID: number): number[]`	implemented
`GetAppliedMountEquipmentID`	Returns the ID of the applied mount equipment. · by wowlua `(): number?`	guessed
`GetCollectedDragonridingMounts`	Returns the IDs of the player's collected skyriding mounts. · by wowlua `(): number[]`	guessed
`GetCollectedFilterSetting`	Indicates whether the specified mount journal filter is enabled. `(filterIndex: number): boolean`	guessed
`GetDisplayedMountAllCreatureDisplayInfo`	Returns the display IDs for a mount. `(mountIndex: number): MountCreatureDisplayInfo[]?`	implemented
`GetDisplayedMountID`	Returns the ID of a mount in the mount journal's filtered list, or 0 past its end. · by wowlua `(displayIndex: number): number`	implemented
`GetDisplayedMountInfo`	Returns information about a mount in the mount journal's filtered list. · by wowlua `(displayIndex: number): (string?, number?, number?, boolean?, boolean?, number?, boolean?, boolean?, PvPFaction?, boolean?, boolean?, number?, boolean?)`	implemented
`GetDisplayedMountInfoExtra`	Returns more information about a mount in the mount journal's filtered list, such as its description and source. · by wowlua `(mountIndex: number): (number?, string?, string?, boolean?, number?, number?, number?, number?, boolean?)`	implemented
`GetDynamicFlightModeSpellID`	Returns the ID of the spell that switches between skyriding and steady flight. · by wowlua `(): number`	recorded
`GetIsFavorite`	Indicates whether the specified mount is marked as a favorite. `(mountIndex: number): (boolean, boolean)`	implemented
`GetMountAllCreatureDisplayInfoByID`	Returns the display IDs for a mount. `(mountID: number): MountCreatureDisplayInfo[]?`	implemented
`GetMountEquipmentUnlockLevel`	Returns the level at which mount equipment unlocks. · by wowlua `(): number`	guessed
`GetMountFromItem`	Returns the mount for an item ID. `(itemID: number): number?`	implemented
`GetMountFromSpell`	Returns the mount for a spell ID. `(spellID: SpellIdentifier): number?`	implemented
`GetMountIDs`	Returns the IDs of mounts listed in the mount journal. `(): number[]`	implemented
`GetMountInfoByID`	Returns information about the specified mount. `(mountID: number): (string?, number?, number?, boolean?, boolean?, number?, boolean?, boolean?, PvPFaction?, boolean?, boolean?, number?, boolean?)`	implemented
`GetMountInfoExtraByID`	Returns extra information about the specified mount. `(mountID: number): (number?, string?, string?, boolean?, number?, number?, number?, number?, boolean?)`	implemented
`GetMountLink`	Returns the link of a mount. · by wowlua `(spellID: number): string?`	guessed
`GetMountUsabilityByID`	Returns if a mount is currently usable by the player. `(mountID: number, checkIndoors: boolean): (boolean?, string?)`	implemented
`GetNumDisplayedMounts`	Returns the number of (filtered) mounts shown in the mount journal. `(): number`	implemented
`GetNumMounts`	Returns the number of mounts listed in the mount journal. `(): number`	implemented
`GetNumMountsNeedingFanfare`	Returns the number of new mounts not yet seen. · by wowlua `(): number`	implemented
`HasDisplayableMount`	Whether the mount journal has any mount to show. · by wowlua `(): boolean`	implemented
`IsDragonridingUnlocked`	Returns whether the player has unlocked the ability to switch between Skyriding and steady flight styles for flying mounts . `(): boolean`	recorded
`IsItemMountEquipment`	Determines if the item is mount equipment based on its class and subclass. `(itemLocation: ItemLocationMixin): boolean`	guessed
`IsMountEquipmentApplied`	Whether mount equipment is applied. · by wowlua `(): boolean`	guessed
`IsSourceChecked`	Whether a source filter of the mount journal is checked. · by wowlua `(filterIndex: number): boolean`	guessed
`IsTypeChecked`	Whether a type filter of the mount journal is checked. · by wowlua `(filterIndex: number): boolean`	guessed
`IsUsingDefaultFilters`	Whether the mount journal uses its default filters. · by wowlua `(): boolean`	guessed
`IsValidSourceFilter`	Whether a source filter of the mount journal exists. · by wowlua `(filterIndex: number): boolean`	guessed
`IsValidTypeFilter`	Whether a type filter of the mount journal exists. · by wowlua `(filterIndex: number): boolean`	guessed
`MountEquipmentAvailable`	Whether mount equipment is available to the player. · by wowlua `(): boolean`	recorded
`NeedsFanfare`	Whether a mount is new and not yet seen. · by wowlua `(mountID: number): boolean`	guessed
`Pickup`	Picks up the specified mount onto the cursor, usually in preparation for placing it on an action button. `(displayIndex: number)`	guessed
`PickupDynamicFlightMode`	Puts the skyriding and steady flight switch on the cursor. · by wowlua `()`	guessed
`SetAllSourceFilters`	Checks or unchecks all source filters of the mount journal. · by wowlua `(isChecked: boolean)`	guessed
`SetAllTypeFilters`	Checks or unchecks all type filters of the mount journal. · by wowlua `(isChecked: boolean)`	guessed
`SetCollectedFilterSetting`	Enables or disables the specified mount journal filter. `(filterIndex: number, isChecked: boolean)`	implemented
`SetDefaultFilters`	Resets the mount journal's filters to their defaults. · by wowlua `()`	guessed
`SetIsFavorite`	Marks or unmarks the specified mount as a favorite. `(mountIndex: number, isFavorite: boolean)`	implemented
`SetSearch`	Filters the mount journal by a search text. · by wowlua `(searchValue: string)`	guessed
`SetSourceFilter`	Checks or unchecks a source filter of the mount journal. · by wowlua `(filterIndex: number, isChecked: boolean)`	guessed
`SetTypeFilter`	Checks or unchecks a type filter of the mount journal. · by wowlua `(filterIndex: number, isChecked: boolean)`	guessed
`SummonByID`	Summons the specified mount. `(mountID: number)`	guessed
`SwapDynamicFlightMode`	Switches between skyriding and steady flight. · by wowlua `()`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`MOUNT_EQUIPMENT_APPLY_RESULT`	`success: boolean`	not implemented
`MOUNT_JOURNAL_SEARCH_UPDATED`	`no payload`	implemented
`MOUNT_JOURNAL_USABILITY_CHANGED`	`no payload`	implemented
`NEW_MOUNT_ADDED`	`mountID: number`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("MOUNT_EQUIPMENT_APPLY_RESULT").

Structures

MountCreatureDisplayInfo · creatureDisplayID, isVisible
MountInfo · name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction?, shouldHideOnChar, isCollected, mountID, isSteadyFlight
MountInfoExtra · creatureDisplayInfoID?, description, source, isSelfMount, mountTypeID, uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (MountJournal system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.