class WarpGate extends Building with NtuContainer with SpawnPoint
- Source
- WarpGate.scala
- Alphabetic
- By Inheritance
- WarpGate
- SpawnPoint
- NtuContainer
- TransferContainer
- Building
- BlockMapEntity
- AmenityOwner
- PlanetSideServerObject
- ZoneAware
- FactionAffinity
- PlanetSideGameObject
- WorldEntity
- IdentifiableEntity
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new WarpGate(name: String, building_guid: Int, map_id: Int, zone: Zone, buildingDefinition: WarpGateDefinition)
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 Active: Boolean
If a warp gate is active, it can be used to transport faction-affiliated forces between other gates.
If a warp gate is active, it can be used to transport faction-affiliated forces between other gates. For transportation of faction-opposed forces, use broadcast logic for that faction.
- returns
true, if the warp gate can be used for transport;false, otherwise
- def Active_=(state: Boolean): Boolean
Control whether a warp gate is usable for transporting faction-affiliated forces between other gates.
Control whether a warp gate is usable for transporting faction-affiliated forces between other gates.
- state
true, to activate the gate;false, otherwise- returns
true, if the gate is active;false, otherwise
- 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 AllNeighbours: Option[Set[Building]]
- Definition Classes
- Building
- def AllowBroadcastFor: Set[types.PlanetSideEmpire.Value]
Which factions interact with this warp gate as "broadcast"?
Which factions interact with this warp gate as "broadcast"?
- returns
the set of all factions who interact with this warp gate as "broadcast"
- def AllowBroadcastFor_=(bcast: Set[types.PlanetSideEmpire.Value]): Set[types.PlanetSideEmpire.Value]
Allow some factions to interact with a given warp gate as "broadcast" if it is active.
Allow some factions to interact with a given warp gate as "broadcast" if it is active.
- bcast
the factions
- returns
the set of all factions who interact with this warp gate as "broadcast"
- def AllowBroadcastFor_=(bcast: types.PlanetSideEmpire.Value): Set[types.PlanetSideEmpire.Value]
Allow a faction to interact with a given warp gate as "broadcast" if it is active.
Allow a faction to interact with a given warp gate as "broadcast" if it is active.
- bcast
the faction
- returns
the set of all factions who interact with this warp gate as "broadcast"
- def Amenities: List[Amenity]
- Definition Classes
- AmenityOwner
- def Amenities_=(obj: Amenity): List[Amenity]
- Definition Classes
- Building → AmenityOwner
- def Broadcast(faction: types.PlanetSideEmpire.Value): Boolean
Determine whether a specific faction interacts with this warp gate as "broadcast."
Determine whether a specific faction interacts with this warp gate as "broadcast."
- returns
true, if the given faction interacts with this warp gate as a "broadcast gate";false, otherwise
- def Broadcast: Boolean
Determine whether any faction interacts with this warp gate as "broadcast." The gate must be active first.
Determine whether any faction interacts with this warp gate as "broadcast." The gate must be active first. A broadcast gate allows specific factions only.
- returns
true, if some faction sees this warp gate as a "broadcast gate";false, otherwise
- def BuildingType: StructureType
- Definition Classes
- Building
- def CaptureTerminal: Option[CaptureTerminal]
- Definition Classes
- Building
- def CaptureTerminalIsHacked: Boolean
- Definition Classes
- Building
- def Continent: String
- def Continent_=(zone: String): String
Give the entity a custom
Zoneidentifier. - def Definition: WarpGateDefinition
An element of the contract of
PlanetSideServerObject; but, this makes it visible to aSpawnPointobject without casting.An element of the contract of
PlanetSideServerObject; but, this makes it visible to aSpawnPointobject without casting.- Definition Classes
- WarpGate → SpawnPoint → NtuContainer → Building → PlanetSideGameObject
- See also
PlanetSideGameObject.DefinitionSpecificPoint
- 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
- Building → FactionAffinity
- def Faction_=(fac: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
- Definition Classes
- Building → FactionAffinity
- def ForceDomeActive: Boolean
- Definition Classes
- Building
- def ForceDomeActive_=(activated: Boolean): Boolean
- Definition Classes
- Building
- 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 Generator: Option[Generator]
- Definition Classes
- Building
- def GetFlag: Option[CaptureFlag]
- Definition Classes
- Building
- def GetFlagSocket: Option[CaptureFlagSocket]
- Definition Classes
- Building
- def HackableAmenities: List[Amenity with Hackable]
- Definition Classes
- Building
- 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 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 IsCapitol: Boolean
- Definition Classes
- Building
- def IsCtfBase: Boolean
- Definition Classes
- Building
- def IsSubCapitol: Boolean
- Definition Classes
- Building
- def MapId: Int
The map_id is the identifier number used in BuildingInfoUpdateMessage.
The map_id is the identifier number used in BuildingInfoUpdateMessage. This is the index that the building appears in the MPO file starting from index 1 The GUID is the identifier number used in SetEmpireMessage / Facility hacking / PlanetSideAttributeMessage.
- Definition Classes
- Building
- def MaxNtuCapacitor: Float
- Definition Classes
- WarpGate → NtuContainer
- def Name: String
- Definition Classes
- Building
- def Neighbours(faction: types.PlanetSideEmpire.Value): Option[Set[Building]]
- Definition Classes
- Building
- def Neighbours: Option[Set[Building]]
- Definition Classes
- Building
- def NtuCapacitor: Float
- Definition Classes
- WarpGate → NtuContainer
- def NtuCapacitorScaled: Int
- Definition Classes
- NtuContainer
- def NtuCapacitor_=(value: Float): Float
- Definition Classes
- WarpGate → NtuContainer
- def NtuLevel: Int
- Definition Classes
- Building
- def NtuSource: Option[NtuContainer]
- def Orientation: Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Orientation_=(vec: Vector3): Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Owner: PlanetSideServerObject
An element of an unspoken contract with
Amenity.An element of an unspoken contract with
Amenity. While not allSpawnPointobjects will beAmenityobjects, a subclass of thePlanetSideServerObjectclass, they will all promote having an object owner, or "parent." This should generally be themselves.- Definition Classes
- WarpGate → SpawnPoint
- See also
Amenity.Owner
- def PlayerContribution: Map[Player, Long]
- Definition Classes
- Building
- def PlayersInSOI: List[Player]
- Definition Classes
- Building
- def PlayersInSOI_=(list: List[Player]): List[Player]
- Definition Classes
- Building
- def Position: Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Position_=(vec: Vector3): Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def RemoveAmenity(obj: Amenity): List[Amenity]
- Definition Classes
- AmenityOwner
- def ResetControl(): ActorRef
- Definition Classes
- PlanetSideServerObject
- def SpecificPoint(target: PlanetSideGameObject): (Vector3, Vector3)
Determine a specific position and orientation in which to spawn the target.
Determine a specific position and orientation in which to spawn the target.
- returns
a
TupleofVector3objects; the first represents the game world position of spawning; the second represents the game world direction of spawning
- Definition Classes
- SpawnPoint
- 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
- Definition Classes
- ZoneAware
- def Zone_=(zone: Zone): Zone
When assigning a new
Zoneobject for theVehicleobject, eliminate - 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()
- def connectedCavern(): Option[Building]
Starting from an overworld zone facility, find a lattice connected cavern facility that is the same faction as this starting building.
Starting from an overworld zone facility, find a lattice connected cavern facility that is the same faction as this starting building. Except for the necessary examination of the major facility on the other side of a warp gate pair, do not let the search escape the current zone into another. If we start in a cavern zone, do not continue a fruitless search; just fail.
- returns
the discovered faction-aligned cavern facility
- Definition Classes
- Building
- 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])
- def friendlyFunctionalNeighborhood(): Set[Building]
- Definition Classes
- Building
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasLatticeBenefit(wantedBenefit: LatticeBenefit): Boolean
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def infoUpdateMessage(): BuildingInfoUpdateMessage
- 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
- def isOffline: Boolean
- Definition Classes
- WarpGate → SpawnPoint
- def latticeConnectedFacilityBenefits(): Set[LatticeBenefit]
- 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
- Building → 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()