Packages

class Player extends PlanetSideServerObject with InteractsWithZoneEnvironment with FactionAffinity with Vitality with ResistanceProfile with Container with JammableUnit with ZoneAware with AuraContainer

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Player
  2. AuraContainer
  3. JammableUnit
  4. Container
  5. ResistanceProfile
  6. Vitality
  7. VitalsHistory
  8. InteractsWithZoneEnvironment
  9. PlanetSideServerObject
  10. ZoneAware
  11. FactionAffinity
  12. PlanetSideGameObject
  13. WorldEntity
  14. IdentifiableEntity
  15. Identifiable
  16. AnyRef
  17. 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 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

  16. def CanDamage: Boolean
    Definition Classes
    Vitality
  17. def CanRepair: Boolean
    Definition Classes
    Vitality
  18. def Capacitor: Float
  19. def CapacitorLastChargedMillis: Long
  20. def CapacitorLastUsedMillis: Long
  21. def CapacitorState: types.CapacitorStateType.Value
  22. def CapacitorState_=(value: types.CapacitorStateType.Value): types.CapacitorStateType.Value
  23. def Capacitor_=(value: Float): Float
  24. def CharId: Long
  25. def ClearHistory(): List[VitalsActivity]
    Definition Classes
    VitalsHistory
  26. def Cloaked: Boolean
  27. def Cloaked_=(isCloaked: Boolean): Boolean
  28. 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

  29. def Continent: String
    Definition Classes
    ZoneAware
  30. 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
  31. def Crouching: Boolean
  32. def Crouching_=(crouched: Boolean): Boolean
  33. def DamageModel: DamageResistanceModel
    Definition Classes
    Player → Vitality
  34. def DefaultHealth: Int
    Definition Classes
    Vitality
  35. def Definition: AvatarDefinition
    Definition Classes
    Player → Vitality → PlanetSideGameObject
  36. def Destroyed: Boolean
    Definition Classes
    PlanetSideGameObject
  37. def Destroyed_=(state: Boolean): Boolean
    Definition Classes
    PlanetSideGameObject
  38. def Die: Boolean
  39. def DrawnSlot: Int
  40. def DrawnSlot_=(slot: Int): Int
  41. def Entity: WorldEntity
    Definition Classes
    PlanetSideGameObject
  42. def Entity_=(newEntity: WorldEntity): Unit
    Definition Classes
    PlanetSideGameObject
  43. def ExoSuit: types.ExoSuitType.Value
  44. def ExoSuitDef: ExoSuitDefinition
  45. def ExoSuit_=(suit: types.ExoSuitType.Value): Unit
  46. def FacingYawUpper: Float
  47. def FacingYawUpper_=(facing: Float): Float
  48. def Faction: types.PlanetSideEmpire.Value
    Definition Classes
    Player → FactionAffinity
  49. def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
    Definition Classes
    FactionAffinity
  50. 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
  51. 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
  52. def Fit(obj: Equipment): Option[Int]
    Definition Classes
    Player → Container
  53. def Fit(tile: InventoryTile): Option[Int]
    Definition Classes
    Container
  54. def FreeHand: EquipmentSlot
  55. def FreeHand_=(item: Option[Equipment]): Option[Equipment]
  56. def GUID: PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  57. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID
    Definition Classes
    IdentifiableEntity → Identifiable
  58. 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

  59. 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
  60. def Head: Int
  61. def Health: Int
    Definition Classes
    Vitality
  62. def Health_=(assignHealth: Int): Int
    Definition Classes
    Vitality
  63. def History(result: DamageResult): List[VitalsActivity]

    Very common example of a VitalsActivity event involving damage.

    Very common example of a VitalsActivity event involving damage.

    result

    the fully-informed entry

    returns

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

    Definition Classes
    VitalsHistory
  64. def History(action: Option[VitalsActivity]): List[VitalsActivity]

    A VitalsActivity event must be recorded.

    A VitalsActivity 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 object's vital statistics

    Definition Classes
    VitalsHistory
  65. def History(action: VitalsActivity): List[VitalsActivity]

    A VitalsActivity event must be recorded.

    A VitalsActivity 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 object's vital statistics

    Definition Classes
    VitalsHistory
  66. def History: List[VitalsActivity]
    Definition Classes
    VitalsHistory
  67. 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

  68. def Holsters(): Array[EquipmentSlot]
  69. 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
  70. 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

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

    Find, specifically, the last instance of a weapon discharge vital statistics change.

    Find, specifically, the last instance of a weapon discharge vital statistics change.

    returns

    information about the discharge

    Definition Classes
    VitalsHistory
  78. def MaxArmor: Int
  79. def MaxHealth: Int
    Definition Classes
    Vitality
  80. def MaxHealth_=(default: Option[Int]): Int
    Definition Classes
    Vitality
  81. def MaxHealth_=(default: Int): Int
    Definition Classes
    Vitality
  82. def Name: String
  83. def Orientation: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  84. def Orientation_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  85. var PlanetsideAttribute: Array[Long]

    From PlanetsideAttributeMessage

  86. def Position: Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  87. def Position_=(vec: Vector3): Vector3
    Definition Classes
    PlanetSideGameObject → WorldEntity
  88. def RadiationShielding: Float
    Definition Classes
    Player → ResistanceProfile
  89. def Release: Boolean
  90. def RemoveEffectFromAura(effect: Aura): Set[Aura]
    Definition Classes
    AuraContainer
  91. def ResetControl(): ActorRef
    Definition Classes
    PlanetSideServerObject
  92. def Resist(dtype: vital.base.DamageType.Value): Float
    Definition Classes
    ResistanceProfile
  93. def ResistanceAggravated: Int
    Definition Classes
    Player → ResistanceProfile
  94. def ResistanceDirectHit: Int
    Definition Classes
    Player → ResistanceProfile
  95. def ResistanceSplash: Int
    Definition Classes
    Player → ResistanceProfile
  96. def Revive: Boolean
  97. def Sex: CharacterSex
  98. 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

  99. def Spawn(): Boolean
  100. def Subtract: DamageProfile
    Definition Classes
    Player → ResistanceProfile
  101. def UsingSpecial: definition.SpecialExoSuitDefinition.Mode.Value
  102. def UsingSpecial_=(state: definition.SpecialExoSuitDefinition.Mode.Value): definition.SpecialExoSuitDefinition.Mode.Value
  103. def VehicleSeated: Option[PlanetSideGUID]
  104. def VehicleSeated_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]
  105. def VehicleSeated_=(guid: PlanetSideGUID): Option[PlanetSideGUID]
  106. def Velocity: Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  107. def Velocity_=(vec: Option[Vector3]): Option[Vector3]
    Definition Classes
    PlanetSideGameObject → WorldEntity
  108. def Velocity_=(vec: Vector3): Option[Vector3]
    Definition Classes
    WorldEntity
  109. 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

  110. def Voice: types.CharacterVoice.Value
  111. def Zone: Zone
    Definition Classes
    ZoneAware
  112. 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
  113. def allowZoneEnvironmentInteractions: Boolean

    If the environmental interactive permissions of this entity change.

    If the environmental interactive permissions of this entity change.

    Definition Classes
    InteractsWithZoneEnvironment
  114. def allowZoneEnvironmentInteractions_=(allow: Boolean): Boolean

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

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

    allow

    whether or not interaction is permitted

    returns

    whether or not interaction is permitted

    Definition Classes
    InteractsWithZoneEnvironment
  115. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  116. var avatar: Avatar
  117. def canEqual(other: Any): Boolean
  118. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  119. var death_by: Int
  120. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  121. def equals(other: Any): Boolean
    Definition Classes
    Player → AnyRef → Any
  122. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  123. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  124. def hashCode(): Int
    Definition Classes
    Player → AnyRef → Any
  125. def isAlive: Boolean
  126. def isAnchored: Boolean
  127. def isBackpack: Boolean
  128. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  129. 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
  130. 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
  131. 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
  132. def isOverdrived: Boolean
  133. def isShielded: Boolean
  134. var lastSeenStreamMessage: Array[Long]
  135. var lastShotSeq_time: Int
  136. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  137. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  138. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  139. def resetZoneInteraction(): Unit

    Suspend any current interaction procedures through the proper channels or deactivate a previously flagged interaction blocking procedure and reset the system to its neutral state.

    Suspend any current interaction procedures through the proper channels or deactivate a previously flagged interaction blocking procedure and reset the system to its neutral state. The main difference between resetting and flagging the blocking procedure is that resetting will (probably) restore the previously active procedure on the next zoneInteraction call while blocking will halt all attempts to establish a new active interaction procedure and unblocking will immediately install whatever is the current active interaction.

    Definition Classes
    InteractsWithZoneEnvironment
    See also

    InteractsWithZoneEnvironment.onStableEnvironment

  140. var silenced: Boolean
  141. var spectator: Boolean
  142. val squadLoadouts: LoadoutManager
  143. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  144. def toString(): String
    Definition Classes
    Player → AnyRef → Any
  145. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  146. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  147. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  148. def zoneInteraction(): Unit

    The method by which zone interactions are tested or a current interaction maintained.

    The method by which zone interactions are tested or a current interaction maintained. Utilize a function literal that, when called, returns a function literal of the same type; the function that is returned will not necessarily be the same as the one that was used but will represent the existing and ongoing status of interaction with the environment. Calling one function and exchanging it for another function to be called like this creates a procedure that controls and limits the interactions with the environment to only what is necessary.

    Definition Classes
    InteractsWithZoneEnvironment
    See also

    InteractsWithZoneEnvironment.blockedFromInteracting

    InteractsWithZoneEnvironment.onStableEnvironment

    InteractsWithZoneEnvironment.awaitOngoingInteraction

Inherited from AuraContainer

Inherited from JammableUnit

Inherited from Container

Inherited from ResistanceProfile

Inherited from Vitality

Inherited from VitalsHistory

Inherited from InteractsWithZoneEnvironment

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