v0.13.8

C_PaperDollInfo

namespaceavailable in: camelot

Status in wowlua

21 functions: 2 implemented, 3 recorded, 16 guessed. 23 events, 12 of them fired by the emulator on its own.

Functions

functionwhat it doesstatus
AmmoNeededWhether the player's ranged weapon uses ammunition. · by wowlua
(): boolean
recorded
CanAutoEquipCursorItemWhether the item on the cursor can be equipped automatically. · by wowlua
(): boolean
guessed
CancelTemporaryEnchantmentCancels active temporary enchantments on inventory slot items.
(slot: LuaInventorySlot)
guessed
CursorCanGoInSlotWhether the item on the cursor can go in an equipment slot. · by wowlua
(slotIndex: number): boolean
guessed
GetArmorEffectivenessReturns how much damage an armor value prevents against an attacker of a level. · by wowlua
(armor: number, attackerLevel: number): number
guessed
GetArmorEffectivenessAgainstTargetReturns how much damage an armor value prevents against the player's target. · by wowlua
(armor: number): number?
guessed
GetInspectAzeriteItemEmpoweredChoicesReturns the azerite powers chosen on an inspected unit's item. · by wowlua
(unit: string, equipmentSlotIndex: number): number[]?
guessed
GetInspectGuildInfoReturns guild information for the inspected unit: its achievement points, number of members, guild name and realm. · by wowlua
(unitString: string): (number, number, string, string)
guessed
GetInspectItemLevelReturns the average item level for the unit being inspected.
(unit: string): number
implemented
GetInspectRatedBGBlitzDataReturns the inspected player's rated Battleground Blitz statistics. · by wowlua
(): InspectPVPData
guessed
GetInspectRatedBGDataReturns the inspected player's rated battleground statistics. · by wowlua
(): InspectRatedBGData
guessed
GetInspectRatedSoloShuffleDataReturns the inspected player's rated Solo Shuffle statistics. · by wowlua
(): InspectPVPData
guessed
GetInventorySlotInfoReturns info for an equipment slot.
(slotName: string): (number?, number?, boolean?)
implemented
GetInventorySlotInfoForInvSlotReturns information about an inventory slot given its slot number. · by wowlua
(invSlotValue: number): (number?, number?, boolean?, string?)
recorded
GetMinItemLevelReturns the minimum item level shown on the character sheet, or nil when there is none. · by wowlua
(): number?
guessed
GetStaggerPercentageReturns the unit's stagger as a percentage of its health. · by wowlua
(unit: string): (number, number?)
guessed
GetTemporaryEnchantmentInfoQueries information about active temporary enchants on inventory slot items.
(slot: LuaInventorySlot): TemporaryItemEnchantInfo?
guessed
IsInventorySlotEnabledWhether the named inventory slot is enabled. · by wowlua
(slotName: stringView): boolean
guessed
IsRangedSlotShownWhether the character sheet shows a ranged slot. · by wowlua
(): boolean
recorded
OffhandHasShieldWhether the player has a shield equipped in the off hand. · by wowlua
(): boolean
guessed
OffhandHasWeaponWhether the player has a weapon equipped in the off hand. · by wowlua
(): boolean
guessed

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

Events

eventpayloadfired by the emulator
AVOIDANCE_UPDATEno payloadimplemented
CHARACTER_POINTS_CHANGEDchange: numbernot implemented
CHARACTER_UPGRADE_SPELL_TIER_SETtierIndex: numbernot implemented
COMBAT_RATING_UPDATEno payloadimplemented
DISABLE_XP_GAINno payloadnot implemented
ENABLE_XP_GAINno payloadnot implemented
EQUIP_BIND_CONFIRMslot: number, itemLocation: ItemLocationMixinnot implemented
INSPECT_HONOR_UPDATEno payloadimplemented
INSPECT_READYinspecteeGUID: stringimplemented
LIFESTEAL_UPDATEno payloadimplemented
MASTERY_UPDATEno payloadimplemented
PET_STATS_UPDATEno payloadnot implemented
PLAYER_AVG_ITEM_LEVEL_UPDATEno payloadimplemented
PLAYER_EQUIPMENT_CHANGEDequipmentSlot: number, hasCurrent: booleanimplemented
PROFESSION_EQUIPMENT_CHANGEDskillLineID: number, isTool: booleannot implemented
PVP_POWER_UPDATEno payloadnot implemented
SPEED_UPDATEno payloadimplemented
SPELL_POWER_CHANGEDno payloadimplemented
STURDINESS_UPDATEno payloadnot implemented
UPDATE_FACTIONno payloadimplemented
UPDATE_INVENTORY_ALERTSno payloadnot implemented
UPDATE_INVENTORY_DURABILITYno payloadimplemented
WEAPON_SLOT_CHANGEDno payloadnot implemented

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

Structures

  • InspectGuildInfo · achievementPoints, numMembers, guildName, realmName
  • InspectPVPData · rating, gamesWon, gamesPlayed, roundsWon, roundsPlayed
  • InspectRatedBGData · rating, played, won
  • TemporaryItemEnchantInfo · enchantID, remainingTimeMs, chargesRemaining, hasExpirationTime

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (PaperDollInfo 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.