Beta Documentation - Subject to change.

A class that represents the local player.

Methods

  NameDescription
GetAlignmentGets the alignment of the player. (Inherited from Player)
GetAttributesGets the general attributes of a player.
GetBackpackGets the player's backpack.
GetBaseMaxMoraleGets the base max morale of the actor. (Inherited from Actor)
GetBaseMaxPowerGets the base max power of the actor. (Inherited from Actor)
GetClassGets the class of the player. (Inherited from Player)
GetClassAttributesGets attribute information specific to a class.
GetEffectsGets the effects on the actor. (Inherited from Actor)
GetEquipmentGets the player's equipment.
GetInstanceGets the instance of the Local Player.
GetLevelGets the level of the actor. (Inherited from Actor)
GetMaxMoraleGets the max morale of the actor. (Inherited from Actor)
GetMaxPowerGets the max power of the actor. (Inherited from Actor)
GetMaxTemporaryMoraleGets the maximum temporary morale of the actor. (Inherited from Actor)
GetMaxTemporaryPowerGets the max temporary power of the actor. (Inherited from Actor)
GetMoraleGets the current morale of the actor. (Inherited from Actor)
GetNameGets the name of the entity. (Inherited from Entity)
GetPartyGets the party the player is a member of. (Inherited from Player)
GetPowerGets the current power of the actor. (Inherited from Actor)
GetRaceGets the race of the player. (Inherited from Player)
GetRaceAttributesGets attribute information specific to a race.
GetReadyStateGets the ready state of a player based on the result of a ready check.
GetReadyStateGets the ready state of a player based on the result of a ready check. (Inherited from Player)
GetTemporaryMoraleGets the temporary morale of the actor. (Inherited from Actor)
GetTemporaryPowerGets the temporary power of the actor. (Inherited from Actor)
IsInCombatGets a flag indicating if the player is in combat.
IsLinkDeadGets a flag indicating if the player is disconnected.
IsLinkDeadGets a flag indicating if the player is disconnected. (Inherited from Player)
IsVoiceEnabledGets a flag indicating if the player has voice communication enabled.
IsVoiceEnabledGets a flag indicating if the player has voice communication enabled. (Inherited from Player)
RegisterForClickHandlingTakes in the Lua control that should be in charge of handling selection and right-clicking for this entity. (Inherited from Entity)

Events

  NameDescription
BaseMaxMoraleChangedEvent fired when the actor's base max morale changes. (Inherited from Actor)
BaseMaxPowerChangedEvent fired when he actor's base max power changes. (Inherited from Actor)
InCombatChangedEvent fired when the player's in combat state changes.
IsLinkDeadChangedEvent fired when the link dead state of the player has changed. (Inherited from Player)
IsVoiceEnabledChangedEvent fired when the voice enabled state of the player has changed. (Inherited from Player)
LevelChangedEvent fired when the actor's level changes. (Inherited from Actor)
MaxMoraleChangedEvent fired when the actor's max morale changes. (Inherited from Actor)
MaxPowerChangedEvent fired when he actor's max power changes. (Inherited from Actor)
MaxTemporaryMoraleChangedEvent fired when the actor's max temporary morale changes. (Inherited from Actor)
MaxTemporaryPowerChangedEvent fired when he actor's max temporary power changes. (Inherited from Actor)
MoraleChangedEvent fired when the actor's morale changes. (Inherited from Actor)
NameChangedEvent fired when the actor's name changes. (Inherited from Actor)
PartyChangedEvent fired when the party of the player has changed. (Inherited from Player)
PowerChangedEvent fired when he actor's power changes. (Inherited from Actor)
RaidChangedEvent fired when the raid of the player has changed. (Inherited from Player)
ReadyStateChangedEvent fired when the ready state of the player has changed. (Inherited from Player)
TemporaryMoraleChangedEvent fired when the actor's temporary morale changes. (Inherited from Actor)
TemporaryPowerChangedEvent fired when he actor's temporary power changes. (Inherited from Actor)