Zone

Instance Constructors

new Zone(zoneId: String, zoneMap: ZoneMap, zoneNumber: Int)

zoneId
the privileged name that can be used as the second parameter in the packet LoadMapMessage
zoneMap
the map of server objects upon which this Zone is based
zoneNumber
the numerical index of the Zone as it is recognized in a variety of packets; also used by LivePlayerList to indicate a specific Zone

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 Zone to any2stringadd[Zone] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Zone, B)

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

Definition Classes
AnyRef → Any
def Activity: ActorRef
def Actor: ActorRef

A reference to the primary Actor that governs this Zone.
A reference to the primary Actor that governs this Zone.
returns
an ActorRef

See also
ZoneActor
Zone.Init
def Actor_=(zoneActor: ActorRef): ActorRef

Give this Zone an Actor that will govern its interactions sequentially.
Give this Zone an Actor that will govern its interactions sequentially.
zoneActor
an ActorRef for this Zone; will not overwrite any existing governance unless noSender
returns
an ActorRef

See also
ZoneActor
def AddPool(name: String, pool: Seq[Int]): Boolean

Wraps around the globally unique identifier system to insert a new number pool.
Wraps around the globally unique identifier system to insert a new number pool. Throws exceptions for specific reasons if the pool can not be populated before the system has been started.
name
the name of the pool
pool
the numbers that will belong to the pool
returns
true, if the new pool is created; false, if the new pool can not be created because the system has already been started

See also
NumberPoolHub.AddPool
def Building(id: Int): Option[Building]
def BuildingByMapId(map_id: Int): Option[Building]
def Buildings: Map[Int, Building]
def ClientInitialization(): Zone

Provide bulk correspondence on all map entities that can be composed into packet messages and reported to a client.
Provide bulk correspondence on all map entities that can be composed into packet messages and reported to a client. These messages are sent in this fashion at the time of joining the server:
- BuildingInfoUpdateMessage
- DensityLevelUpdateMessage
- BroadcastWarpgateUpdateMessage
- CaptureFlagUpdateMessage
- ContinentalLockUpdateMessage
- ModuleLimitsMessage
- VanuModuleUpdateMessage
- ZoneForcedCavernConnectionMessage
- ZoneInfoMessage
- ZoneLockInfoMessage
- ZonePopulationUpdateMessage
returns
the Zone object
def Corpses: List[Player]
def DeployableList: List[PlanetSideGameObject with Deployable]
def Deployables: ActorRef
def EquipmentOnGround: List[Equipment]

The List of items (Equipment) dropped by players on the ground and can be collected again.
The List of items (Equipment) dropped by players on the ground and can be collected again.
returns
the List of Equipment
def GUID(object_guid: Int): Option[PlanetSideGameObject]

Recover an object from the globally unique identifier system by the number that was assigned previously.
Recover an object from the globally unique identifier system by the number that was assigned previously. The object must be upcast into due to the differtence between the storage type and the return type.
object_guid
the globally unique identifier requested
returns
the associated object, if it exists

See also
NumberPoolHub(Int)
def GUID(object_guid: PlanetSideGUID): Option[PlanetSideGameObject]

Recover an object from the globally unique identifier system by the number that was assigned previously.
Recover an object from the globally unique identifier system by the number that was assigned previously.
object_guid
the globally unique identifier requested
returns
the associated object, if it exists

See also
GUID(Int)
def GUID(object_guid: Option[PlanetSideGUID]): Option[PlanetSideGameObject]

Recover an object from the globally unique identifier system by the number that was assigned previously.
Recover an object from the globally unique identifier system by the number that was assigned previously.
object_guid
the globally unique identifier requested
returns
the associated object, if it exists

See also
GUID(Int)
def GUID(hub: NumberPoolHub): Boolean

Replace the current globally unique identifier system with a new one.
Replace the current globally unique identifier system with a new one. The replacement will not occur if the current system is populated or if its synchronized reference has been created. The primary use of this function should be testing. A warning will be issued.
returns
synchronized reference to the globally unique identifier system
def GUID: ActorRef

The globally unique identifier system is synchronized via an Actor to ensure that concurrent requests do not clash.
The globally unique identifier system is synchronized via an Actor to ensure that concurrent requests do not clash. A clash is merely when the same number is produced more than once by the same system due to concurrent requests.
returns
synchronized reference to the globally unique identifier system
def Ground: ActorRef

Coordinate Equipment that has been dropped on the ground or to-be-dropped on the ground.
Coordinate Equipment that has been dropped on the ground or to-be-dropped on the ground.
returns
synchronized reference to the ground

See also
ZoneGroundActor
Zone.DropItemOnGround
Zone.GetItemOnGround
Zone.ItemFromGround
def HotSpotCoordinateFunction: (Vector3) ⇒ Vector3
def HotSpotCoordinateFunction_=(func: (Vector3) ⇒ Vector3): (Vector3) ⇒ Vector3
def HotSpotTimeFunction: (SourceEntry, SourceEntry) ⇒ FiniteDuration
def HotSpotTimeFunction_=(func: (SourceEntry, SourceEntry) ⇒ FiniteDuration): (SourceEntry, SourceEntry) ⇒ FiniteDuration
def HotSpots: List[HotSpotInfo]
def HotSpots_=(spots: Seq[HotSpotInfo]): List[HotSpotInfo]
def Id: String

The privileged name that can be used as the second parameter in the packet LoadMapMessage.
The privileged name that can be used as the second parameter in the packet LoadMapMessage.
returns
the name
def Init(implicit context: ActorContext): Unit

Establish the basic accessible conditions necessary for a functional Zone.

Called from the Actor that governs this Zone when it is passed a constructor reference to the Zone.
Establish the basic accessible conditions necessary for a functional Zone.

Called from the Actor that governs this Zone when it is passed a constructor reference to the Zone. Specifically, the order of calling follows: InterstellarCluster.preStart -> ZoneActor.receive(Zone.Init()) -> Zone.Init. The basic method performs three main operations. First, the Actor-driven aspect of the globally unique identifier system for this Zone is finalized. Second, all supporting Actor agents are created, e.g., ground. Third, the ZoneMap server objects are loaded and constructed within that aforementioned system. To avoid being called more than once, there is a test whether the accessor for the globally unique identifier system has been changed.

Execution of this operation should be fail-safe. The chances of failure should be mitigated or skipped. A testing routine should be run after the fact on the results of the process.
context
a reference to an ActorContext necessary for Props

See also
ZoneActor.ZoneSetupCheck
def LivePlayers: List[Player]
def Map: ZoneMap

The map of server objects upon which this Zone is based
The map of server objects upon which this Zone is based
returns
the map
def Number: Int

The numerical index of the Zone as it is recognized in a variety of packets.
The numerical index of the Zone as it is recognized in a variety of packets.
returns
the abstract index position of this Zone
def Players: List[Avatar]
def Population: ActorRef
def RemovePool(name: String): Boolean

Wraps around the globally unique identifier system to remove an existing number pool.
Wraps around the globally unique identifier system to remove an existing number pool. Throws exceptions for specific reasons if the pool can not be removed before the system has been started.
name
the name of the pool
returns
true, if the new pool is un-made; false, if the new pool can not be removed because the system has already been started

See also
NumberPoolHub.RemovePool
def SetupNumberPools(): Unit
def SpawnGroups(spawns: (Building, List[SpawnPoint])): Map[Building, List[SpawnPoint]]
def SpawnGroups(buildingId: Int): List[SpawnPoint]
def SpawnGroups(building: Building): List[SpawnPoint]
def SpawnGroups(): Map[Building, List[SpawnPoint]]
def Transport: ActorRef
def TryHotSpot(displayLoc: Vector3): HotSpotInfo
def VehicleEvents: ActorRef
def VehicleEvents_=(bus: ActorRef): ActorRef
def Vehicles: List[Vehicle]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

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

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

Implicit information
This member is added by an implicit conversion from Zone to Ensuring[Zone] 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 Zone to StringFormat[Zone] 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): (Zone, B)

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

Related Docs: object Zone | package zones

class Zone extends AnyRef

Instance Constructors

new Zone(zoneId: String, zoneMap: ZoneMap, zoneNumber: Int)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: Any): Boolean

def Activity: ActorRef

def Actor: ActorRef

def Actor_=(zoneActor: ActorRef): ActorRef

def AddPool(name: String, pool: Seq[Int]): Boolean

def Building(id: Int): Option[Building]

def BuildingByMapId(map_id: Int): Option[Building]

def Buildings: Map[Int, Building]

def ClientInitialization(): Zone

def Corpses: List[Player]

def DeployableList: List[PlanetSideGameObject with Deployable]

def Deployables: ActorRef

def EquipmentOnGround: List[Equipment]

def GUID(object_guid: Int): Option[PlanetSideGameObject]

def GUID(object_guid: PlanetSideGUID): Option[PlanetSideGameObject]

def GUID(object_guid: Option[PlanetSideGUID]): Option[PlanetSideGameObject]

def GUID(hub: NumberPoolHub): Boolean

def GUID: ActorRef

def Ground: ActorRef

def HotSpotCoordinateFunction: (Vector3) ⇒ Vector3

def HotSpotCoordinateFunction_=(func: (Vector3) ⇒ Vector3): (Vector3) ⇒ Vector3

def HotSpotTimeFunction: (SourceEntry, SourceEntry) ⇒ FiniteDuration

def HotSpotTimeFunction_=(func: (SourceEntry, SourceEntry) ⇒ FiniteDuration): (SourceEntry, SourceEntry) ⇒ FiniteDuration

def HotSpots: List[HotSpotInfo]

def HotSpots_=(spots: Seq[HotSpotInfo]): List[HotSpotInfo]

def Id: String

def Init(implicit context: ActorContext): Unit

def LivePlayers: List[Player]

def Map: ZoneMap

def Number: Int

def Players: List[Avatar]

def Population: ActorRef

def RemovePool(name: String): Boolean

def SetupNumberPools(): Unit

def SpawnGroups(spawns: (Building, List[SpawnPoint])): Map[Building, List[SpawnPoint]]

def SpawnGroups(buildingId: Int): List[SpawnPoint]

def SpawnGroups(building: Building): List[SpawnPoint]

def SpawnGroups(): Map[Building, List[SpawnPoint]]

def Transport: ActorRef

def TryHotSpot(displayLoc: Vector3): HotSpotInfo

def VehicleEvents: ActorRef

def VehicleEvents_=(bus: ActorRef): ActorRef

def Vehicles: List[Vehicle]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

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

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

def ensuring(cond: Boolean): Zone

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): (Zone, B)

Inherited from AnyRef

Inherited from Any

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

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

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