Beta Documentation - Subject to change.

A class that represents a player in the game.

Methods

  NameDescription
GetAlignmentGets the alignment of the player.
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.
GetEffectsGets the effects on the actor. (Inherited from Actor)
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.
GetPetGets the pet of the player.
GetPowerGets the current power of the actor. (Inherited from Actor)
GetRaceGets the race of the player.
GetReadyStateGets the ready state of a player based on the result of a ready check.
GetTargetGets the actor's target. (Inherited from Actor)
GetTemporaryMoraleGets the temporary morale of the actor. (Inherited from Actor)
GetTemporaryPowerGets the temporary power of the actor. (Inherited from Actor)
IsLinkDeadGets a flag indicating if the player is disconnected.
IsLocalPlayerReturns true if this entity is the local player entity. (Deprecated). (Inherited from Entity)
IsVoiceActiveGets a flag indicating if the player is currently transmitting voice data.
IsVoiceEnabledGets a flag indicating if the player has voice communication enabled.

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)
IsLinkDeadChangedEvent fired when the link dead state of the player has changed.
IsVoiceActiveChangedEvent fired when the state of the player transmitting voice data has changed.
IsVoiceEnabledChangedEvent fired when the voice enabled state of the player has changed.
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 Entity)
PartyChangedEvent fired when the party of the player has changed.
PetChangedEvent fired when the pet of the player has changed.
PowerChangedEvent fired when he actor's power changes. (Inherited from Actor)
RaidChangedEvent fired when the raid of the player has changed.
ReadyStateChangedEvent fired when the ready state of the player has changed.
TargetChangedEvent fired when the actor's target changes. (Inherited from Actor)
TemporaryMoraleChangedEvent fired when the actor's temporary morale changes. (Inherited from Actor)
TemporaryPowerChangedEvent fired when he actor's temporary power changes. (Inherited from Actor)