class Vehicle extends AmenityOwner with BlockMapEntity with MountableWeapons with InteractsWithZone with Hackable with FactionAffinity with Deployment with Vitality with OwnableByPlayer with StandardResistanceProfile with JammableUnit with CommonNtuContainer with Container with AuraContainer with MountableEntity
The server-side support object that represents a vehicle.
All infantry seating, all mounted weapons, and the trunk space are considered part of the same index hierarchy.
Generally, all seating is declared first - the driver and passengers and and gunners.
Following that are the mounted weapons and other utilities.
Trunk space starts being indexed afterwards.
To keep it simple, infantry seating, mounted weapons, and utilities are stored separately herein.
The Map
of Utility
objects is given using the same inventory index positions.
Positive indices and zero are considered "represented" and must be assigned a globally unique identifier
and must be present in the containing vehicle's ObjectCreateMessage
packet.
The index is the mount position, reflecting the position in the zero-index inventory.
Negative indices are expected to be excluded from this conversion.
The value of the negative index does not have a specific meaning.
The importance of a vehicle's owner can not be overlooked.
The owner is someone who can control who can sit in the vehicle's seats
either through broad categorization or discriminating selection ("kicking")
and who has access to and can allow access to the vehicle's trunk capacity.
The driver is the only player that can access a vehicle's saved loadouts through a repair/rearm silo
and can procure equipment from the said silo.
The owner of a vehicle and the driver of a vehicle as mostly interchangeable terms for this reason
and it can be summarized that the player who has access to the driver mount meets the qualifications for the "owner"
so long as that player is the last person to have sat in that mount.
All previous ownership information is replaced just as soon as someone else sits in the driver's mount.
Ownership is also transferred as players die and respawn (from and to the same client)
and when they leave a continent without taking the vehicle they currently own with them.
(They also lose ownership when they leave the game, of course.)
All seats have vehicle-level properties on top of their own internal properties.
A mount has a glyph projected onto the ground when the vehicle is not moving
that is used to mark where the mount can be accessed, as well as broadcasting the current access condition of the mount.
As indicated previously, seats are composed into categories and the categories used to control access.
The "driver" group has already been mentioned and is usually composed of a single mount, the "first" one.
The driver mount is typically locked to the person who can sit in it - the owner - unless manually unlocked.
Any mount besides the "driver" that has a weapon controlled from the mount is called a "gunner" seats.
Any other mount besides the "driver" mount and "gunner" seats is called a "passenger" mount.
All of these seats are typically unlocked normally.
The "trunk" also counts as an access group even though it is not directly attached to a mount and starts as "locked."
The categories all have their own glyphs,
sharing a red cross glyph as a "can not access" state,
and may also use their lack of visibility to express state.
In terms of individual access, each mount can have its current occupant ejected, save for the driver's mount.
- Source
- Vehicle.scala
- See also
Vehicle.EquipmentUtilities
- Alphabetic
- By Inheritance
- Vehicle
- MountableEntity
- AuraContainer
- Container
- CommonNtuContainer
- NtuContainer
- TransferContainer
- JammableUnit
- StandardResistanceProfile
- ResistanceProfile
- OwnableByPlayer
- Vitality
- InGameHistory
- Deployment
- Hackable
- InteractsWithZone
- MountableWeapons
- Mountable
- MountedWeapons
- BlockMapEntity
- AmenityOwner
- PlanetSideServerObject
- ZoneAware
- FactionAffinity
- PlanetSideGameObject
- WorldEntity
- IdentifiableEntity
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Vehicle(vehicleDef: VehicleDefinition)
- vehicleDef
the vehicle's definition entry; stores and unloads pertinent information about the
Vehicle
's configuration; used in the initialization process (loadVehicleDefinition
)
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 AccessingTrunk: Option[PlanetSideGUID]
- def AccessingTrunk_=(guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]
Change which player has access to the trunk of this vehicle.
Change which player has access to the trunk of this vehicle. A player may only gain access to the trunk if no one else has access to the trunk at the moment.
- guid
the player who wishes to access the trunk
- returns
the player who is currently allowed to access the trunk
- def AccessingTrunk_=(guid: PlanetSideGUID): Option[PlanetSideGUID]
- 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 internalActorRef
directs toActorRef.noSender
(null
).- control
the
Actor
whose functionality will govern this server object- returns
the current internal
ActorRef
- Definition Classes
- PlanetSideServerObject
- def AddEffectToAura(effect: Aura): Set[Aura]
- Definition Classes
- AuraContainer
- def Amenities: List[Amenity]
- Definition Classes
- AmenityOwner
- def Amenities_=(obj: Amenity): List[Amenity]
- Definition Classes
- AmenityOwner
- def AssignOwnership(playerOpt: Option[Player]): OwnableByPlayer
na
- def AssignOwnership(player: Player): OwnableByPlayer
na
- def Aura: Set[Aura]
- Definition Classes
- AuraContainer
- def BailProtection: Boolean
- Definition Classes
- MountableEntity
- def BailProtection_=(protect: Boolean): Boolean
- Definition Classes
- Vehicle → MountableEntity
- def CanAccessTrunk(player: Player): Boolean
Can this
player
access the contents of thisVehicle
'sTrunk
given its current access permissions?Can this
player
access the contents of thisVehicle
'sTrunk
given its current access permissions?- player
a player attempting to access this
Trunk
- returns
true
, if theplayer
is permitted access;false
, otherwise
- def CanDamage: Boolean
- Definition Classes
- Vitality
- def CanRepair: Boolean
- Definition Classes
- Vitality
- def Capacitor: Int
- def Capacitor_=(value: Int): Int
- def CargoHold(cargoNumber: Int): Option[Cargo]
- def CargoHolds: Map[Int, Cargo]
- def ClearHistory(): List[InGameActivity]
- Definition Classes
- InGameHistory
- def Cloaked: Boolean
- def Cloaked_=(isCloaked: Boolean): Boolean
- def Collisions(dest: 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 ofEquipment
being 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 ofEquipment
being stowed in aGridInventory
. Where theEquipment
object is defined by the dimensionswidth
andheight
, starting a search atindex
will 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 normalEquipmentSlot
objects. 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.)- 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
- def Continent: String
- Definition Classes
- ZoneAware
- def Continent_=(zoneId: String): String
Give the entity a custom
Zone
identifier.Give the entity a custom
Zone
identifier.- zoneId
the custom identifier of the
Zone
object- returns
the identifier of the
Zone
object
- Definition Classes
- ZoneAware
- def ControlledWeapon(wepNumber: Int): Set[Equipment]
- Definition Classes
- MountableWeapons
- def DamageModel: DamageResistanceModel
- def Decal: Int
- def Decal_=(logo: Int): Int
- def DefaultHealth: Int
- Definition Classes
- Vitality
- def Definition: VehicleDefinition
This is the definition entry that is used to store and unload pertinent information about the
Vehicle
.This is the definition entry that is used to store and unload pertinent information about the
Vehicle
.- returns
the vehicle's definition entry
- Definition Classes
- Vehicle → NtuContainer → Vitality → MountableWeapons → Mountable → MountedWeapons → PlanetSideGameObject
- def DeployTime: Int
- Definition Classes
- Vehicle → Deployment
- def DeploymentState: types.DriveState.Value
- Definition Classes
- Deployment
- def DeploymentState_=(to_deploy_state: types.DriveState.Value): types.DriveState.Value
- Definition Classes
- Deployment
- 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
- Vehicle → FactionAffinity
- def Faction_=(faction: types.PlanetSideEmpire.Value): types.PlanetSideEmpire.Value
- Definition Classes
- Vehicle → FactionAffinity
- def Find(guid: PlanetSideGUID): Option[Int]
Given globally unique identifier, if the object using it is stowed, attempt to locate its slot.
- def Find(obj: Equipment): Option[Int]
Given an object, attempt to locate its slot.
Given an object, attempt to locate its slot. All positions,
VisibleSlot
andInventory
, and wherever else, should be searchable.- obj
the
Equipment
object- returns
the index of the
EquipmentSlot
, orNone
- Definition Classes
- Container
- def Fit(obj: Equipment): Option[Int]
- def Fit(tile: InventoryTile): Option[Int]
- Definition Classes
- Container
- def Flying: Option[Int]
- def Flying_=(isFlying: Option[Int]): Option[Int]
- def Flying_=(isFlying: Int): Option[Int]
- def GUID: PlanetSideGUID
- Definition Classes
- IdentifiableEntity → Identifiable
- def GUID_=(guid: PlanetSideGUID): PlanetSideGUID
- Definition Classes
- IdentifiableEntity → Identifiable
- def GUID_=(guid: StalePlanetSideGUID): PlanetSideGUID
Always intercept
StalePlanetSideGUID
references when attempting to mutate the GUID value.Always intercept
StalePlanetSideGUID
references 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 HackDuration: Array[Int]
- Definition Classes
- Hackable
- def HackDuration_=(arr: Array[Int]): Array[Int]
- Definition Classes
- Hackable
- def HackEffectDuration: Array[Int]
- Definition Classes
- Hackable
- def HackEffectDuration_=(arr: Array[Int]): Array[Int]
- Definition Classes
- Hackable
- def HackSound: packet.game.TriggeredSound.Value
- Definition Classes
- Hackable
- def HackSound_=(sound: packet.game.TriggeredSound.Value): packet.game.TriggeredSound.Value
- Definition Classes
- Hackable
- def HackedBy: Option[HackInfo]
- Definition Classes
- Hackable
- def HackedBy_=(hackInfo: HackInfo): Option[HackInfo]
- Definition Classes
- Hackable
- def HackedBy_=(agent: Option[Player]): Option[HackInfo]
Set the hack state of this object by recording important information about the player who caused it.
Set the hack state of this object by recording important information about the player who caused it. Set the hack state if there is no current hack state. Override the hack state with a new hack state if the new user has different faction affiliation.
- agent
a
Player
, or no player- returns
the player hack entry
- Definition Classes
- Hackable
- def HackedBy_=(agent: Player): Option[HackInfo]
- Definition Classes
- Hackable
- 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
- 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
StalePlanetSideGUID
entity 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
GridInventory
returned by this accessor is also an implementation ofContainer
. - def JackingDuration: Array[Int]
How long it takes to jack the vehicle in seconds, based on the hacker's certification level
- 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 LoadDefinition(): Unit
Override this method to perform any special setup that is not standardized to
*Definition
.Override this method to perform any special setup that is not standardized to
*Definition
.- Attributes
- protected
- See also
Vehicle.LoadDefinition
- def LogActivity(result: DamageResult): List[InGameActivity]
Very common example of a
VitalsActivity
event involving damage.Very common example of a
VitalsActivity
event 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 MaxNtuCapacitor: Float
- Definition Classes
- Vehicle → NtuContainer
- def MaxShields: Int
- 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 MountedIn: Option[PlanetSideGUID]
- Definition Classes
- MountableEntity
- def MountedIn_=(cargo_guid: Option[PlanetSideGUID]): Option[PlanetSideGUID]
- Definition Classes
- MountableEntity
- def MountedIn_=(cargo_guid: PlanetSideGUID): Option[PlanetSideGUID]
- Definition Classes
- MountableEntity
- def NtuCapacitor: Float
- Definition Classes
- CommonNtuContainer → NtuContainer
- def NtuCapacitorScaled: Int
- Definition Classes
- NtuContainer
- def NtuCapacitor_=(value: Float): Float
- Definition Classes
- CommonNtuContainer → NtuContainer
- def Orientation: Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Orientation_=(vec: Vector3): Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def OriginalOwnerName: Option[String]
- Definition Classes
- OwnableByPlayer
- def Owner: Option[PlanetSideGUID]
- Definition Classes
- OwnableByPlayer
- def OwnerName: Option[String]
- Definition Classes
- OwnableByPlayer
- def OwnerName_=(owner: Option[String]): Option[String]
- Definition Classes
- OwnableByPlayer
- def OwnerName_=(owner: Player): Option[String]
- Definition Classes
- OwnableByPlayer
- def OwnerName_=(owner: String): Option[String]
- Definition Classes
- OwnableByPlayer
- def Owner_=(owner: Option[PlanetSideGUID]): Option[PlanetSideGUID]
- Definition Classes
- OwnableByPlayer
- def Owner_=(owner: Player): Option[PlanetSideGUID]
- Definition Classes
- OwnableByPlayer
- def Owner_=(owner: PlanetSideGUID): Option[PlanetSideGUID]
- Definition Classes
- OwnableByPlayer
- 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 PermissionGroup(group: Int, level: Long): Option[vehicles.VehicleLockState.Value]
Change the access permissions for a position on this vehicle, seats or trunk.
Change the access permissions for a position on this vehicle, seats or trunk.
- group
the group index
- level
the new permission for this group
- returns
the new access permission for this group;
None
, if the group does not exist or the level of permission was not changed
- def PermissionGroup(group: Int): Option[vehicles.VehicleLockState.Value]
What are the access permissions for a position on this vehicle, seats or trunk?
What are the access permissions for a position on this vehicle, seats or trunk?
- group
the group index
- returns
what sort of access permission exist for this group
- def Position: Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def Position_=(vec: Vector3): Vector3
- Definition Classes
- PlanetSideGameObject → WorldEntity
- def PrepareGatingManifest(): VehicleManifest
- def PreviousGatingManifest(): Option[VehicleManifest]
- def PublishGatingManifest(): Option[VehicleManifest]
- def RadiationShielding: Float
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def RemoveAmenity(obj: Amenity): List[Amenity]
- Definition Classes
- AmenityOwner
- def RemoveEffectFromAura(effect: Aura): Set[Aura]
- Definition Classes
- AuraContainer
- 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
Seat
object.Given a mount's index position, retrieve the internal
Seat
object.- returns
the specific mount
- Definition Classes
- Mountable
- def SeatPermissionGroup(seatNumber: Int): Option[vehicles.AccessPermissionGroup.Value]
- 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 Shields: Int
- def Shields_=(strength: Int): Int
- def Slot(slotNum: Int): EquipmentSlot
Access to all stowable positions on this object by index.
All positions,VisibleSlot
andInventory
, and wherever else, should be reachable.Access to all stowable positions on this object by index.
All positions,VisibleSlot
andInventory
, 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,EquipmentSlot
objects. By default, it is expected to return anEquipmentSlot
that can not be manipulated because it isBlocked
.- slotNum
an index
- returns
the searchable position identified by that index
- def SlotMapResolution(slot: Int): Int
When the slot reported is not the slot requested, change the slot.
- def SubsystemMessages(): List[PlanetSideGamePacket]
- def SubsystemStatus(sys: String): Option[Boolean]
- def SubsystemStatusMultiplier(sys: String): Float
- def Subsystems(sys: String): Option[VehicleSubsystem]
- def Subsystems(sys: VehicleSubsystemEntry): Option[VehicleSubsystem]
- def Subsystems(): List[VehicleSubsystem]
- def Subtract: DamageProfile
- Definition Classes
- StandardResistanceProfile → ResistanceProfile
- def Trunk: GridInventory
A reference to the
Vehicle
Trunk
space.A reference to the
Vehicle
Trunk
space.- returns
this
Vehicle
Trunk
- def TrunkLocation: Vector3
Trunk locations are stored as the orientation zero point being to the East.
Trunk locations are stored as the orientation zero point being to the East. We need to convert that to a North = 0 orientation before returning the location
- returns
A Vector3 of the current trunk location, orientated with North as the zero point
- def TrunkLockState: vehicles.VehicleLockState.Value
Check access to the
Trunk
.Check access to the
Trunk
.- returns
the current access value for the
Vehicle
Trunk
- def UndeployTime: Int
- Definition Classes
- Vehicle → Deployment
- def Utilities: Map[Int, Utility]
- def Utility(utilType: vehicles.UtilityType.Value): Option[PlanetSideServerObject]
- def Utility(utilNumber: Int): Option[PlanetSideServerObject]
Get a reference to a certain
Utility
attached to thisVehicle
.Get a reference to a certain
Utility
attached to thisVehicle
.- utilNumber
the attachment number of the
Utility
- returns
the
Utility
orNone
(if invalid)
- 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
- 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
None
if 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
- Definition Classes
- ZoneAware
- def Zone_=(zone: Zone): Zone
When assigning a new
Zone
object for theVehicle
object, eliminateWhen assigning a new
Zone
object for theVehicle
object, eliminate- zone
a reference to the
Zone
object- returns
a reference to the
Zone
object
- Definition Classes
- ZoneAware
- def allowInteraction: Boolean
If the interactive permissions of this entity change.
If the interactive permissions of this entity change.
- Definition Classes
- InteractsWithZone
- def allowInteraction_=(permit: Boolean): Boolean
If the interactive permissions of this entity change, trigger a formal change to the interaction methodology.
If the interactive permissions of this entity change, trigger a formal change to the interaction methodology.
- permit
whether or not interaction is permitted
- returns
whether or not interaction is permitted
- Definition Classes
- InteractsWithZone
- 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 canEqual(other: Any): Boolean
- 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
- def doInteractions(): Unit
- Definition Classes
- InteractsWithZone
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Any): Boolean
- Definition Classes
- Vehicle → 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 getInteractionSector(): SectorPopulation
- Definition Classes
- InteractsWithZone
- def hashCode(): Int
- Definition Classes
- Vehicle → AnyRef → Any
- def interaction(): List[ZoneInteraction]
- Definition Classes
- InteractsWithZone
- def interaction(func: ZoneInteraction): List[ZoneInteraction]
- Definition Classes
- InteractsWithZone
- def isFlying: Boolean
- 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()
- def resetInteractions(): Unit
- Definition Classes
- InteractsWithZone
- 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
Override the string representation to provide additional information.
Override the string representation to provide additional information.
- returns
the string output
- Definition Classes
- Vehicle → 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
- def zoneInteractions(): Unit
- Definition Classes
- InteractsWithZone