class VehicleControl extends Actor with Check with DeploymentBehavior with Mount with Dismount with CargoBehavior with DamageableVehicle with RepairableVehicle with JammableMountedWeapons with ContainableBehavior with AntTransferBehavior
An Actor that handles messages being dispatched to a specific Vehicle.
Vehicle-controlling actors have two behavioral states - responsive and "Disabled."
The latter is applicable only when the specific vehicle is being deconstructed.
- Source
- VehicleControl.scala
- Alphabetic
- By Inheritance
- VehicleControl
- AntTransferBehavior
- NtuStorageBehavior
- TransferBehavior
- ContainableBehavior
- JammableMountedWeapons
- JammableBehavior
- RepairableVehicle
- RepairableEntity
- Repairable
- DamageableVehicle
- DamageableEntity
- Damageable
- CargoBehavior
- Dismount
- Mount
- DeploymentBehavior
- Check
- BasicAffinity
- Actor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
Type Members
- type Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
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 ActivatePanelsForChargingEvent(vehicle: NtuContainer): Unit
- Definition Classes
- AntTransferBehavior
- def CanBeRepairedByNanoDispenser(player: Player, item: Tool): Unit
Catch the expected repair message and apply further checks to the combination of the target, the equipment, and tis user.
Catch the expected repair message and apply further checks to the combination of the target, the equipment, and tis user. If the checks pass, perform the repair.
- player
the user of the nano dispenser tool
- item
the nano dispenser tool
- Definition Classes
- RepairableEntity → Repairable
- def CanPerformRepairs(target: Target, player: Player, item: Tool): Boolean
Test the combination of target entity, equipment user, and the equipment to determine if the repair process attempt would be permitted.
Test the combination of target entity, equipment user, and the equipment to determine if the repair process attempt would be permitted. It is not necessary to check that the tool and its ammunition are correct types; that test was already performed.
The target entity must be repairable and have less than full health and, if it is destroyed, must have an object attribute that permits it to be repaired after being destroyed.
The user must have the same faction affinity as the target entity or be neutral.
The equipment must have some ammunition.
The user must be alive and be within a certain distance of the target entity.- target
the entity being repaired
- player
the user of the nano dispenser tool
- item
the nano dispenser tool
- returns
true, if the target entity can be repaired;false, otherwise
- Attributes
- protected
- Definition Classes
- RepairableEntity
- See also
org.log4s.getLoggerPlanetSideEmpireVector3.DistanceVitalityDefinition
- def CancelJammeredSound(target: Any): Unit
Deactivate a distinctive buzzing sound effect.
Deactivate a distinctive buzzing sound effect. Due to considerations of the object that is the target, this is left to be implemented by a subclass. We merely stop the timer.
- target
an object that can be affected by the jammered status
- Definition Classes
- JammableMountedWeapons → JammableBehavior
- def CancelJammeredStatus(target: Any): Unit
Deactivate the effects of the jammered status.
Deactivate the effects of the jammered status. Due to considerations of the object that is the target, this is left to be implemented by a subclass. We merely stop the timer.
- target
an object that can be affected by the jammered status
- Definition Classes
- JammableMountedWeapons → JammableBehavior
- def CargoObject: Vehicle
- Definition Classes
- VehicleControl → CargoBehavior
- def ChargeTransferObject: Vehicle
- Definition Classes
- VehicleControl → AntTransferBehavior → TransferBehavior
- def ContainerObject: Vehicle
- Definition Classes
- VehicleControl → ContainableBehavior
- def DamageAwareness(target: Target, cause: ResolvedProjectile, amount: Int): Unit
What happens when damage is sustained but the target does not get destroyed.
What happens when damage is sustained but the target does not get destroyed.
- target
the entity being damaged
- cause
historical information about the damage
- amount
the amount of damage
- Attributes
- protected
- Definition Classes
- DamageableVehicle → DamageableEntity
- def DamageLog(target: Target, msg: String): Unit
Log a damage message with a decorator for this target.
Log a damage message with a decorator for this target. The decorator is constructed by the
Actorname of the entity, sliced after the last forward/slash. For example, for "foo/bar/name", the decorator is just "name".- target
the entity to be used for the decorator
- msg
the message for the damage log
- Attributes
- protected
- Definition Classes
- DamageableEntity
- See also
PlanetSideServerObject
- def DamageLog(msg: String): Unit
Log a damage message.
Log a damage message.
- msg
the message for the damage log
- Attributes
- protected
- Definition Classes
- DamageableEntity
- def DamageableObject: Vehicle
Contextual access to the object being the target of this damage.
Contextual access to the object being the target of this damage. Needs declaration in lowest implementing code.
- returns
the entity controlled by this actor
- Definition Classes
- VehicleControl → DamageableVehicle → Damageable
- def DeploymentAction(obj: DeploymentObject, state: types.DriveState.Value, prevState: types.DriveState.Value): types.DriveState.Value
- Definition Classes
- VehicleControl → DeploymentBehavior
- def DeploymentObject: Vehicle
- Definition Classes
- VehicleControl → DeploymentBehavior
- def DestructionAwareness(target: Target, cause: ResolvedProjectile): Unit
What happens when the target sustains too much damage and is destroyed.
What happens when the target sustains too much damage and is destroyed.
- target
the entity being destroyed
- cause
historical information about the damage
- Attributes
- protected
- Definition Classes
- DamageableVehicle → DamageableEntity
- See also
Damageable.DestructionAwareness
- def Disabled: Receive
- def Enabled: Receive
- def FactionObject: Vehicle
- Definition Classes
- VehicleControl → BasicAffinity
- def GainOwnership(player: Player): Unit
- def HandleChargingEvent(target: TransferContainer): Boolean
- Definition Classes
- AntTransferBehavior → TransferBehavior
- def HandleDamage(target: Target, cause: ResolvedProjectile, damage: Int): Unit
Select between mere damage reception or target destruction.
Select between mere damage reception or target destruction.
- target
the entity being damaged
- cause
historical information about the damage
- damage
the amount of damage
- Attributes
- protected
- Definition Classes
- DamageableEntity
- See also
VitalDefinition.DamageDestroysAt
- def HandleDischargingEvent(target: TransferContainer): Boolean
Discharging
Discharging
- Definition Classes
- AntTransferBehavior → TransferBehavior
- def HandleNtuGrant(sender: ActorRef, src: NtuContainer, amount: Int): Unit
- Definition Classes
- AntTransferBehavior → NtuStorageBehavior
- def HandleNtuOffer(sender: ActorRef, src: NtuContainer): Unit
- Definition Classes
- AntTransferBehavior → NtuStorageBehavior
- def HandleNtuRequest(sender: ActorRef, min: Int, max: Int): Unit
- Definition Classes
- AntTransferBehavior → NtuStorageBehavior
- def InitialCharge(): Unit
- Definition Classes
- AntTransferBehavior
- def InitialDischarge(): Unit
- Definition Classes
- AntTransferBehavior
- def JammableObject: Vehicle
ZoneAwareis used for callback to the event systemsZoneAwareis used for callback to the event systems- Definition Classes
- VehicleControl → JammableBehavior
- def LoseOwnership(): Unit
- def MessageDeferredCallback(msg: Any): Unit
Reaction to the initial deferrence of a message that should handle the visual aspects of not immediately addressing the message.
Reaction to the initial deferrence of a message that should handle the visual aspects of not immediately addressing the message. To be implemented.
- msg
the deferred message
- Definition Classes
- VehicleControl → ContainableBehavior
- def MountTest(obj: PlanetSideServerObject with Mountable, seatNumber: Int, player: Player): Boolean
- Attributes
- protected
- Definition Classes
- Mount
- def MountableObject: Vehicle
- Definition Classes
- VehicleControl → Dismount → Mount
- def NoCharge(): Unit
- Definition Classes
- AntTransferBehavior
- def NtuStorageObject: NtuContainer
- Definition Classes
- NtuStorageBehavior
- def PerformDamage(target: Target, applyDamageTo: Output): Unit
Vehicles may have charged shields that absorb damage before the vehicle's own health is affected.
Vehicles may have charged shields that absorb damage before the vehicle's own health is affected.
- target
the entity to be damaged
- applyDamageTo
the function that applies the damage to the target in a target-tailored fashion
- Attributes
- protected
- Definition Classes
- DamageableVehicle → DamageableEntity
- def PerformRepairs(target: Target, player: Player, item: Tool): Unit
Calculate the health points change and enact that repair action if the targets are stationary.
Calculate the health points change and enact that repair action if the targets are stationary. Restore the target entity to a not destroyed state if applicable. Always show the repair progress bar window by using the appropriate packet.
- target
the entity being repaired
- player
the user of the nano dispenser tool
- item
the nano dispenser tool
- Attributes
- protected
- Definition Classes
- RepairableEntity
- See also
AvatarAction.PlanetsideAttributeToAllAvatarAction.SendResponseAvatarServiceInventoryStateMessagePlanetSideGameObject.isMovingRepairMessageService.defaultPlayerGUIDTool.DischargeZone.AvatarEvents
- def PrepareForDeletion(): Unit
- def PutItemInSlotCallback(item: Equipment, slot: Int): Unit
Reaction to an item being placed into a container.
Reaction to an item being placed into a container. To be implemented.
- item
the item that was removed
- slot
the slot from which is was removed
- Definition Classes
- VehicleControl → ContainableBehavior
- def ReceiveAndDepositUntilFull(vehicle: Vehicle, amount: Int): Boolean
- Definition Classes
- AntTransferBehavior
- def RemoveItemFromSlotCallback(item: Equipment, slot: Int): Unit
Reaction to an item being removed a container.
Reaction to an item being removed a container. To be implemented.
- item
the item that was removed
- slot
the slot from which is was removed
- Definition Classes
- VehicleControl → ContainableBehavior
- def RepairValue(item: Tool): Int
The amount of repair that any specific tool provides.
The amount of repair that any specific tool provides.
- item
the tool in question
- returns
an amount to add to the repair attempt progress
- Definition Classes
- RepairableEntity → Repairable
- See also
Repairable.Quality
- def RepairableObject: Vehicle
Contextual access to the object being the target of this damage.
Contextual access to the object being the target of this damage. Needs declaration in lowest implementing code.
- returns
the entity controlled by this actor
- Definition Classes
- VehicleControl → Repairable
- def RepeatMessageLater(msg: Any): Unit
Defer a message until later.
Defer a message until later.
- msg
the message to defer
- Definition Classes
- ContainableBehavior
- See also
ContainableBehavior.DeferDeferrableMsg
- def Reset(): Unit
Stop blocking messages.
Stop blocking messages.
- Definition Classes
- ContainableBehavior
- def Restoration(obj: Target): Unit
The entity is no longer destroyed.
- def Resume(): Unit
Decrement the flag for blocking messages.
Decrement the flag for blocking messages.
- Definition Classes
- ContainableBehavior
- def StartJammeredSound(target: Any, dur: Int): Unit
Activate a distinctive buzzing sound effect.
Activate a distinctive buzzing sound effect. Due to considerations of the object that is the target, this is left to be implemented by a subclass. We merely start the timer.
- target
an object that can be affected by the jammered status
- dur
the duration of the timer, in milliseconds; by default, 30000
- Definition Classes
- JammableMountedWeapons → JammableBehavior
- def StartJammeredStatus(target: Any, dur: Int): Unit
Deactivate the effects of the jammered status.
Deactivate the effects of the jammered status. Due to considerations of the object that is the target, this is left to be implemented by a subclass. We merely stop the timer.
- target
an object that can be affected by the jammered status
- dur
the duration of the timer, in milliseconds
- Definition Classes
- JammableMountedWeapons → JammableBehavior
- def StartNtuChargingEvent(vehicle: NtuContainer): Unit
Charging
Charging
- Definition Classes
- AntTransferBehavior
- def StopNtuBehavior(sender: ActorRef): Unit
- Definition Classes
- AntTransferBehavior → NtuStorageBehavior
- def SwapItemCallback(item: Equipment, fromSlot: Int): Unit
Reaction to the existence of a swap item being produced from a container into the environment.
Reaction to the existence of a swap item being produced from a container into the environment. To be implemented.
- item
the item that was removed
- fromSlot
the slot from where the item was removed (where it previous was)
- Definition Classes
- VehicleControl → ContainableBehavior
- def TakesDamage: akka.actor.Actor.Receive
Catch the expected damage message and apply checks to the target.
Catch the expected damage message and apply checks to the target. If adding custom message handling in an future child implementation, override this method and call
super.TakesDamage.orElse { ... }.- Attributes
- protected
- Definition Classes
- DamageableVehicle → DamageableEntity → Damageable
- See also
Damageable.TakesDamageResolutionCalcultions.OutputVitality.CanDamageVitality.Damage
- def TransferMaterial: Nanites
- Definition Classes
- AntTransferBehavior → TransferBehavior
- def TryChargingActivity(): Unit
- Definition Classes
- TransferBehavior
- def TryDeployStateChange(state: types.DriveState.Value): Any
- Definition Classes
- DeploymentBehavior
- def TryDeploymentChange(obj: DeploymentObject, state: types.DriveState.Value): Boolean
- Definition Classes
- VehicleControl → DeploymentBehavior
- def TryDeploymentStateChange(state: types.DriveState.Value): Any
- Definition Classes
- DeploymentBehavior
- def TryDischargingActivity(): Unit
- Definition Classes
- TransferBehavior
- def TryJammerEffectActivate(target: Any, cause: ResolvedProjectile): Unit
If the target can be validated against, affect it with the jammered status.
If the target can be validated against, affect it with the jammered status.
- target
the objects to be determined if affected by the source's jammering
- cause
the source of the "jammered" status
- Definition Classes
- VehicleControl → JammableBehavior
- def TryStopChargingEvent(container: TransferContainer): Unit
Stopping
Stopping
- Definition Classes
- AntTransferBehavior → TransferBehavior
- def TryUndeployStateChange(state: types.DriveState.Value): Any
- Definition Classes
- DeploymentBehavior
- def TryUndeploymentChange(obj: DeploymentObject, state: types.DriveState.Value): Boolean
- Definition Classes
- DeploymentBehavior
- def UndeploymentAction(obj: DeploymentObject, state: types.DriveState.Value, prevState: types.DriveState.Value): types.DriveState.Value
- Definition Classes
- VehicleControl → DeploymentBehavior
- def UpdateNtuUI(vehicle: Vehicle with NtuContainer): Unit
- Definition Classes
- AntTransferBehavior
- def Wait(): Unit
Increment the flag for blocking messages.
Increment the flag for blocking messages.
- Definition Classes
- ContainableBehavior
- def WillAffectTarget(target: Target, damage: Int, cause: ResolvedProjectile): Boolean
Does the damage or the projectile that caused the damage offer any reason to execute the reminder of damage resolution considerations? The projectile causing additional affects, e.g., jamming, should be tested here, when applicable.
Does the damage or the projectile that caused the damage offer any reason to execute the reminder of damage resolution considerations? The projectile causing additional affects, e.g., jamming, should be tested here, when applicable. Contrast with
Vitality.CanDamage. The damage value tested against should be the total value of all meaningful vital statistics affected.- target
the entity to be damaged
- damage
the amount of damage
- cause
historical information about the damage
- returns
true, if damage resolution is to be evaluated;false, otherwise
- Attributes
- protected
- Definition Classes
- DamageableEntity
- See also
Damageable.CanDamageOrJammerPerformDamage
- def WithdrawAndTransmit(vehicle: Vehicle, maxRequested: Int): Any
- Definition Classes
- AntTransferBehavior
- def antBehavior: Receive
- Definition Classes
- AntTransferBehavior
- def aroundPostRestart(reason: Throwable): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPostStop(): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPreStart(): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit
- Attributes
- protected[akka]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final val canBeRepairedByNanoDispenser: akka.actor.Actor.Receive
The official mixin hook;
orElseonto the "control"Actorreceive; catch the expected repair message and apply initial checks to the itemThe official mixin hook;
orElseonto the "control"Actorreceive; catch the expected repair message and apply initial checks to the item- Definition Classes
- Repairable
- See also
AmmoCanBeRepairedByNanoDispenserCommonMessages.UseGlobalDefinitionsTool.AmmoType
- val cargoBehavior: Receive
- Definition Classes
- CargoBehavior
- val checkBehavior: Receive
- Definition Classes
- Check
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final val containerBehavior: Receive
- Definition Classes
- ContainableBehavior
- implicit val context: ActorContext
- Definition Classes
- Actor
- var decayTimer: Cancellable
primary vehicle decay timer
- var decaying: Boolean
cheap flag for whether the vehicle is decaying
- val deployBehavior: Receive
- Definition Classes
- DeploymentBehavior
- val dismountBehavior: Receive
- Definition Classes
- Dismount
- 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])
- val findChargeTargetFunc: (TransferContainer, Option[TransferContainer]) => Option[TransferContainer]
- Definition Classes
- TransferBehavior
- val findDischargeTargetFunc: (TransferContainer, Option[TransferContainer]) => Option[TransferContainer]
- Definition Classes
- TransferBehavior
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jammableBehavior: Receive
- Definition Classes
- JammableBehavior
- val jammedSound: Boolean
flag for jammed sound
flag for jammed sound
- Attributes
- protected
- Definition Classes
- JammableBehavior
- val jammeredSoundTimer: Cancellable
the sound timer
the sound timer
- Attributes
- protected
- Definition Classes
- JammableBehavior
- val jammeredStatusTimer: Cancellable
the effect timer
the effect timer
- Attributes
- protected
- Definition Classes
- JammableBehavior
- val mountBehavior: Receive
- Definition Classes
- Mount
- 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 ntuChargingTick: Cancellable
- Definition Classes
- AntTransferBehavior
- val panelAnimationFunc: () => Unit
- Definition Classes
- AntTransferBehavior
- def postRestart(reason: Throwable): Unit
- Definition Classes
- Actor
- Annotations
- @throws(classOf[java.lang.Exception])
- def postStop(): Unit
- Definition Classes
- VehicleControl → Actor
- def preRestart(reason: Throwable, message: Option[Any]): Unit
- Definition Classes
- Actor
- Annotations
- @throws(classOf[java.lang.Exception])
- def preStart(): Unit
- Definition Classes
- Actor
- Annotations
- @throws(classOf[java.lang.Exception])
- def receive: Receive
- Definition Classes
- VehicleControl → Actor
- implicit final val self: ActorRef
- Definition Classes
- Actor
- final def sender(): ActorRef
- Definition Classes
- Actor
- def storageBehavior: Receive
- Definition Classes
- NtuStorageBehavior
- def supervisorStrategy: SupervisorStrategy
- Definition Classes
- Actor
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final val takesDamage: akka.actor.Actor.Receive
the official mixin hook;
orElseonto the "control"Actorreceivethe official mixin hook;
orElseonto the "control"Actorreceive- Definition Classes
- Damageable
- def toString(): String
- Definition Classes
- AnyRef → Any
- val transferBehavior: Receive
- Definition Classes
- TransferBehavior
- val transferEvent: serverobject.transfer.TransferBehavior.Event.Value
- Definition Classes
- TransferBehavior
- val transferTarget: Option[TransferContainer]
- Definition Classes
- TransferBehavior
- val tryMountBehavior: Receive
- def unhandled(message: Any): Unit
- Definition Classes
- Actor
- 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()