class Locker extends Amenity with Hackable
- Source
- Locker.scala
- Alphabetic
- By Inheritance
- Locker
- Hackable
- Amenity
- BlockMapEntity
- StandardResistanceProfile
- ResistanceProfile
- Vitality
- InGameHistory
- PlanetSideServerObject
- ZoneAware
- FactionAffinity
- PlanetSideGameObject
- WorldEntity
- IdentifiableEntity
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Locker()
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def Actor: ActorRef
Retrieve a reference to the internal
Actor.Retrieve a reference to the internal
Actor.- returns
the internal
ActorRef
- Definition Classes
- PlanetSideServerObject
- def Actor_=(control: ActorRef): ActorRef
Assign an
Actorto act for this server object.Assign an
Actorto act for this server object. This reference is only set once, that is, as long as the internalActorRefdirects toActorRef.noSender(null).- control
the
Actorwhose functionality will govern this server object- returns
the current internal
ActorRef
- Definition Classes
- PlanetSideServerObject
- def CanDamage: Boolean
- Definition Classes
- Vitality
- def CanRepair: Boolean
- Definition Classes
- Vitality
- def ClearHistory(): List[InGameActivity]
- Definition Classes
- InGameHistory
- def Continent: String
- Definition Classes
- ZoneAware
- def Continent_=(zoneId: String): String
Give the entity a custom
Zoneidentifier.Give the entity a custom
Zoneidentifier.- zoneId
the custom identifier of the
Zoneobject- returns
the identifier of the
Zoneobject
- Definition Classes
- ZoneAware
- def DamageModel: DamageAndResistance
- def DefaultHealth: Int
- Definition Classes
- Vitality
- def Definition: LockerDefinition
- Definition Classes
- Locker → Amenity → Vitality → PlanetSideGameObject
- def Destroyed: Boolean
- Definition Classes
- PlanetSideGameObject
- def Destroyed_=(state: Boolean): Boolean
- Definition Classes
- PlanetSideGameObject
- def Entity: WorldEntity
- Definition Classes
- PlanetSideGameObject
- def Entity_=(newEntity: WorldEntity): Unit
- Definition Classes
- PlanetSideGameObject
- def Faction: types.PlanetSideEmpire.Value
- Definition Classes
- Amenity → FactionAffinity
- def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
- Definition Classes
- FactionAffinity
- def GUID: PlanetSideGUID
- Definition Classes
- IdentifiableEntity → Identifiable
- def GUID_=(guid: PlanetSideGUID): PlanetSideGUID
- Definition Classes
- IdentifiableEntity → Identifiable
- def GUID_=(guid: StalePlanetSideGUID): PlanetSideGUID
Always intercept
StalePlanetSideGUIDreferences when attempting to mutate the GUID value.Always intercept
StalePlanetSideGUIDreferences when attempting to mutate the GUID value.- guid
the valid GUID to assign
- returns
never returns
- Definition Classes
- IdentifiableEntity
- Exceptions thrown
`AssigningGUIDException`always
- def HackDuration: Array[Int]
- Definition Classes
- Hackable
- def HackDuration_=(arr: Array[Int]): Array[Int]
- Definition Classes
- Hackable
- def HackEffectDuration: Array[Int]
- Definition Classes
- Hackable
- def HackEffectDuration_=(arr: Array[Int]): Array[Int]
- Definition Classes
- Hackable
- def HackSound: packet.game.TriggeredSound.Value
- Definition Classes
- Hackable
- def HackSound_=(sound: packet.game.TriggeredSound.Value): packet.game.TriggeredSound.Value
- Definition Classes
- Hackable
- def HackedBy: Option[HackInfo]
- Definition Classes
- Hackable
- def HackedBy_=(hackInfo: HackInfo): Option[HackInfo]
- Definition Classes
- Hackable
- def HackedBy_=(agent: Option[Player]): Option[HackInfo]
Set the hack state of this object by recording important information about the player who caused it.
Set the hack state of this object by recording important information about the player who caused it. Set the hack state if there is no current hack state. Override the hack state with a new hack state if the new user has different faction affiliation.
- agent
a
Player, or no player- returns
the player hack entry
- Definition Classes
- Hackable
- def HackedBy_=(agent: Player): Option[HackInfo]
- Definition Classes
- Hackable
- 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
- def Health: Int
- Definition Classes
- Vitality
- def Health_=(assignHealth: Int): Int
- Definition Classes
- Vitality
- def History: List[InGameActivity]
- Definition Classes
- InGameHistory
- 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
StalePlanetSideGUIDentity 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
- def LastDamage: Option[DamageResult]
- Definition Classes
- InGameHistory
- 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
- def LocationOffset: Vector3
- Definition Classes
- Amenity
- def LocationOffset_=(off: Option[Vector3]): Vector3
- Definition Classes
- Amenity
- def LocationOffset_=(off: Vector3): Vector3
- Definition Classes
- Amenity
- def LogActivity(result: DamageResult): List[InGameActivity]
Very common example of a
VitalsActivityevent involving damage.Very common example of a
VitalsActivityevent 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
- 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
- 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
- def MaxHealth: Int
- Definition Classes
- Vitality
- def MaxHealth_=(default: Option[Int]): Int
- Definition Classes
- Vitality
- def MaxHealth_=(default: Int): Int
- Definition Classes
- Vitality
- def Orientation: Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Orientation_=(vec: Vector3): Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Owner: AmenityOwner
Reference the object that is in direct association with (is superior to) this one.
Reference the object that is in direct association with (is superior to) this one.
- returns
the object associated as this object's "owner"
- Definition Classes
- Amenity
- def Owner_=(obj: AmenityOwner): AmenityOwner
Set an object to have a direct association with (be superior to) this one.
Set an object to have a direct association with (be superior to) this one.
- obj
the object trying to become associated as this object's "owner"
- returns
the object associated as this object's "owner"
- Definition Classes
- Amenity
- See also
Amenity.AmenityTarget
- def Position: Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Position_=(vec: Vector3): Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def RadiationShielding: Float
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def ResetControl(): ActorRef
- Definition Classes
- PlanetSideServerObject
- def Resist(dtype: vital.base.DamageType.Value): Float
- Definition Classes
- ResistanceProfile
- def ResistanceAggravated: Int
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def ResistanceDirectHit: Int
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def ResistanceSplash: Int
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def Subtract: DamageProfile
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def Velocity: Option[Vector3]
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Velocity_=(vec: Option[Vector3]): Option[Vector3]
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Velocity_=(vec: Vector3): Option[Vector3]
- Definition Classes
- WorldEntity
- 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
- def Zone: Zone
- def Zone_=(zone: Zone): Zone
When assigning a new
Zoneobject for theVehicleobject, eliminateWhen assigning a new
Zoneobject for theVehicleobject, eliminate- zone
a reference to the
Zoneobject- returns
a reference to the
Zoneobject
- Definition Classes
- ZoneAware
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()