abstract class Amenity extends PlanetSideServerObject with Vitality with StandardResistanceProfile
Amenities are elements of the game that belong to other elements of the game.
Normal PlanetSideServerObject entities (server objects) tend to have properties that are completely internalized.
An Amenity is a server object that maintains a fixed association with another server object.
This association strips away at the internalization and redirects a reference to some properties somewhere else.
An Amenity object belongs to its Owner object;
the Amenity objects look to its Owner object for some of its properties.
- Source
- Amenity.scala
- See also
AmenityOwnerFactionAffinity
- Alphabetic
- By Inheritance
- Amenity
- StandardResistanceProfile
- ResistanceProfile
- Vitality
- VitalsHistory
- PlanetSideServerObject
- ZoneAware
- FactionAffinity
- PlanetSideGameObject
- WorldEntity
- IdentifiableEntity
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Amenity()
Abstract Value Members
- abstract def Definition: AmenityDefinition
- Definition Classes
- Amenity → Vitality → PlanetSideGameObject
Concrete 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[VitalsActivity]
- Definition Classes
- VitalsHistory
- 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 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 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(result: DamageResult): List[VitalsActivity]
Very common example of a
VitalsActivityevent involving damage.Very common example of a
VitalsActivityevent involving damage.- result
the fully-informed entry
- returns
the list of previous changes to this object's vital statistics
- Definition Classes
- VitalsHistory
- def History(action: Option[VitalsActivity]): List[VitalsActivity]
A
VitalsActivityevent must be recorded.A
VitalsActivityevent 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
- def History(action: VitalsActivity): List[VitalsActivity]
A
VitalsActivityevent must be recorded.A
VitalsActivityevent 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
- def History: List[VitalsActivity]
- Definition Classes
- VitalsHistory
- 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
- VitalsHistory
- 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
- def LocationOffset: Vector3
- def LocationOffset_=(off: Option[Vector3]): Vector3
- def LocationOffset_=(off: Vector3): Vector3
- 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"
- 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"
- 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 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 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()