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 Armor: Int
10.  def Armor_=(assignArmor: Int): Int
11.  def AwayFromKeyboard: Boolean
12.  def AwayFromKeyboard_=(away: Boolean): Boolean
13.  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

14.  def CanDamage: Boolean

    Definition Classes

    Vitality

15.  def CanRepair: Boolean

    Definition Classes

    Vitality

16.  def Capacitor: Float
17.  def CapacitorLastChargedMillis: Long
18.  def CapacitorLastUsedMillis: Long
19.  def CapacitorState: types.CapacitorStateType.Value
20.  def CapacitorState_=(value: types.CapacitorStateType.Value): types.CapacitorStateType.Value
21.  def Capacitor_=(value: Float): Float
22.  def CharId: Long
23.  def ClearHistory(): List[VitalsActivity]

    Definition Classes

    VitalsHistory

24.  def Cloaked: Boolean
25.  def Cloaked_=(isCloaked: Boolean): Boolean
26.  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

27.  def Continent: String

    Definition Classes

    ZoneAware

28.  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

29.  def Crouching: Boolean
30.  def Crouching_=(crouched: Boolean): Boolean
31.  def DamageModel: DamageResistanceModel

    Definition Classes

    Player → Vitality

32.  def DefaultHealth: Int

    Definition Classes

    Vitality

33.  def Definition: AvatarDefinition

    Definition Classes

    Player → Vitality → PlanetSideGameObject

34.  def Destroyed: Boolean

    Definition Classes

    PlanetSideGameObject

35.  def Destroyed_=(state: Boolean): Boolean

    Definition Classes

    PlanetSideGameObject

36.  def Die: Boolean
37.  def DrawnSlot: Int
38.  def DrawnSlot_=(slot: Int): Int
39.  def Entity: WorldEntity

    Definition Classes

    PlanetSideGameObject

40.  def Entity_=(newEntity: WorldEntity): Unit

    Definition Classes

    PlanetSideGameObject

41.  def ExoSuit: types.ExoSuitType.Value
42.  def ExoSuitDef: ExoSuitDefinition
43.  def ExoSuit_=(suit: types.ExoSuitType.Value): Unit
44.  def FacingYawUpper: Float
45.  def FacingYawUpper_=(facing: Float): Float
46.  def Faction: types.PlanetSideEmpire.Value

    Definition Classes

    Player → FactionAffinity

47.  def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value

    Definition Classes

    FactionAffinity

48.  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

49.  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

50.  def Fit(obj: Equipment): Option[Int]

    Definition Classes

    Player → Container

51.  def Fit(tile: InventoryTile): Option[Int]

    Definition Classes

    Container

52.  def FreeHand: EquipmentSlot
53.  def FreeHand_=(item: Option[Equipment]): Option[Equipment]
54.  def GUID: PlanetSideGUID

    Definition Classes

    IdentifiableEntity → Identifiable

55.  def GUID_=(guid: PlanetSideGUID): PlanetSideGUID

    Definition Classes

    IdentifiableEntity → Identifiable

56.  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

57.  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

58.  def Head: Int
59.  def Health: Int

    Definition Classes

    Vitality

60.  def Health_=(assignHealth: Int): Int

    Definition Classes

    Vitality

61.  def History(projectile: ResolvedProjectile): List[VitalsActivity]

    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

    VitalsHistory

62.  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

63.  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

64.  def History: List[VitalsActivity]

    Definition Classes

    VitalsHistory

65.  def Holsters(): Array[EquipmentSlot]
66.  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

67.  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

68.  def Jammed: Boolean

    Definition Classes

    JammableUnit

69.  def Jammed_=(state: Boolean): Boolean

    Definition Classes

    JammableUnit

70.  def Jumping: Boolean
71.  def Jumping_=(jumped: Boolean): Boolean
72.  def LastDrawnSlot: Int
73.  def LastShot: Option[ResolvedProjectile]

    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

74.  def MaxArmor: Int
75.  def MaxHealth: Int

    Definition Classes

    Vitality

76.  def MaxHealth_=(default: Option[Int]): Int

    Definition Classes

    Vitality

77.  def MaxHealth_=(default: Int): Int

    Definition Classes

    Vitality

78.  def Name: String
79.  def Orientation: Vector3

    Definition Classes

    PlanetSideGameObject → WorldEntity

80.  def Orientation_=(vec: Vector3): Vector3

    Definition Classes

    PlanetSideGameObject → WorldEntity

81.  var PlanetsideAttribute: Array[Long]

    From PlanetsideAttributeMessage

82.  def Position: Vector3

    Definition Classes

    PlanetSideGameObject → WorldEntity

83.  def Position_=(vec: Vector3): Vector3

    Definition Classes

    PlanetSideGameObject → WorldEntity

84.  def RadiationShielding: Float

    Definition Classes

    Player → ResistanceProfile

85.  def Release: Boolean
86.  def ResetControl(): ActorRef

    Definition Classes

    PlanetSideServerObject

87.  def Resist(dtype: vital.DamageType.Value): Float

    Definition Classes

    ResistanceProfile

88.  def ResistanceAggravated: Int

    Definition Classes

    Player → ResistanceProfile

89.  def ResistanceDirectHit: Int

    Definition Classes

    Player → ResistanceProfile

90.  def ResistanceSplash: Int

    Definition Classes

    Player → ResistanceProfile

91.  def Revive: Boolean
92.  def Sex: types.CharacterGender.Value
93.  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

94.  def Spawn(): Boolean
95.  def Subtract: DamageProfile

    Definition Classes

    Player → ResistanceProfile

96.  def UsingSpecial: definition.SpecialExoSuitDefinition.Mode.Value
97.  def UsingSpecial_=(state: definition.SpecialExoSuitDefinition.Mode.Value): definition.SpecialExoSuitDefinition.Mode.Value
98.  def VehicleSeated: Option[PlanetSideGUID]
99.  def VehicleSeated_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]
100.  def VehicleSeated_=(guid: PlanetSideGUID): Option[PlanetSideGUID]
101.  def Velocity: Option[Vector3]

     Definition Classes

     PlanetSideGameObject → WorldEntity

102.  def Velocity_=(vec: Option[Vector3]): Option[Vector3]

     Definition Classes

     PlanetSideGameObject → WorldEntity

103.  def Velocity_=(vec: Vector3): Option[Vector3]

     Definition Classes

     WorldEntity

104.  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

105.  def Voice: types.CharacterVoice.Value
106.  def Zone: Zone

     Definition Classes

     ZoneAware

107.  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

108.  final def asInstanceOf[T0]: T0

     Definition Classes

     Any

109.  var avatar: Avatar
110.  def canEqual(other: Any): Boolean
111.  def clone(): AnyRef

     Attributes

     protected[lang]

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.CloneNotSupportedException]) @native()

112.  var death_by: Int
113.  final def eq(arg0: AnyRef): Boolean

     Definition Classes

     AnyRef

114.  def equals(other: Any): Boolean

     Definition Classes

     Player → AnyRef → Any

115.  def finalize(): Unit

     Attributes

     protected[lang]

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.Throwable])

116.  final def getClass(): Class[_ <: AnyRef]

     Definition Classes

     AnyRef → Any

     Annotations

     @native()

117.  def hashCode(): Int

     Definition Classes

     Player → AnyRef → Any

118.  def isAlive: Boolean
119.  def isAnchored: Boolean
120.  def isBackpack: Boolean
121.  final def isInstanceOf[T0]: Boolean

     Definition Classes

     Any

122.  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

123.  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

124.  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

125.  def isOverdrived: Boolean
126.  def isShielded: Boolean
127.  var lastSeenStreamMessage: Array[Long]
128.  var lastShotSeq_time: Int
129.  final def ne(arg0: AnyRef): Boolean

     Definition Classes

     AnyRef

130.  final def notify(): Unit

     Definition Classes

     AnyRef

     Annotations

     @native()

131.  final def notifyAll(): Unit

     Definition Classes

     AnyRef

     Annotations

     @native()

132.  var silenced: Boolean
133.  var spectator: Boolean
134.  val squadLoadouts: LoadoutManager
135.  final def synchronized[T0](arg0: => T0): T0

     Definition Classes

     AnyRef

136.  def toString(): String

     Definition Classes

     Player → AnyRef → Any

137.  final def wait(): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.InterruptedException])

138.  final def wait(arg0: Long, arg1: Int): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.InterruptedException])

139.  final def wait(arg0: Long): Unit

     Definition Classes

     AnyRef

     Annotations

     @throws(classOf[java.lang.InterruptedException]) @native()