C_PaperDollInfo
namespaceavailable in: camelotStatus in wowlua
21 functions: 2 implemented, 3 recorded, 16 guessed. 23 events, 12 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
AmmoNeeded | Whether the player's ranged weapon uses ammunition. · by wowlua(): boolean | recorded |
CanAutoEquipCursorItem | Whether the item on the cursor can be equipped automatically. · by wowlua(): boolean | guessed |
CancelTemporaryEnchantment | Cancels active temporary enchantments on inventory slot items.(slot: LuaInventorySlot) | guessed |
CursorCanGoInSlot | Whether the item on the cursor can go in an equipment slot. · by wowlua(slotIndex: number): boolean | guessed |
GetArmorEffectiveness | Returns how much damage an armor value prevents against an attacker of a level. · by wowlua(armor: number, attackerLevel: number): number | guessed |
GetArmorEffectivenessAgainstTarget | Returns how much damage an armor value prevents against the player's target. · by wowlua(armor: number): number? | guessed |
GetInspectAzeriteItemEmpoweredChoices | Returns the azerite powers chosen on an inspected unit's item. · by wowlua(unit: string, equipmentSlotIndex: number): number[]? | guessed |
GetInspectGuildInfo | Returns 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 |
GetInspectItemLevel | Returns the average item level for the unit being inspected.(unit: string): number | implemented |
GetInspectRatedBGBlitzData | Returns the inspected player's rated Battleground Blitz statistics. · by wowlua(): InspectPVPData | guessed |
GetInspectRatedBGData | Returns the inspected player's rated battleground statistics. · by wowlua(): InspectRatedBGData | guessed |
GetInspectRatedSoloShuffleData | Returns the inspected player's rated Solo Shuffle statistics. · by wowlua(): InspectPVPData | guessed |
GetInventorySlotInfo | Returns info for an equipment slot.(slotName: string): (number?, number?, boolean?) | implemented |
GetInventorySlotInfoForInvSlot | Returns information about an inventory slot given its slot number. · by wowlua(invSlotValue: number): (number?, number?, boolean?, string?) | recorded |
GetMinItemLevel | Returns the minimum item level shown on the character sheet, or nil when there is none. · by wowlua(): number? | guessed |
GetStaggerPercentage | Returns the unit's stagger as a percentage of its health. · by wowlua(unit: string): (number, number?) | guessed |
GetTemporaryEnchantmentInfo | Queries information about active temporary enchants on inventory slot items.(slot: LuaInventorySlot): TemporaryItemEnchantInfo? | guessed |
IsInventorySlotEnabled | Whether the named inventory slot is enabled. · by wowlua(slotName: stringView): boolean | guessed |
IsRangedSlotShown | Whether the character sheet shows a ranged slot. · by wowlua(): boolean | recorded |
OffhandHasShield | Whether the player has a shield equipped in the off hand. · by wowlua(): boolean | guessed |
OffhandHasWeapon | Whether 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
| event | payload | fired by the emulator |
|---|---|---|
AVOIDANCE_UPDATE | no payload | implemented |
CHARACTER_POINTS_CHANGED | change: number | not implemented |
CHARACTER_UPGRADE_SPELL_TIER_SET | tierIndex: number | not implemented |
COMBAT_RATING_UPDATE | no payload | implemented |
DISABLE_XP_GAIN | no payload | not implemented |
ENABLE_XP_GAIN | no payload | not implemented |
EQUIP_BIND_CONFIRM | slot: number, itemLocation: ItemLocationMixin | not implemented |
INSPECT_HONOR_UPDATE | no payload | implemented |
INSPECT_READY | inspecteeGUID: string | implemented |
LIFESTEAL_UPDATE | no payload | implemented |
MASTERY_UPDATE | no payload | implemented |
PET_STATS_UPDATE | no payload | not implemented |
PLAYER_AVG_ITEM_LEVEL_UPDATE | no payload | implemented |
PLAYER_EQUIPMENT_CHANGED | equipmentSlot: number, hasCurrent: boolean | implemented |
PROFESSION_EQUIPMENT_CHANGED | skillLineID: number, isTool: boolean | not implemented |
PVP_POWER_UPDATE | no payload | not implemented |
SPEED_UPDATE | no payload | implemented |
SPELL_POWER_CHANGED | no payload | implemented |
STURDINESS_UPDATE | no payload | not implemented |
UPDATE_FACTION | no payload | implemented |
UPDATE_INVENTORY_ALERTS | no payload | not implemented |
UPDATE_INVENTORY_DURABILITY | no payload | implemented |
WEAPON_SLOT_CHANGED | no payload | not 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, realmNameInspectPVPData· rating, gamesWon, gamesPlayed, roundsWon, roundsPlayedInspectRatedBGData· rating, played, wonTemporaryItemEnchantInfo· 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.