Class/Object

net.psforever.objects

Player

Related Docs: object Player | package objects

Permalink

class Player extends PlanetSideGameObject with FactionAffinity with Vitality with ResistanceProfile with Container with ZoneAware

Source
Player.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Player
  2. ZoneAware
  3. Container
  4. ResistanceProfile
  5. Vitality
  6. FactionAffinity
  7. PlanetSideGameObject
  8. WorldEntity
  9. IdentifiableEntity
  10. Identifiable
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Player(core: Avatar)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to any2stringadd[Player] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Player, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to ArrowAssoc[Player] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def AccessingBackpack: Option[PlanetSideGUID]

    Permalink
  7. def AccessingBackpack_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]

    Permalink

    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

  8. def AccessingBackpack_=(guid: PlanetSideGUID): Option[PlanetSideGUID]

    Permalink
  9. def AddToPersonalStyle(value: packet.game.objectcreate.PersonalStyle.Value): (Option[Cosmetics], Option[Cosmetics])

    Permalink
  10. def Armor: Int

    Permalink
  11. def Armor_=(assignArmor: Int): Int

    Permalink
  12. def BEP: Long

    Permalink
  13. def CEP: Long

    Permalink
  14. def CanAccessBackpack(player: Player): Boolean

    Permalink

    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

  15. def Certifications: Set[types.CertificationType.Value]

    Permalink
  16. def ClearHistory(): List[VitalsActivity]

    Permalink
    Definition Classes
    Vitality
  17. def Cloaked: Boolean

    Permalink
  18. def Cloaked_=(isCloaked: Boolean): Boolean

    Permalink
  19. def Collisions(dest: Int, width: Int, height: Int): Try[List[InventoryItem]]

    Permalink

    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
    PlayerContainer
    See also

    GridInventory.CheckCollisionsVar

  20. def Continent: String

    Permalink
    Definition Classes
    PlayerZoneAware
  21. def Continent_=(zoneId: String): String

    Permalink
    Definition Classes
    PlayerZoneAware
  22. def Crouching: Boolean

    Permalink
  23. def Crouching_=(crouched: Boolean): Boolean

    Permalink
  24. def DamageModel: DamageResistanceModel

    Permalink
    Definition Classes
    PlayerVitality
  25. def Definition: AvatarDefinition

    Permalink
    Definition Classes
    PlayerPlanetSideGameObject
  26. def Die: Boolean

    Permalink
  27. def DrawnSlot: Int

    Permalink
  28. def DrawnSlot_=(slot: Int): Int

    Permalink
  29. def Entity: WorldEntity

    Permalink
    Definition Classes
    PlanetSideGameObject
  30. def Entity_=(newEntity: WorldEntity): Unit

    Permalink
    Definition Classes
    PlanetSideGameObject
  31. def ExoSuit: types.ExoSuitType.Value

    Permalink
  32. def ExoSuit_=(suit: types.ExoSuitType.Value): Unit

    Permalink
  33. def FacingYawUpper: Float

    Permalink
  34. def FacingYawUpper_=(facing: Float): Float

    Permalink
  35. def Faction: types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    PlayerFactionAffinity
  36. def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value

    Permalink
    Definition Classes
    FactionAffinity
  37. def Find(guid: PlanetSideGUID): Option[Int]

    Permalink

    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
    PlayerContainer
  38. def Find(obj: Equipment): Option[Int]

    Permalink

    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
  39. def Fit(obj: Equipment): Option[Int]

    Permalink
    Definition Classes
    PlayerContainer
  40. def Fit(tile: InventoryTile): Option[Int]

    Permalink
    Definition Classes
    Container
  41. def FreeHand: EquipmentSlot

    Permalink
  42. def FreeHand_=(item: Option[Equipment]): Option[Equipment]

    Permalink
  43. def GUID: PlanetSideGUID

    Permalink
    Definition Classes
    IdentifiableEntityIdentifiable
  44. def GUID_=(guid: PlanetSideGUID): PlanetSideGUID

    Permalink
    Definition Classes
    IdentifiableEntityIdentifiable
  45. def HasGUID: Boolean

    Permalink
    Definition Classes
    IdentifiableEntity
  46. def Head: Int

    Permalink
  47. def Health: Int

    Permalink
  48. def Health_=(assignHealth: Int): Int

    Permalink
  49. def History(projectile: ResolvedProjectile): List[VitalsActivity]

    Permalink

    Very common example of a VitalsActivity event involving weapon discharge.

    Very common example of a VitalsActivity event involving weapon discharge.

    projectile

    the fully-informed entry of discharge of a weapon

    returns

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

    Definition Classes
    Vitality
  50. def History(action: VitalsActivity): List[VitalsActivity]

    Permalink

    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
    Vitality
  51. def History: List[VitalsActivity]

    Permalink
    Definition Classes
    Vitality
  52. def Holsters(): Array[EquipmentSlot]

    Permalink
  53. def Implant(slot: Int): types.ImplantType.Value

    Permalink

    What kind of implant is installed into the given slot number?

    What kind of implant is installed into the given slot number?

    slot

    the slot number

    returns

    the tye of implant

    See also

    ImplantType

  54. def Implants: Array[(types.ImplantType.Value, Long, Boolean)]

    Permalink

    A read-only Array of tuples representing important information about all unlocked implant slots.

    A read-only Array of tuples representing important information about all unlocked implant slots.

    returns

    a maximum of three implant types, initialization times, and active flags

  55. def Invalidate(): Unit

    Permalink
    Definition Classes
    IdentifiableEntity
  56. def Inventory: GridInventory

    Permalink

    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
    PlayerContainer
    See also

    VisibleSlots

  57. def Jumping: Boolean

    Permalink
  58. def Jumping_=(jumped: Boolean): Boolean

    Permalink
  59. def LastDrawnSlot: Int

    Permalink
  60. def LastShot: Option[ResolvedProjectile]

    Permalink

    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
    Vitality
  61. def LoadLoadout(line: Int): Option[Loadout]

    Permalink
  62. def Locker: LockerContainer

    Permalink
  63. def MaxArmor: Int

    Permalink
  64. def MaxHealth: Int

    Permalink
  65. def MaxHealth_=(max: Int): Int

    Permalink
  66. def MaxStamina: Int

    Permalink
  67. def MaxStamina_=(max: Int): Int

    Permalink
  68. def Name: String

    Permalink
  69. def Orientation: Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  70. def Orientation_=(vec: Vector3): Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  71. def PersonalStyleFeatures: Option[Cosmetics]

    Permalink
  72. var PlanetsideAttribute: Array[Long]

    Permalink

    From PlanetsideAttributeMessage

  73. def Position: Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  74. def Position_=(vec: Vector3): Vector3

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  75. def RadiationShielding: Float

    Permalink
    Definition Classes
    PlayerResistanceProfile
  76. def Release: Boolean

    Permalink
  77. def RemoveFromPersonalStyle(value: packet.game.objectcreate.PersonalStyle.Value): (Option[Cosmetics], Option[Cosmetics])

    Permalink
  78. def ResetAllImplants(): Unit

    Permalink
  79. def Resist(dtype: vital.DamageType.Value): Float

    Permalink
    Definition Classes
    ResistanceProfile
  80. def ResistanceAggravated: Int

    Permalink
    Definition Classes
    PlayerResistanceProfile
  81. def ResistanceDirectHit: Int

    Permalink
    Definition Classes
    PlayerResistanceProfile
  82. def ResistanceSplash: Int

    Permalink
    Definition Classes
    PlayerResistanceProfile
  83. def Sex: types.CharacterGender.Value

    Permalink
  84. def Slot(slot: Int): EquipmentSlot

    Permalink

    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
    PlayerContainer
    See also

    OffhandEquipmentSlot

  85. def Spawn: Boolean

    Permalink
  86. def Stamina: Int

    Permalink
  87. def Stamina_=(assignEnergy: Int): Int

    Permalink
  88. def Subtract: DamageProfile

    Permalink
    Definition Classes
    PlayerResistanceProfile
  89. def ToggleEarpiece: (Option[Cosmetics], Option[Cosmetics])

    Permalink
  90. def ToggleHat: (Option[Cosmetics], Option[Cosmetics])

    Permalink
  91. def ToggleHelmet: (Option[Cosmetics], Option[Cosmetics])

    Permalink
  92. def ToggleShades: (Option[Cosmetics], Option[Cosmetics])

    Permalink
  93. def UsingSpecial: definition.SpecialExoSuitDefinition.Mode.Value

    Permalink
  94. def UsingSpecial_=(state: definition.SpecialExoSuitDefinition.Mode.Value): definition.SpecialExoSuitDefinition.Mode.Value

    Permalink
  95. def VehicleOwned: Option[PlanetSideGUID]

    Permalink
  96. def VehicleOwned_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]

    Permalink
  97. def VehicleOwned_=(guid: PlanetSideGUID): Option[PlanetSideGUID]

    Permalink
  98. def VehicleSeated: Option[PlanetSideGUID]

    Permalink
  99. def VehicleSeated_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]

    Permalink
  100. def VehicleSeated_=(guid: PlanetSideGUID): Option[PlanetSideGUID]

    Permalink
  101. def Velocity: Option[Vector3]

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  102. def Velocity_=(vec: Option[Vector3]): Option[Vector3]

    Permalink
    Definition Classes
    PlanetSideGameObjectWorldEntity
  103. def Velocity_=(vec: Vector3): Option[Vector3]

    Permalink
    Definition Classes
    WorldEntity
  104. def VisibleSlots: Set[Int]

    Permalink

    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
    PlayerContainer
    See also

    Inventory

  105. def Voice: types.CharacterVoice.Value

    Permalink
  106. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  107. def canEqual(other: Any): Boolean

    Permalink
  108. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. def ensuring(cond: (Player) ⇒ Boolean, msg: ⇒ Any): Player

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to Ensuring[Player] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  110. def ensuring(cond: (Player) ⇒ Boolean): Player

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to Ensuring[Player] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  111. def ensuring(cond: Boolean, msg: ⇒ Any): Player

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to Ensuring[Player] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  112. def ensuring(cond: Boolean): Player

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to Ensuring[Player] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  113. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  114. def equals(other: Any): Boolean

    Permalink
    Definition Classes
    Player → AnyRef → Any
  115. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  116. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to StringFormat[Player] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  117. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  118. def hashCode(): Int

    Permalink
    Definition Classes
    Player → AnyRef → Any
  119. def isAlive: Boolean

    Permalink
  120. def isAnchored: Boolean

    Permalink
  121. def isBackpack: Boolean

    Permalink
  122. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  123. def isOverdrived: Boolean

    Permalink
  124. def isShielded: Boolean

    Permalink
  125. var lastMedkit: Long

    Permalink

    Last medkituse.

  126. var lastSeenStreamMessage: Array[Long]

    Permalink
  127. var lastShotSeq_time: Int

    Permalink
  128. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  129. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  130. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  131. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  132. def toString(): String

    Permalink
    Definition Classes
    Player → AnyRef → Any
  133. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  134. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  135. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. def [B](y: B): (Player, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Player to ArrowAssoc[Player] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from ZoneAware

Inherited from Container

Inherited from ResistanceProfile

Inherited from Vitality

Inherited from FactionAffinity

Inherited from PlanetSideGameObject

Inherited from WorldEntity

Inherited from IdentifiableEntity

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Player to any2stringadd[Player]

Inherited by implicit conversion StringFormat from Player to StringFormat[Player]

Inherited by implicit conversion Ensuring from Player to Ensuring[Player]

Inherited by implicit conversion ArrowAssoc from Player to ArrowAssoc[Player]

Ungrouped