v0.13.8

C_PlayerInfo

namespaceavailable in: camelot

Status in wowlua

40 functions: 1 implemented, 4 recorded, 35 guessed.

Functions

functionwhat it doesstatus
CanPlayerEnterChromieTimeReturns true if the player is eligible to enter a timewalking campaign.
(): boolean
guessed
CanPlayerUseAreaLootReturns true if the player can use area looting.
(): boolean
guessed
CanPlayerUseMountEquipmentReturns true if the player can use mount equipment.
(): (boolean, string)
guessed
CanUseItemWhether the player can use the given item. · by wowlua
(itemID: number): boolean
guessed
GUIDIsPlayerReturns true if the GUID belongs to a player.
(guid: string): boolean
guessed
GetAlternateFormInfoReturns if the player has an alternate form and if they are currently in that form.
(): (boolean, boolean)
recorded
GetClassReturns the class of a player.
(playerLocation: PlayerLocationMixin): (string?, string?, number?)
guessed
GetContentDifficultyCreatureForPlayerReturns info indicating how much difficulty the player may have if fighting a given unit.
(unitToken: string): RelativeContentDifficulty
guessed
GetContentDifficultyQuestForPlayerReturns info indicating how much difficulty the player may have when performing a given quest.
(questID: number): RelativeContentDifficulty
implemented
GetDisplayIDReturns the display ID of the player's current model. · by wowlua
(): number
guessed
GetGlidingInfoReturns the Dragonriding gliding speed.
(): (boolean, boolean, number)
guessed
GetInstancesUnlockedAtLevelReturns the instances that become available at the given level, or nil when there are none. · by wowlua
(level: number, isRaid: boolean): number[]?
guessed
GetNameReturns the name of a player.
(playerLocation: PlayerLocationMixin): string?
guessed
GetNativeDisplayIDReturns the display ID of the player's own race model, ignoring shapeshifts and disguises. · by wowlua
(): number
guessed
GetPetStableCreatureDisplayInfoIDReturns the creature display ID of a pet in the stable. · by wowlua
(index: number): number
guessed
GetPlayerCharacterDataReturns basic data about the player's character, or nil when it is not available. · by wowlua
(): PlayerInfoCharacterData?
guessed
GetPlayerMythicPlusRatingSummaryReturns the players mythic+ rating summary which includes the runs they've completed as well as their current season m+ rating
(playerToken: string): MythicPlusRatingSummary?
guessed
GetRaceReturns the race of a player.
(playerLocation: PlayerLocationMixin): number?
guessed
GetSexReturns the sex of a player.
(playerLocation: PlayerLocationMixin): UnitSex?
guessed
HasAccountInventoryLockWhether the account's inventory is locked. · by wowlua
(): boolean
guessed
HasVisibleInvSlotWhether the given equipment slot is visible on the player's model. · by wowlua
(slot: number): boolean
guessed
IsAccountBankEnabledWhether the Warband bank is enabled. · by wowlua
(): boolean
guessed
IsCharacterBankEnabledWhether the character's bank is enabled. · by wowlua
(): boolean
guessed
IsConnectedReturns true if the player is connected.
(playerLocation: PlayerLocationMixin?): boolean?
guessed
IsDisplayRaceNativeWhether the player's model shows the character's own race rather than an alternate form. · by wowlua
(): boolean
guessed
IsExpansionLandingPageUnlockedForPlayerWhether the player has unlocked the given expansion's landing page. · by wowlua
(expansionID: number): boolean
guessed
IsMirrorImageWhether the player is a mirror image. · by wowlua
(): boolean
guessed
IsPlayerEligibleForNPEReturns true if the player is eligible for the legacy new player experience tutorial, or false and a reason string if not.
(): (boolean, string)
guessed
IsPlayerEligibleForNPEv2Returns true if the player is eligible for the updated new player experience tutorial, or false and a reasons string if not.
(): (boolean, string)
guessed
IsPlayerInChromieTimeReturns true if the player is actively within a Timewalking Campaign (Chromie Time).
(): boolean
guessed
IsPlayerInRPEWhether the player is in the Rapid Progression Experience. · by wowlua
(): boolean
recorded
IsPlayerInTimerunningHeroicWorldTierWhether the player is a timerunner on the heroic world tier. · by wowlua
(): boolean
guessed
IsPlayerNPERestrictedReturns true if the player has new player experience restrictions in place.
(): boolean
recorded
IsReturningCharacterWhether the character counts as returning after a long break. · by wowlua
(): boolean
guessed
IsSelfFoundActiveWhether the character is in Self-Found mode. · by wowlua
(): boolean
guessed
IsTradingPostAvailableWhether the player can use the Trading Post. · by wowlua
(): boolean
guessed
IsTravelersLogAvailableWhether the player can use the Traveler's Log. · by wowlua
(): boolean
guessed
IsTutorialsTabAvailableWhether the tutorials tab is available to the player. · by wowlua
(): boolean
guessed
ShouldDisplaySurnameWhether the character's surname should be shown. · by wowlua
(): boolean
recorded
UnitIsSameServerReturns true if a player is from the same or connected realm.
(playerLocation: PlayerLocationMixin): boolean
guessed

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

Structures

  • MythicPlusRatingMapSummary · challengeModeID, mapScore, bestRunLevel, bestRunDurationMS, finishedSuccess
  • MythicPlusRatingSummary · currentSeasonScore, runs

sources

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