Amenity

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 looks to its Owner object for some of its properties.

Source: Amenity.scala
See also: FactionAffinity

Linear Supertypes

PlanetSideServerObject, ZoneAware, FactionAffinity, PlanetSideGameObject, WorldEntity, IdentifiableEntity, Identifiable, AnyRef, Any

Known Subclasses

CaptureTerminal, Door, FacilityTurret, IFFLock, ImplantTerminalMech, InternalTelepad, Locker, Painbox, ProximityTerminal, ProximityTerminalUtility, ResourceSilo, SpawnTube, SpawnTubeUtility, TeleportPadTerminalUtility, Terminal, TerminalUtility, VehicleSpawnPad

Instance Constructors

new Amenity()

Abstract Value Members

abstract def Definition: ObjectDefinition

Definition Classes
PlanetSideGameObject

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

Implicit information
This member is added by an implicit conversion from Amenity to ArrowAssoc[Amenity] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
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 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 Actor.noSender (null).
control
the Actor whose functionality will govern this server object
returns
the current internal ActorRef

Definition Classes
PlanetSideServerObject
def Continent: String

Definition Classes
Amenity → PlanetSideServerObject → ZoneAware
def Continent_=(zone: String): String

Definition Classes
PlanetSideServerObject → ZoneAware
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 HasGUID: Boolean

Definition Classes
IdentifiableEntity
def Invalidate(): Unit

Definition Classes
IdentifiableEntity
def LocationOffset: Vector3
def LocationOffset_=(off: Option[Vector3]): Vector3
def LocationOffset_=(off: Vector3): Vector3
def Orientation: Vector3

Definition Classes
PlanetSideGameObject → WorldEntity
def Orientation_=(vec: Vector3): Vector3

Definition Classes
PlanetSideGameObject → WorldEntity
def Owner: PlanetSideServerObject

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_=[T](obj: T)(implicit arg0: AmenityTarget[T]): PlanetSideServerObject

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.
T
a validation of the type of object that can be an owner
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 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

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

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

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (Amenity, B)

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

Inherited from PlanetSideServerObject

Related Docs: object Amenity | package structures

abstract class Amenity extends PlanetSideServerObject

Instance Constructors

new Amenity()

Abstract Value Members

abstract def Definition: ObjectDefinition

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Amenity, B)

final def ==(arg0: Any): Boolean

def Actor: ActorRef

def Actor_=(control: ActorRef): ActorRef

def Continent: String

def Continent_=(zone: String): String

def Entity: WorldEntity

def Entity_=(newEntity: WorldEntity): Unit

def Faction: types.PlanetSideEmpire.Value

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

def GUID: PlanetSideGUID

def GUID_=(guid: PlanetSideGUID): PlanetSideGUID

def HasGUID: Boolean

def Invalidate(): Unit

def LocationOffset: Vector3

def LocationOffset_=(off: Option[Vector3]): Vector3

def LocationOffset_=(off: Vector3): Vector3

def Orientation: Vector3

def Orientation_=(vec: Vector3): Vector3

def Owner: PlanetSideServerObject

def Owner_=[T](obj: T)(implicit arg0: AmenityTarget[T]): PlanetSideServerObject

def Position: Vector3

def Position_=(vec: Vector3): Vector3

def Velocity: Option[Vector3]

def Velocity_=(vec: Option[Vector3]): Option[Vector3]

def Velocity_=(vec: Vector3): Option[Vector3]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (Amenity) ⇒ Boolean, msg: ⇒ Any): Amenity

def ensuring(cond: (Amenity) ⇒ Boolean): Amenity

def ensuring(cond: Boolean, msg: ⇒ Any): Amenity

def ensuring(cond: Boolean): Amenity

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (Amenity, B)

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

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

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

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

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

Ungrouped