Packages

class Player extends PlanetSideServerObject with BlockMapEntity with InteractsWithZone with FactionAffinity with Vitality with ResistanceProfile with Container with JammableUnit with ZoneAware with AuraContainer with MountableEntity

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Player
  2. MountableEntity
  3. AuraContainer
  4. JammableUnit
  5. Container
  6. ResistanceProfile
  7. Vitality
  8. InGameHistory
  9. InteractsWithZone
  10. BlockMapEntity
  11. PlanetSideServerObject
  12. ZoneAware
  13. FactionAffinity
  14. PlanetSideGameObject
  15. WorldEntity
  16. IdentifiableEntity
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Player(avatar: Avatar)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def AccessingBackpack: Option[PlanetSideGUID]
  5. def AccessingBackpack_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]

    Change which player has access to the backpack of this player.

    Change which player has access to the backpack of this player. A player may only access to the backpack of a dead released player, and only if no one else has access at the moment.

    guid

    the player who wishes to access the backpack

    returns

    the player who is currently allowed to access the backpack

  6. def AccessingBackpack_=(guid: PlanetSideGUID): Option[PlanetSideGUID]
  7. def Actor: ActorRef

    Retrieve a reference to the internal Actor.

    Retrieve a reference to the internal Actor.

    returns

    the internal ActorRef

    Definition Classes
    PlanetSideServerObject
  8. def Actor_=(control: ActorRef): ActorRef

    Assign an Actor to act for this server object.

    Assign an Actor to act for this server object. This reference is only set once, that is, as long as the internal ActorRef directs to ActorRef.noSender (null).

    control

    the Actor whose functionality will govern this server object

    returns

    the current internal ActorRef

    Definition Classes
    PlanetSideServerObject
  9. def AddEffectToAura(effect: Aura): Set[Aura]
    Definition Classes
    AuraContainer
  10. def Armor: Int
  11. def Armor_=(assignArmor: Int): Int
  12. def Aura: Set[Aura]
    Definition Classes
    AuraContainer
  13. def AwayFromKeyboard: Boolean
  14. def AwayFromKeyboard_=(away: Boolean): Boolean
  15. def BailProtection: Boolean
    Definition Classes
    MountableEntity
  16. def BailProtection_=(protect: Boolean): Boolean
    Definition Classes
    MountableEntity
  17. def CanAccessBackpack(player: Player): Boolean

    Can the other player access the contents of this Player's backpack?

    Can the other player access the contents of this Player's backpack?

    player

    a player attempting to access this backpack

    returns

    true, if the player is permitted access; false, otherwise

  18. def CanDamage: Boolean
    Definition Classes
    Player → Vitality
  19. def CanRepair: Boolean
    Definition Classes
    Vitality
  20. def Capacitor: Float
  21. def CapacitorLastChargedMillis: Long
  22. def CapacitorLastUsedMillis: Long
  23. def CapacitorState: types.CapacitorStateType.Value
  24. def CapacitorState_=(value: types.CapacitorStateType.Value): types.CapacitorStateType.Value
  25. def Capacitor_=(value: Float): Float
  26. def Carrying: Option[SpecialCarry]
  27. def Carrying_=(item: Option[SpecialCarry]): Option[SpecialCarry]
  28. def Carrying_=(item: SpecialCarry): Option[SpecialCarry]
  29. def CharId: Long
  30. def ClearHistory(): List[InGameActivity]
    Definition Classes
    InGameHistory
  31. def Cloaked: Boolean
  32. def Cloaked_=(isCloaked: Boolean): Boolean
  33. def Collisions(dest: Int, width: Int, height: Int): Try[List[InventoryItem]]

    Given a region of "searchable unit positions" considered as stowable, determine if any previously stowed items are contained within that region.

    Default usage, and recommended the continued inclusion of that use, is defined in terms of Equipment being stowed in a GridInventory.

    Given a region of "searchable unit positions" considered as stowable, determine if any previously stowed items are contained within that region.

    Default usage, and recommended the continued inclusion of that use, is defined in terms of Equipment being stowed in a GridInventory. Where the Equipment object is defined by the dimensions width and height, starting a search at index will search all positions within a grid-like range of numbers. Under certain searching conditions, this range may be meaningless, such as is the case when searching individual positions that are normal EquipmentSlot objects. Regardless, the value collected indicates the potential of multiple objects being discovered and maintains a reference to the object itself and the slot position where the object is located. (As any object can be discovered within the range, that is important.)

    width

    the width of the searchable space

    height

    the height of the serachable space

    returns

    a list of objects that have been encountered within the searchable space

    Definition Classes
    Player → Container
    See also

    GridInventory.CheckCollisionsVar

  34. def Continent: String
    Definition Classes
    ZoneAware
  35. def Continent_=(zoneId: String): String

    Give the entity a custom Zone identifier.

    Give the entity a custom Zone identifier.

    zoneId

    the custom identifier of the Zone object

    returns

    the identifier of the Zone object

    Definition Classes
    ZoneAware
  36. def Crouching: Boolean
  37. def Crouching_=(crouched: Boolean): Boolean
  38. def DamageModel: DamageResistanceModel
    Definition Classes
    Player → Vitality
  39. def DefaultHealth: Int
    Definition Classes
    Vitality
  40. def Definition: AvatarDefinition
    Definition Classes
    Player → Vitality → PlanetSideGameObject
  41. def Destroyed: Boolean
    Definition Classes
    PlanetSideGameObject
  42. def Destroyed_=(state: Boolean): Boolean
    Definition Classes
    PlanetSideGameObject
  43. def Die: Boolean
  44. def DrawnSlot: Int
  45. def DrawnSlot_=(slot: Int): Int
  46. def Entity: WorldEntity
    Definition Classes
    PlanetSideGameObject
  47. def Entity_=(newEntity: WorldEntity): Unit
    Definition Classes
    PlanetSideGameObject
  48. def ExoSuit: types.ExoSuitType.Value
  49. def ExoSuitDef: ExoSuitDefinition
  50. def ExoSuit_=(suit: types.ExoSuitType.Value): Unit
  51. def FacingYawUpper: Float
  52. def FacingYawUpper_=(facing: Float): Float
  53. def Faction: types.PlanetSideEmpire.Value
    Definition Classes
    Player → FactionAffinity
  54. def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
    Definition Classes
    FactionAffinity
  55. def Find(guid: PlanetSideGUID): Option[Int]

    Given globally unique identifier, if the object using it is stowed, attempt to locate its slot.

    Given globally unique identifier, if the object using it is stowed, attempt to locate its slot. All positions, VisibleSlot and Inventory, and wherever else, should be searchable.

    guid

    the GUID of the Equipment

    returns

    the index of the EquipmentSlot, or None

    Definition Classes
    Player → Container
  56. def Find(obj: Equipment): Option[Int]

    Given an object, attempt to locate its slot.

    Given an object, attempt to locate its slot. All positions, VisibleSlot and Inventory, and wherever else, should be searchable.

    obj

    the Equipment object

    returns

    the index of the EquipmentSlot, or None

    Definition Classes
    Container
  57. def Fit(obj: Equipment): Option[Int]
    Definition Classes
    Player → Container
  58. def Fit(tile: InventoryTile): Option[Int]
    Definition Classes
    Container
  59. def FreeHand: EquipmentSlot
  60. def FreeHand_=(item: Option[Equipment]): Option[Equipment]
  61. def GUID: PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  62. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  63. def GUID_=(guid: StalePlanetSideGUID): PlanetSideGUID

    Always intercept StalePlanetSideGUID references when attempting to mutate the GUID value.

    Always intercept StalePlanetSideGUID references when attempting to mutate the GUID value.

    guid

    the valid GUID to assign

    returns

    never returns

    Definition Classes
    IdentifiableEntity
    Exceptions thrown

    `AssigningGUIDException` always

  64. def HasGUID: Boolean

    Flag when the object has no GUID (initial condition) or is considered stale.

    Flag when the object has no GUID (initial condition) or is considered stale.

    returns

    whether the value of the GUID is a valid representation for this object

    Definition Classes
    IdentifiableEntity
  65. def Head: Int
  66. def Health: Int
    Definition Classes
    Vitality
  67. def Health_=(assignHealth: Int): Int
    Definition Classes
    Vitality
  68. def History: List[InGameActivity]
    Definition Classes
    InGameHistory
  69. def HolsterItems(): List[InventoryItem]

    Transform the holster equipment slots into a list of the kind of item wrapper found in an inventory.

    Transform the holster equipment slots into a list of the kind of item wrapper found in an inventory.

    returns

    a list of items that would be found in a proper inventory

    See also

    GridInventory

    InventoryItem

  70. def Holsters(): Array[EquipmentSlot]
  71. def Invalidate(): Unit

    Indicate that the current GUID is no longer a valid representation of the object.

    Indicate that the current GUID is no longer a valid representation of the object. Transforms whatever the current GUID is into a StalePlanetSideGUID entity with the same value. Doing this restores the object to its default mutation option ("the ability to set a new valid GUID"). The current GUID will still be accessed as if it were valid, but it will be wrapped in the new stale object.

    Definition Classes
    IdentifiableEntity
  72. def Inventory: GridInventory

    A(n imperfect) reference to a generalized pool of the contained objects.

    A(n imperfect) reference to a generalized pool of the contained objects. Having access to all of the available positions is not required. The entries in this reference should definitely include all unseen positions. The GridInventory returned by this accessor is also an implementation of Container.

    Definition Classes
    Player → Container
    See also

    VisibleSlots

  73. def Jammed: Boolean
    Definition Classes
    JammableUnit
  74. def Jammed_=(state: Boolean): Boolean
    Definition Classes
    JammableUnit
  75. def Jumping: Boolean
  76. def Jumping_=(jumped: Boolean): Boolean
  77. def LastDamage: Option[DamageResult]
    Definition Classes
    InGameHistory
  78. def LastDrawnSlot: Int
  79. def LastShot: Option[DamageResult]

    Find, specifically, the last instance of a weapon discharge that caused damage.

    Find, specifically, the last instance of a weapon discharge that caused damage.

    returns

    information about the discharge

    Definition Classes
    InGameHistory
  80. def LogActivity(result: DamageResult): List[InGameActivity]

    Very common example of a VitalsActivity event involving damage.

    Very common example of a VitalsActivity event involving damage. They are repackaged before submission and are often tagged for specific blame.

    result

    the fully-informed entry

    returns

    the list of previous changes to this object's vital statistics

    Definition Classes
    InGameHistory
  81. def LogActivity(action: Option[InGameActivity]): List[InGameActivity]

    An in-game event must be recorded.

    An in-game event must be recorded. Add new entry to the front of the list (for recent activity).

    action

    the fully-informed entry

    returns

    the list of previous changes to this entity

    Definition Classes
    InGameHistory
  82. def LogActivity(action: InGameActivity): List[InGameActivity]

    An in-game event must be recorded.

    An in-game event must be recorded. Add new entry to the front of the list (for recent activity).

    action

    the fully-informed entry

    returns

    the list of previous changes to this entity

    Definition Classes
    InGameHistory
  83. def MaxArmor: Int
  84. def MaxHealth: Int
    Definition Classes
    Vitality
  85. def MaxHealth_=(default: Option[Int]): Int
    Definition Classes
    Vitality
  86. def MaxHealth_=(default: Int): Int
    Definition Classes
    Vitality
  87. def MountedIn: Option[PlanetSideGUID]
    Definition Classes
    MountableEntity
  88. def MountedIn_=(cargo_guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]
    Definition Classes
    MountableEntity
  89. def MountedIn_=(cargo_guid: PlanetSideGUID): Option[PlanetSideGUID]
    Definition Classes
    MountableEntity
  90. def Name: String
  91. def Orientation: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  92. def Orientation_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  93. var PlanetsideAttribute: Array[Long]

    From PlanetsideAttributeMessage

  94. def Position: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  95. def Position_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  96. def RadiationShielding: Float
    Definition Classes
    Player → ResistanceProfile
  97. def Release: Boolean
  98. def RemoveEffectFromAura(effect: Aura): Set[Aura]
    Definition Classes
    AuraContainer
  99. def ResetControl(): ActorRef
    Definition Classes
    PlanetSideServerObject
  100. def Resist(dtype: vital.base.DamageType.Value): Float
    Definition Classes
    ResistanceProfile
  101. def ResistArmMotion(func: (Player, Int) => Boolean): Unit
  102. def ResistanceAggravated: Int
    Definition Classes
    Player → ResistanceProfile
  103. def ResistanceDirectHit: Int
    Definition Classes
    Player → ResistanceProfile
  104. def ResistanceSplash: Int
    Definition Classes
    Player → ResistanceProfile
  105. def Revive: Boolean
  106. def Sex: CharacterSex
  107. def Slot(slot: Int): EquipmentSlot

    Access to all stowable positions on this object by index.

    All positions, VisibleSlot and Inventory, and wherever else, should be reachable.

    Access to all stowable positions on this object by index.

    All positions, VisibleSlot and Inventory, and wherever else, should be reachable. Regardless of the internal storage medium, the format of return is expected to be the same structure of object as the most basic storage component for Equipment, namely, EquipmentSlot objects. By default, it is expected to return an EquipmentSlot that can not be manipulated because it is Blocked.

    returns

    the searchable position identified by that index

    Definition Classes
    Player → Container
    See also

    OffhandEquipmentSlot

  108. def SlotMapResolution(slot: Int): Int

    When the slot reported is not the slot requested, change the slot.

    When the slot reported is not the slot requested, change the slot.

    slot

    the original slot index

    returns

    the modified slot index

    Definition Classes
    Container
  109. def Spawn(): Boolean
  110. def Subtract: DamageProfile
    Definition Classes
    Player → ResistanceProfile
  111. def TestArmMotion(slot: Int): Boolean
  112. def TestArmMotion(): Boolean
  113. def UsingSpecial: definition.SpecialExoSuitDefinition.Mode.Value
  114. def UsingSpecial_=(state: definition.SpecialExoSuitDefinition.Mode.Value): definition.SpecialExoSuitDefinition.Mode.Value
  115. def VehicleSeated: Option[PlanetSideGUID]
  116. def VehicleSeated_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]
  117. def VehicleSeated_=(guid: PlanetSideGUID): Option[PlanetSideGUID]
  118. def Velocity: Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  119. def Velocity_=(vec: Option[Vector3]): Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  120. def Velocity_=(vec: Vector3): Option[Vector3]
    Definition Classes
    WorldEntity
  121. def VisibleSlots: Set[Int]

    A(n imperfect) reference to a generalized pool of the contained objects.

    Having access to all of the available positions is not required.

    A(n imperfect) reference to a generalized pool of the contained objects.

    Having access to all of the available positions is not required. Only the positions that can be actively viewed by other clients are listed.

    returns

    all of the affected slot indices

    Definition Classes
    Player → Container
    See also

    Inventory

  122. def VitalsHistory(): List[VitalsActivity]

    Only the changes to vitality statistics.

    Only the changes to vitality statistics.

    returns

    a list of the chronologically-consistent vitality events

    Definition Classes
    InGameHistory
  123. def Voice: types.CharacterVoice.Value
  124. def Zone: Zone
    Definition Classes
    ZoneAware
  125. def Zone_=(zone: Zone): Zone

    When assigning a new Zone object for the Vehicle object, eliminate

    When assigning a new Zone object for the Vehicle object, eliminate

    zone

    a reference to the Zone object

    returns

    a reference to the Zone object

    Definition Classes
    ZoneAware
  126. def ZoningRequest: Method
  127. def ZoningRequest_=(request: Method): Method
  128. def allowInteraction: Boolean

    If the interactive permissions of this entity change.

    If the interactive permissions of this entity change.

    Definition Classes
    InteractsWithZone
  129. def allowInteraction_=(permit: Boolean): Boolean

    If the interactive permissions of this entity change, trigger a formal change to the interaction methodology.

    If the interactive permissions of this entity change, trigger a formal change to the interaction methodology.

    permit

    whether or not interaction is permitted

    returns

    whether or not interaction is permitted

    Definition Classes
    InteractsWithZone
  130. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  131. var avatar: Avatar
  132. def blockMapEntry: Option[BlockMapEntry]

    internal data regarding an active representation on a blockmap

    internal data regarding an active representation on a blockmap

    Definition Classes
    BlockMapEntity
  133. def blockMapEntry_=(entry: Option[BlockMapEntry]): Option[BlockMapEntry]

    internal data regarding an active representation on a blockmap

    internal data regarding an active representation on a blockmap

    Definition Classes
    BlockMapEntity
  134. def canEqual(other: Any): Boolean
  135. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  136. var death_by: Int
  137. def doInteractions(): Unit
    Definition Classes
    InteractsWithZone
  138. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  139. def equals(other: Any): Boolean
    Definition Classes
    Player → AnyRef → Any
  140. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  141. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  142. def getInteractionSector(): SectorPopulation
    Definition Classes
    InteractsWithZone
  143. def hashCode(): Int
    Definition Classes
    Player → AnyRef → Any
  144. def interaction(): List[ZoneInteraction]
    Definition Classes
    InteractsWithZone
  145. def interaction(func: ZoneInteraction): List[ZoneInteraction]
    Definition Classes
    InteractsWithZone
  146. def isAlive: Boolean
  147. def isAnchored: Boolean
  148. def isBackpack: Boolean
  149. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  150. def isMoving(test: Float): Boolean

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    test

    the (squared) velocity to test against

    returns

    true, if we are moving; false, otherwise

    Definition Classes
    WorldEntity
  151. def isMoving(test: Vector3): Boolean

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    This object is not considered moving unless it is moving at least as fast as a certain velocity.

    test

    the velocity to test against

    returns

    true, if we are moving; false, otherwise

    Definition Classes
    WorldEntity
  152. def isMoving: Boolean

    A velocity of non-zero is the same as moving.

    A velocity of non-zero is the same as moving.

    returns

    true, if we are moving; false, otherwise

    Definition Classes
    WorldEntity
  153. def isOverdrived: Boolean
  154. def isReleased: Boolean
  155. def isShielded: Boolean
  156. var lastShotSeq_time: Int
  157. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  158. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  159. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  160. def resetInteractions(): Unit
    Definition Classes
    InteractsWithZone
  161. var resistArmMotion: (Player, Int) => Boolean
  162. def sector(zone: Zone, range: Float): SectorPopulation

    Buckets in the blockmap are called "sectors".

    Buckets in the blockmap are called "sectors". Find the sectors in a given blockmap in which the entity would be represented within a given range.

    zone

    what region the blockmap represents

    range

    the custom distance from the central sector along the major axes

    returns

    a conglomerate sector which lists all of the entities in the allocated sector(s)

    Definition Classes
    BlockMapEntity
  163. var silenced: Boolean
  164. var spectator: Boolean
  165. val squadLoadouts: LoadoutManager
  166. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  167. def toString(): String
    Definition Classes
    Player → AnyRef → Any
  168. def updateBlockMapEntry(newCoords: Vector3): Boolean

    Update the internal data's known coordinate position without changing representation on whatever blockmap.

    Update the internal data's known coordinate position without changing representation on whatever blockmap. Has the potential to cause major issues with the blockmap if used without external checks.

    newCoords

    the coordinate position

    returns

    true, if the coordinates were updated; false, otherwise

    Definition Classes
    BlockMapEntity
  169. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  170. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  171. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  172. def zoneInteractions(): Unit
    Definition Classes
    InteractsWithZone

Inherited from MountableEntity

Inherited from AuraContainer

Inherited from JammableUnit

Inherited from Container

Inherited from ResistanceProfile

Inherited from Vitality

Inherited from InGameHistory

Inherited from InteractsWithZone

Inherited from BlockMapEntity

Inherited from PlanetSideServerObject

Inherited from ZoneAware

Inherited from FactionAffinity

Inherited from PlanetSideGameObject

Inherited from WorldEntity

Inherited from IdentifiableEntity

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped