class FacilityTurret extends Amenity with WeaponTurret with JammableUnit with CaptureTerminalAware
- Source
- FacilityTurret.scala
- Alphabetic
- By Inheritance
- FacilityTurret
- CaptureTerminalAware
- JammableUnit
- WeaponTurret
- Container
- MountableWeapons
- Mountable
- MountedWeapons
- Amenity
- BlockMapEntity
- StandardResistanceProfile
- ResistanceProfile
- Vitality
- InGameHistory
- PlanetSideServerObject
- ZoneAware
- FactionAffinity
- PlanetSideGameObject
- WorldEntity
- IdentifiableEntity
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new FacilityTurret(tDef: FacilityTurretDefinition)
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 Collisions(index: Int, width: Int, height: Int): Try[List[InventoryItem]]
Given a region of "searchable unit positions" considered as stowable, determine if any previously stowed items are contained within that region.
Default usage, and recommended the continued inclusion of that use, is defined in terms ofEquipmentbeing stowed in aGridInventory.Given a region of "searchable unit positions" considered as stowable, determine if any previously stowed items are contained within that region.
Default usage, and recommended the continued inclusion of that use, is defined in terms ofEquipmentbeing stowed in aGridInventory. Where theEquipmentobject is defined by the dimensionswidthandheight, starting a search atindexwill search all positions within a grid-like range of numbers. Under certain searching conditions, this range may be meaningless, such as is the case when searching individual positions that are normalEquipmentSlotobjects. Regardless, the value collected indicates the potential of multiple objects being discovered and maintains a reference to the object itself and the slot position where the object is located. (As any object can be discovered within the range, that is important.)- index
the position to start searching
- width
the width of the searchable space
- height
the height of the serachable space
- returns
a list of objects that have been encountered within the searchable space
- Definition Classes
- Container
- See also
GridInventory.CheckCollisionsVar
- def ConfirmUpgrade(upgrade: TurretUpgrade.Value): TurretUpgrade.Value
- Definition Classes
- WeaponTurret
- 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 ControlledWeapon(wepNumber: Int): Set[Equipment]
- Definition Classes
- MountableWeapons
- def DamageModel: DamageAndResistance
- def DefaultHealth: Int
- Definition Classes
- Vitality
- def Definition: FacilityTurretDefinition
- Definition Classes
- FacilityTurret → WeaponTurret → MountableWeapons → Mountable → MountedWeapons → 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 Find(guid: PlanetSideGUID): Option[Int]
Given globally unique identifier, if the object using it is stowed, attempt to locate its slot.
Given globally unique identifier, if the object using it is stowed, attempt to locate its slot. All positions,
VisibleSlotandInventory, and wherever else, should be searchable.- guid
the GUID of the
Equipment- returns
the index of the
EquipmentSlot, orNone
- Definition Classes
- Container
- def Find(obj: Equipment): Option[Int]
Given an object, attempt to locate its slot.
Given an object, attempt to locate its slot. All positions,
VisibleSlotandInventory, and wherever else, should be searchable.- obj
the
Equipmentobject- returns
the index of the
EquipmentSlot, orNone
- Definition Classes
- Container
- def Fit(tile: InventoryTile): Option[Int]
- Definition Classes
- Container
- def Fit(obj: Equipment): Option[Int]
- Definition Classes
- Container
- 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 GetSeatFromMountPoint(mountPoint: Int): Option[Int]
Given a mount point index, return the associated mount index.
Given a mount point index, return the associated mount index.
- mountPoint
the mount point
- returns
the mount index
- Definition Classes
- Mountable
- 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 Inventory: GridInventory
A(n imperfect) reference to a generalized pool of the contained objects.
A(n imperfect) reference to a generalized pool of the contained objects. Having access to all of the available positions is not required. The entries in this reference should definitely include all unseen positions. The
GridInventoryreturned by this accessor is also an implementation ofContainer.- Definition Classes
- WeaponTurret → Container
- See also
VisibleSlots
- def Jammed: Boolean
- Definition Classes
- JammableUnit
- def Jammed_=(state: Boolean): Boolean
- Definition Classes
- JammableUnit
- 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 MountPoints: Map[Int, MountInfo]
Retrieve a mapping of each mount from its mount point index.
Retrieve a mapping of each mount from its mount point index.
- returns
the mapping of mount point to mount
- Definition Classes
- Mountable
- 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 PassengerInSeat(user: Player): Option[Int]
Given a player, determine if that player is seated.
Given a player, determine if that player is seated.
- user
the player
- returns
the mount index
- Definition Classes
- Mountable
- 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 Seat(seatNumber: Int): Option[Seat]
Given a mount's index position, retrieve the internal
Seatobject.Given a mount's index position, retrieve the internal
Seatobject.- returns
the specific mount
- Definition Classes
- Mountable
- def Seats: Map[Int, Seat]
Retrieve a mapping of each mount from its internal index.
Retrieve a mapping of each mount from its internal index.
- returns
the mapping of index to mount
- Definition Classes
- Mountable
- def Slot(slotNum: Int): EquipmentSlot
Access to all stowable positions on this object by index.
All positions,VisibleSlotandInventory, and wherever else, should be reachable.Access to all stowable positions on this object by index.
All positions,VisibleSlotandInventory, and wherever else, should be reachable. Regardless of the internal storage medium, the format of return is expected to be the same structure of object as the most basic storage component forEquipment, namely,EquipmentSlotobjects. By default, it is expected to return anEquipmentSlotthat can not be manipulated because it isBlocked.- slotNum
an index
- returns
the searchable position identified by that index
- Definition Classes
- Container
- See also
OffhandEquipmentSlot
- def SlotMapResolution(slot: Int): Int
When the slot reported is not the slot requested, change the slot.
When the slot reported is not the slot requested, change the slot.
- slot
the original slot index
- returns
the modified slot index
- Definition Classes
- Container
- def Subtract: DamageProfile
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def Upgrade: TurretUpgrade.Value
- Definition Classes
- WeaponTurret
- def Upgrade_=(upgrade: TurretUpgrade.Value): TurretUpgrade.Value
- Definition Classes
- WeaponTurret
- 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 VisibleSlots: Set[Int]
A(n imperfect) reference to a generalized pool of the contained objects.
Having access to all of the available positions is not required.A(n imperfect) reference to a generalized pool of the contained objects.
Having access to all of the available positions is not required. Only the positions that can be actively viewed by other clients are listed.- returns
all of the affected slot indices
- Definition Classes
- WeaponTurret → Container
- See also
Inventory
- 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 WeaponControlledFromSeat(seatNumber: Int): Set[Equipment]
Given a valid mount number, retrieve an index where the weapon controlled from this mount is mounted.
Given a valid mount number, retrieve an index where the weapon controlled from this mount is mounted.
- seatNumber
the mount number
- returns
a mounted weapon by index, or
Noneif either the mount doesn't exist or there is no controlled weapon
- Definition Classes
- MountableWeapons
- def Weapons: Map[Int, EquipmentSlot]
- Definition Classes
- MountedWeapons
- 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()
- def controlledWeapon(wepNumber: Int): Set[Equipment]
- Definition Classes
- MountableWeapons
- 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()
- val inventory: GridInventory
may or may not have inaccessible inventory space see
ReserveAmmunitionin the definitionmay or may not have inaccessible inventory space see
ReserveAmmunitionin the definition- Attributes
- protected
- Definition Classes
- WeaponTurret
- 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 isUpgrading: Boolean
- Definition Classes
- WeaponTurret
- 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()
- val seats: Map[Int, Seat]
- Attributes
- protected
- Definition Classes
- Mountable
- 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()
- val weapons: Map[Int, EquipmentSlot]
- Attributes
- protected
- Definition Classes
- MountedWeapons