# Class Player [-] [+]

Inherits all methods from: Object, WorldObject, Unit

## Methods

AddComboPoints | Adds combo points to the Player
AddGlobalCooldown | Triggers global cooldown for the Player
AddItem | Adds the given amount of the specified item entry to the player.
AddLifetimeKills | Adds or detracts from the Players current lifetime kill count
AddPersonalBankItemCount | Adds the given amount of the specified item entry to the player's personal bank.
AddQuest | Tries to add the given quest entry for the Player.
AddSpellCooldown | Triggers spell cooldown for the Player
AddTalent | Adds a talent to the Player for the specified spec and learning status.
AdvanceAllSkills | Advances all of the Players skills to the amount specified
AdvanceSkill | Advances a Players specific skill to the amount specified
AdvanceSkillsToMax | Advances all of the Players weapon skills to the maximum amount available
AreaExploredOrEventHappens | Completes the Quest if a Quest area is explored, or completes the Quest
BindToInstance | Binds the Player to their current instance.
CanBlock | Returns 'true' if the Player can block incomming attacks, 'false' otherwise.
CanCompleteQuest | Returns 'true' if the Player satisfies all requirements to complete the quest entry.
CanCompleteRepeatableQuest | Returns 'true' if the Player satisfies all requirements to complete the repeatable quest entry.
CanEquipItem | Returns true if the player can equip the given Item or item entry to the given slot, false otherwise.
CanFly | Returns 'true' if the Player can fly, 'false' otherwise.
CanParry | Returns 'true' if the Player can parry incomming attacks, 'false' otherwise.
CanRewardQuest | Returns 'true' if the Player satisfies all requirements to turn in the quest.
CanShareQuest | Returns 'true' if the Player can share Quest specified by ID, 'false' otherwise.
CanSpeak | Returns 'true' if the Player can currently communicate through chat, 'false' otherwise.
CanTitanGrip | Returns 'true' if the Player can Titan Grip, 'false' otherwise.
CanUninviteFromGroup | Returns 'true' if the Player has permission to uninvite others from the current group, 'false' otherwise.
CanUseItem | Returns 'true' if the Player can use the item or item entry specified, 'false' otherwise.
CheckRequiredSpellReagents | Returns true if the player has the required reagents for the given spell entry, false otherwise.
ClearComboPoints | Clears the Players combo points
CompleteQuest | Completes the given quest entry for the Player and tries to satisfy all quest requirements.
DestroyPersonalBankItemCount | Removes the given amount of the specified Item from the player's personal bank.
DurabilityLoss | Damages specified Item
DurabilityLossAll | Damages all Items equipped. If inventory is true, damages Items in bags
DurabilityPointLossForEquipSlot | Sets durability loss for an Item in the specified slot
DurabilityPointsLoss | Sets durability loss for the specified Item
DurabilityPointsLossAll | Sets durability loss on all Items equipped
DurabilityRepair | Repairs Item at specified position.
DurabilityRepairAll | Repairs all Items.
EquipItem | Equips the given item or item entry to the given slot. Returns the equipped item or nil.
FailQuest | Sets the given Quest entry failed for the Player.
GetAccountId | Returns the Players account ID
GetAccountName | Returns the Players account name
GetAchievementCriteriaCount | Returns the progress count of the specified criteria type for the Player
GetActiveSpec | Returns the Players active spec ID
GetAmmoId | Returns the Players equipped ammo id
GetArenaPoints | Returns the Players current amount of Arena Points
GetAverageItemLevel | Returns the Players average item level
GetBankEntry | Returns the Players current bank entry (NPC or GO ID)
GetBaseSkillValue | Returns base skill value
GetBattlegroundId | Returns the Players current BattleGround ID
GetBattlegroundTypeId | Returns the Players current BattleGround type ID
GetChampioningFaction | Returns the faction ID the Player is currently flagged as champion for
GetChatTag | Returns active GM chat tag
GetCoinage | Returns the Players amount of money in copper
GetComboPoints | Returns Player's combo points
GetComboTarget | Returns Unit target combo points are on
GetCorpse | Returns the Players Corpse object
GetCriteriaProgressCount | Returns the progress count of the specified criteria id for the Player
GetDbLocaleIndex | Returns the Players database locale index
GetDbcLocale | Returns the Players game client locale
GetDifficulty | Returns raid or dungeon difficulty
GetDrunkValue | Returns the Players current level of intoxication
GetEquippedItemBySlot | Returns a Players Item object by gear slot specified
GetFreeInventorySpace | Returns the Players free inventory space
GetFreeTalentPoints | Returns the Players free talent point amount
GetGMRank | Returns the Players GM Rank
GetGossipTextId | Returns the database textID of the WorldObject's gossip header text for the Player
GetGroup | Returns the Players Group object
GetGroupInvite | Returns Group invitation
GetGuild | Returns the Players Guild object
GetGuildId | Returns the Players current Guild ID
GetGuildName | Returns the name of the Players current Guild
GetGuildRank | Returns the Players current guild rank
GetHealthBonusFromStamina | Returns health bonus from amount of stamina
GetHonorPoints | Returns the Players current amount of Honor Points
GetInGameTime | Returns the amount of time the Player has spent ingame
GetItemByEntry | Returns an Item from the player by entry.
GetItemByGUID | Returns an Item from the player by guid.
GetItemByPos | Returns an item in given bag on given slot.
GetItemCount | Returns amount of the specified Item the Player has.
GetLatency | Returns the Players current latency in MS
GetLevelPlayedTime | Returns the Players time played at current level
GetLifetimeKills | Returns the Players lifetime Honorable Kills
GetMailCount | Returns the amount of mails in the Players mailbox
GetMailItem | Returns a mailed Item by guid.
GetManaBonusFromIntellect | Returns mana bonus from amount of intellect
GetMaxSkillValue | Returns max value of specified skill
GetNearbyGameObject | Returns the closest GameObject to the Player.
GetNextRandomRaidMember | Returns a random Raid Member Player object within radius specified of Player
GetOriginalGroup | Returns Players original Group object
GetOriginalSubGroup | Returns Players original sub group
GetPersonalBankItemCount | Returns amount of the specified Item the Player has in his personal bank.
GetPhaseMaskForSpawn | Returns the normal phase of the player instead of the actual phase possibly containing GM phase
GetPlayerIP | Returns the Players IP address
GetPureMaxSkillValue | Returns max value of specified skill without bonus'
GetPureSkillValue | Returns skill value without bonus'
GetQuestLevel | Returns the quest level of the Players Quest specified by object
GetQuestRewardStatus | Returns 'true' if the Players Quest specified by entry ID has been rewarded, 'false' otherwise.
GetQuestStatus | Returns the status of the Players Quest specified by entry ID
GetRatingValue | Returns the Players combat rating value
GetRecruiterIds | Returns the Players recruit-a-friend recruiter account IDs
GetReputation | Returns the amount of reputation the Player has with the faction specified
GetReputationRank | Returns the Players reputation rank of faction specified
GetReqKillOrCastCurrentCount | Returns Quest required Creature or GameObject count
GetRestBonus | Returns the Players current resting bonus
GetSelectedPlayer | Returns the Players selected Player or nil.
GetSelectedUnit | Returns the Players selected Unit.
GetSelection | Returns the Players currently selected Unit object
GetShieldBlockValue | Returns the Players current shield block value
GetSkillPermBonusValue | Returns skill permanent bonus value
GetSkillTempBonusValue | Returns skill temporary bonus value
GetSkillValue | Returns skill value
GetSpecsCount | Returns the amount of available specs the Player currently has
GetSpellCooldownDelay | Returns the Players cooldown delay by specified Spell ID
GetSubGroup | Returns Players current sub group
GetTeam | Returns the Players [TeamId]
GetTotalItemLevel | Returns the Players total item level
GetTotalPlayedTime | Returns the Players total time played
GetXP | Returns the Players current experience points
GetXPForNextLevel | Returns the Players required experience points for next level
GetXPRestBonus | Returns rested experience bonus
GiveXP | Gives the Player experience
GossipAddQuests | Adds the gossip items to the Player's gossip for the quests the given WorldObject can offer to the player.
GossipClearMenu | Clears the Players current gossip item list.
GossipComplete | Closes the Players currently open Gossip Menu.
GossipMenuAddItem | Adds a new item to the gossip menu shown to the Player on next call to Player:GossipSendMenu.
GossipSendMenu | Sends the current gossip items of the player to him as a gossip menu with header text from the given textId.
GossipSendPOI | Sends POI to the location on your map
GroupCreate | Creates a new Group with the creator Player as leader.
GroupEventHappens | Completes a Quest if in a Group
GroupInvite | Makes the Player invite another player to a group.
Has310Flyer | Returns 'true' if the Player has 310% flying speed unlocked.
HasAchieved | Returns 'true' if the Player has completed the specified achievement, 'false' otherwise.
HasAnyItemInPersonalBank | Returns true if the Player has any item in his personal bank.
HasAtLoginFlag | Returns true if Player has specified login flag
HasItem | Returns 'true' if the Player has the given amount of item entry specified, 'false' otherwise.
HasPendingBind | Returns whether or not the Player has any pending dungeon bind
HasQuest | Returns 'true' if the Player has an active Quest by specific ID, 'false' otherwise.
HasQuestForGO | Returns true if Player has Quest for GameObject
HasQuestForItem | Returns 'true' if the Player has a quest for the item entry specified, 'false' otherwise.
HasReceivedQuestReward | Returns whether or not the Player has received the reward for a specific Quest ID
HasSkill | Returns 'true' if the Player has a skill by specific ID, 'false' otherwise.
HasSpell | Returns 'true' if the Player has a Spell by specific ID, 'false' otherwise.
HasSpellCooldown | Returns 'true' if the Spell specified by ID is currently on cooldown for the Player, 'false' otherwise.
HasTalent | Returns 'true' if the Player has a talent by ID in specified spec, 'false' otherwise.
HasTitle | Returns 'true' if the Player has a title by specific ID, 'false' otherwise.
InArena | Returns 'true' if the Player is currently in an arena, 'false' otherwise.
InBattleground | Returns 'true' if the Player is currently in a BattleGround, 'false' otherwise.
InBattlegroundQueue | Returns 'true' if the Player is currently in a BattleGround queue, 'false' otherwise.
InRandomLfgDungeon | Returns whether or not the Player is currently in a random LFG dungeon
IncompleteQuest | Sets the given quest entry incomplete for the Player.
IsAFK | Returns 'true' if the Player is 'Away From Keyboard' flagged, 'false' otherwise.
IsARecruiter | Returns whether or not the Player is a recruiter
IsAcceptingWhispers | Returns 'true' if the Player is accepting whispers, 'false' otherwise.
IsAlliance | Returns 'true' if the Player is a part of the Alliance faction, 'false' otherwise.
IsDND | Returns 'true' if the Player is 'Do Not Disturb' flagged, 'false' otherwise.
IsFalling | Returns 'true' if the Player is currently falling, 'false' otherwise.
IsFlying | Returns 'true' if the Player is currently flying, 'false' otherwise.
IsGM | Returns 'true' if the Player is a Game Master, 'false' otherwise.
IsGMChat | Returns whether or not the Player has the GM chat flag active
IsGMVisible | Returns whether or not the Player has GM invisibility active
IsGroupVisibleFor | Returns whether or not the Players Group is visible for the other specific Player.
IsHonorOrXPTarget | Returns 'true' if the Player is eligible for Honor or XP gain by Unit specified, 'false' otherwise.
IsHorde | Returns 'true' if the Player is a part of the Horde faction, 'false' otherwise.
IsImmuneToDamage | Returns 'true' if the Player is immune to everything.
IsImmuneToEnvironmentalDamage | Returns whether or not the Player is currently immune to environmental damage
IsInAreaTrigger | Returns 'true' if the Player is within the area trigger entry.
IsInArenaTeam | Returns 'true' if the Player is in an arena team specified by type, 'false' otherwise.
IsInGroup | Returns 'true' if the Player is in a Group, 'false' otherwise.
IsInGuild | Returns 'true' if the Player is in a Guild, 'false' otherwise.
IsInSameGroupWith | Returns 'true' if the Player is currently in the same Group as another Player by object, 'false' otherwise.
IsInSameRaidWith | Returns 'true' if the Player is currently in the same raid as another Player by object, 'false' otherwise.
IsInWater | Returns 'true' if the Player is currently in water, 'false' otherwise.
IsMoving | Returns 'true' if the Player is currently moving, 'false' otherwise.
IsNeverVisible | Returns whether or not the Player is never visible for other Units
IsOutdoorPvPActive | Returns whether or not the Player is currently flagged for outdoors PvP
IsRested | Returns 'true' if the Player is currently rested, 'false' otherwise.
IsTaxiCheater | Returns 'true' if the Player has taxi cheat activated, 'false' otherwise.
IsUsingLfg | Returns whether or not the Player is currently queued in LFG
IsVisibleForPlayer | Returns 'true' if the Player can see anoter Player specified by object, 'false' otherwise.
KickPlayer | Kicks the Player from the server
KillGOCredit | Rewards a quest kill or go credit for the Player
KillPlayer | Kills the Player
KilledMonsterCredit | Gives Quest monster killed credit
KilledPlayerCredit | Grants a player kill credit.
LearnSpell | Teaches the Player the Spell specified by entry ID
LearnTalent | Learn the Player the talent specified by talent_id and talentRank
LeaveBattleground | Forces the Player to leave a BattleGround
LogoutPlayer | Forces the Player to log out
ModifyArenaPoints | Adds or detracts from the Players current Arena Points
ModifyHonorPoints | Adds or detracts from the Players current Honor Points
ModifyMoney | Adds or subtracts from the Players money in copper
ModifySpellCooldown | Modifies spell cooldown for the Player
Mute | Mutes the Player for the amount of seconds specified
RemoveAchievement | Removes the specified achievement from the Players
RemoveActiveQuest | Removes an active quest from the Player.
RemoveArenaSpellCooldowns | Remove cooldowns on spells that have less than 10 minutes of cooldown from the Player, similarly to when you enter an arena.
RemoveFromBattlegroundRaid | Forcefully removes the Player from a BattleGround raid group
RemoveFromGroup | Forces the Player to leave a Group
RemoveItem | Removes the given amount of the specified Item from the player.
RemoveItemByPos | Removes the specified Item from the player.
RemoveLifetimeKills | Removes specified amount of lifetime kills
RemovePet | Removes the Player's active pet.
RemovePlayerFlag | Removes PlayerFlag from Player
RemoveQuest | Removes the given quest entry from the Player.
RemoveRewardedQuest | Removes a quest from the rewarded quests for the Player.
RemoveSpell | Removes the Spell from the Player
RemovedInsignia | Loots Player's bones for insignia
ResetAchievements | Reset the Players completed achievements
ResetAllCooldowns | Resets all of the Player's cooldowns
ResetPetTalents | Resets the Players pets talent points
ResetSpellCooldown | Resets cooldown of the specified spell
ResetTalents | Resets the Players talents
ResetTalentsCost | Returns the Players accumulated talent reset cost
ResetTypeCooldowns | Resets cooldown of the specified category
ResurrectPlayer | Resurrects the Player.
RewardQuest | Rewards the given quest entry for the Player if he has completed it.
SaveToDB | Saves the Player to the database
Say | Sends say text from the Player
SendAddonMessage | Sends addon message to the Player receiver
SendAreaTriggerMessage | Sends an Area Trigger Message to the Player
SendAuctionMenu | Sends an auction house window to the Player from the Unit specified
SendBroadcastMessage | Sends a Broadcast Message to the Player
SendCinematicStart | Starts a cinematic for the Player
SendEquipError | Sends equipment error to the Player
SendGuildInvite | Sends a guild invitation from the Players Guild to the Player object specified
SendListInventory | Sends a vendor window to the Player from the WorldObject specified.
SendMovieStart | Starts a movie for the Player
SendNotification | Sends a Notification to the Player
SendPacket | Sends a WorldPacket to the Player
SendQuestTemplate | Shows a quest accepting window to the Player for the given quest.
SendShowBank | Sends a bank window to the Player from the WorldObject specified.
SendShowMailBox | Shows the mailbox window to the player from specified guid.
SendSpiritResurrect | Sends a spirit resurrection request to the Player
SendTabardVendorActivate | Sends a tabard vendor window to the Player from the WorldObject specified
SendTaxiMenu | Sends a flightmaster window to the Player from the Creature specified
SendTrainerList | Sends a trainer window to the Player from the Creature specified
SendUnlockItem | Unlocks (in game UI) the Item for the Player.
SendUpdateWorldState | Sends an update for the world state to the Player
SetAcceptWhispers | Toggles whether the Player accepts whispers or not
SetAchievement | Adds the specified achievement to the Players
SetAmmoId | Sets the Players ammo item id
SetArenaPoints | Sets the Players Arena Points to the amount specified
SetAtLoginFlag | Sets the Players login flag to the flag specified
SetBankBagSlotCount | Sets unlocked bank bag slots for the Player
SetBindPoint | Sets the Players home location to the location specified
SetCoinage | Sets the Players amount of money to copper specified
SetCriteriaProgress | Adds the given amount of the specified criteria id to the player's achievement counter.
SetDrunkValue | Sets the Players intoxication level to the level specified
SetFFA | Toggle the Players FFA flag
SetFactionForRace | Sets the Players faction standing to that of the race specified
SetFreeTalentPoints | Sets the Players free talent points to the amount specified for the current spec
SetGMChat | Toggle Blizz (GM) tag
SetGMVisible | Toggles whether the Player has GM visibility on or off
SetGameMaster | Toggles the Players GM mode on or off
SetGender | Sets the Players gender to gender specified
SetGuildRank | Sets the Players guild rank to the rank specified
SetHideZoneAndArea | Hides the Players zone and area in who and friend list
SetHonorPoints | Sets the Players Honor Points to the amount specified
SetKnownTitle | Adds the specified title to the Players list of known titles
SetLifetimeKills | Sets the Players amount of Lifetime Honorable Kills to the value specified
SetMovement | Sets the Players movement to the provided movement type
SetPlayerFlag | Removes PlayerFlag from Player
SetPlayerLock | Locks the player controls and disallows all movement and casting.
SetPvPDeath | Toggles PvP Death
SetQuestStatus | Sets Quest state
SetReputation | Sets the Players reputation amount for the faction specified
SetRestBonus | Sets the Players rest bonus to the amount specified
SetSheath | Sets the Players sheathe state to the state specified
SetSingleTargetPvP | Toggle the Players Single Target PvP state
SetSingleTargetPvPMaxLevelDifference | Sets the Players max level difference for single target pvp
SetSkill | Sets (increases) skill of the Player
SetTaxiCheat | Toggles whether the Player has taxi cheat enabled or not
SpawnBones | Converts Player's corpse to bones
StackPersonalBankItem | Stacks all items with given id in the Player's personal bank
StartTaxi | Attempts to start the taxi/flying to the given pathID
StoreNewItemInBestSlots | Adds and possibly equips the given amount of the specified item entry to the player.
SummonPet | Summons a pet for the Player.
SummonPlayer | Sends a summon request to the player from the given summoner
TalkedToCreature | Gives Quest monster talked to credit
Teleport | Teleports a Player to the location specified
TextEmote | Sends a text emote from the Player
ToggleAFK | Toggle the Players 'Away From Keyboard' flag
ToggleDND | Toggle the Players 'Do Not Disturb' flag
UnbindAllInstances | Unbinds the Player from his instances except the one he currently is in.
UnbindInstance | Unbinds the Player from his instances except the one he currently is in.
UnequipItem | Unequips the given item or item entry.
UnlockPersonalBank | Unlocks the personal bank for the Player
UnlockPersonalBankTab | Unlocks a personal bank tab for the Player
UnsetKnownTitle | Removes a title by ID from the Players list of known titles
UpdateAchievementCriteria | Adds the given amount of the specified criteria type to the player's achievement counter.
Whisper | Sends whisper text from the Player
Yell | Sends yell text from the Player

# Keyboard shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

# Search tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct` (or `str`), `enum`, `trait`, `typedef` (or `tdef`).

Generated on
© 2010 - 2024 Eluna Lua Engine