Packages

class FacilityTurretControl extends PoweredAmenityControl with Check with MountableBehavior with DamageableWeaponTurret with RepairableWeaponTurret with AmenityAutoRepair with JammableMountedWeapons with CaptureTerminalAwareBehavior

An Actor that handles messages being dispatched to a specific MannedTurret.

Mounted turrets have only slightly different entry requirements than a normal vehicle because they encompass both faction-specific facility turrets and faction-blind cavern sentry turrets.

Source
FacilityTurretControl.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FacilityTurretControl
  2. CaptureTerminalAwareBehavior
  3. JammableMountedWeapons
  4. JammableBehavior
  5. AmenityAutoRepair
  6. NtuStorageBehavior
  7. RepairableWeaponTurret
  8. RepairableEntity
  9. Repairable
  10. DamageableWeaponTurret
  11. AggravatedBehavior
  12. DamageableEntity
  13. Damageable
  14. MountableBehavior
  15. Check
  16. BasicAffinity
  17. PoweredAmenityControl
  18. Actor
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FacilityTurretControl(turret: FacilityTurret)

    turret

    the MannedTurret object being governed

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def AggravatedObject: Target with WeaponTurret
  5. def AggravatedReaction: Boolean
    Definition Classes
    AggravatedBehavior
  6. def AggravationCleanup(id: Long): Unit
    Definition Classes
    AggravatedBehavior
  7. def AutoRepairObject: FacilityTurret
  8. 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
    RepairableEntityRepairable
  9. 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.getLogger

    PlanetSideEmpire

    Vector3.Distance

    VitalityDefinition

  10. 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
    JammableMountedWeaponsJammableBehavior
  11. 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
    JammableMountedWeaponsJammableBehavior
  12. def CaptureTerminalAwareObject: FacilityTurret
  13. def CleanupAggravationTimer(id: Long): Unit
    Definition Classes
    AggravatedBehavior
  14. def DamageAwareness(target: Target, cause: DamageResult, amount: Any): 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
    FacilityTurretControlDamageableWeaponTurretDamageableEntity
  15. 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 Actor name 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

  16. 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
  17. def DamageableObject: FacilityTurret

    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
    FacilityTurretControlDamageableWeaponTurretDamageable
  18. def DestructionAwareness(target: Target, cause: DamageResult): 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
    FacilityTurretControlDamageableWeaponTurretDamageableEntity
    See also

    Damageable.DestructionAwareness

  19. def EndAllAggravation(): Unit
    Definition Classes
    AggravatedBehavior
  20. def FactionObject: FacilityTurret
    Definition Classes
    FacilityTurretControlBasicAffinity
  21. def HandleDamage(target: Target, cause: DamageResult, damage: Any): 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

  22. def HandleNtuGrant(sender: ActorRef, src: NtuContainer, amount: Float): Unit

    When reports of an NTU provision is returned to the requesting amenity, the amount of repair that can be performed is obtained and, if the amenity still requires those repairs, auto-repair executes a single tick.

    When reports of an NTU provision is returned to the requesting amenity, the amount of repair that can be performed is obtained and, if the amenity still requires those repairs, auto-repair executes a single tick.

    Definition Classes
    AmenityAutoRepairNtuStorageBehavior
    See also

    RepairableAmenity

  23. def HandleNtuOffer(sender: ActorRef, src: NtuContainer): Unit
  24. def HandleNtuRequest(sender: ActorRef, min: Float, max: Float): Unit
  25. def JammableMountedWeaponsJammeredStatus(target: PlanetSideServerObject with MountedWeapons, statusCode: Int): Unit
    Definition Classes
    JammableMountedWeapons
  26. def JammableObject: FacilityTurret

    ZoneAware is used for callback to the event systems

    ZoneAware is used for callback to the event systems

    Definition Classes
    FacilityTurretControlJammableBehavior
  27. def MountableObject: FacilityTurret
  28. def NtuStorageObject: NtuContainer
    Definition Classes
    NtuStorageBehavior
  29. def PerformDamage(target: Target, applyDamageTo: Output): Unit

    Assess the vital statistics of the target, apply the damage, and determine if any of those statistics changed.

    Assess the vital statistics of the target, apply the damage, and determine if any of those statistics changed. By default, only take an interest in the change of "health". If implementing custom DamageableAmenity with no new message handling, choose to override this method.

    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
    DamageableEntityDamageable
    See also

    DamageableAmenity.TakesDamage

    ResolutionCalculations.Output

    Vitality.Health

  30. def PerformRepairs(target: Target, amount: Int): Int
  31. 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.PlanetsideAttributeToAll

    AvatarAction.SendResponse

    AvatarService

    InventoryStateMessage

    PlanetSideGameObject.isMoving

    RepairMessage

    Service.defaultPlayerGUID

    Tool.Discharge

    Zone.AvatarEvents

  32. def RemoveAggravatedEntry(id: Long): Aura
    Definition Classes
    AggravatedBehavior
  33. def RepairToolValue(item: Tool): Float

    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
    Repairable
    See also

    Repairable.Quality

  34. def RepairableObject: FacilityTurret

    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
    FacilityTurretControlRepairableWeaponTurretRepairable
  35. def Restoration(obj: Target): Unit

    The entity is no longer destroyed.

    The entity is no longer destroyed.

    obj

    the entity

    Definition Classes
    FacilityTurretControlRepairableWeaponTurretRepairable
  36. 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
    JammableMountedWeaponsJammableBehavior
  37. 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
    JammableMountedWeaponsJammableBehavior
  38. def StopNtuBehavior(sender: ActorRef): Unit

    Stop the auto-repair timer.

    Stop the auto-repair timer.

    Definition Classes
    AmenityAutoRepairNtuStorageBehavior
  39. def TryAggravationEffectActivate(data: DamageResult): Option[AggravatedDamage]
    Definition Classes
    AggravatedBehavior
  40. def TryJammerEffectActivate(target: Any, cause: DamageResult): 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
    JammableBehavior
  41. def WillAffectTarget(target: Target, damage: Int, cause: DamageResult): 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.CanDamageOrJammer

    PerformDamage

  42. final def actuallyTryAutoRepair(): Boolean

    Attempt to start auto-repair operation only if no operation is currently being processed.

    Attempt to start auto-repair operation only if no operation is currently being processed. In case that an override to the normals operations of tryAutoRepair is necessary, but the superclass can not be invoked, this method is the backup of those operations to initiate auto-repair.

    returns

    true, if the auto-repair process started specifically due to this call; false, if it was already started, or did not start

    Definition Classes
    AmenityAutoRepair
    See also

    tryAutoRepair

  43. val aggravatedBehavior: Receive
    Definition Classes
    AggravatedBehavior
  44. def aroundPostRestart(reason: Throwable): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  45. def aroundPostStop(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  46. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  47. def aroundPreStart(): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  48. def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  49. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  50. final val autoRepairBehavior: Receive
    Definition Classes
    AmenityAutoRepair
  51. final val canBeRepairedByNanoDispenser: akka.actor.Actor.Receive

    The official mixin hook; orElse onto the "control" Actor receive; catch the expected repair message and apply initial checks to the item

    The official mixin hook; orElse onto the "control" Actor receive; catch the expected repair message and apply initial checks to the item

    Definition Classes
    Repairable
    See also

    Ammo

    CanBeRepairedByNanoDispenser

    CommonMessages.Use

    GlobalDefinitions

    Tool.AmmoType

  52. val captureTerminalAwareBehaviour: akka.actor.Actor.Receive
  53. val checkBehavior: Receive
    Definition Classes
    Check
  54. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  55. def commonBehavior: Receive
  56. implicit val context: ActorContext
    Definition Classes
    Actor
  57. def damageableWeaponTurretPostStop(): Unit
    Definition Classes
    DamageableWeaponTurret
  58. val dismountBehavior: Receive

    The logic governing Mountable objects that use the TryDismount message.

    The logic governing Mountable objects that use the TryDismount message. This is a mix-in trait for combining with existing Receive logic.

    Definition Classes
    MountableBehavior
    See also

    Seat

    Mountable

  59. def dismountTest(obj: Mountable with WorldEntity, seatNumber: Int, user: Player): Boolean
    Attributes
    protected
    Definition Classes
    MountableBehavior
  60. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  62. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  63. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  64. def getUsedMountPoint(playerName: String, seatNumber: Int): Int
    Definition Classes
    MountableBehavior
  65. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  66. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  67. def isPowered: Boolean
    Definition Classes
    PoweredAmenityControl
  68. val jammableBehavior: Receive
    Definition Classes
    JammableBehavior
  69. val jammedSound: Boolean

    flag for jammed sound

    flag for jammed sound

    Attributes
    protected
    Definition Classes
    JammableBehavior
  70. val jammeredSoundTimer: Cancellable

    the sound timer

    the sound timer

    Attributes
    protected
    Definition Classes
    JammableBehavior
  71. val jammeredStatusTimer: Cancellable

    the effect timer

    the effect timer

    Attributes
    protected
    Definition Classes
    JammableBehavior
  72. val mountBehavior: Receive

    The logic governing Mountable objects that use the TryMount message.

    The logic governing Mountable objects that use the TryMount message. This is a mix-in trait for combining with existing Receive logic.

    Definition Classes
    MountableBehavior
    See also

    Seat

    Mountable

  73. def mountTest(obj: PlanetSideServerObject with Mountable, seatNumber: Int, player: Player): Boolean
    Attributes
    protected
    Definition Classes
    FacilityTurretControlMountableBehavior
  74. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  75. def noNtuSupplyCallback(): Unit

    No (further) provisions of NTU to the potential requesting amenity will be forthcoming.

    No (further) provisions of NTU to the potential requesting amenity will be forthcoming. Cancel any attempts at auto-repair.

    Definition Classes
    AmenityAutoRepair
  76. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  77. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  78. final val originalTakesDamage: akka.actor.Actor.Receive

    a duplicate of the core implementation for the default mixin hook, for use in overriding

    a duplicate of the core implementation for the default mixin hook, for use in overriding

    Definition Classes
    Damageable
  79. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  80. def postStop(): Unit
    Definition Classes
    FacilityTurretControl → Actor
  81. final def powerOffCondition: Receive
    Definition Classes
    PoweredAmenityControl
  82. final def powerOnCondition: Receive
    Definition Classes
    PoweredAmenityControl
  83. def powerTurnOffCallback(): Unit
  84. def powerTurnOnCallback(): Unit
  85. def poweredStateLogic: Receive
  86. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  87. def preStart(): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  88. final def receive: Receive
    Definition Classes
    PoweredAmenityControl → Actor
  89. implicit final val self: ActorRef
    Definition Classes
    Actor
  90. final def sender(): ActorRef
    Definition Classes
    Actor
  91. final def stopAutoRepair(): Unit

    Cancel any attempts at auto-repair by stopping any currently processing repair timer The operation can be resumed.

    Cancel any attempts at auto-repair by stopping any currently processing repair timer The operation can be resumed.

    Definition Classes
    AmenityAutoRepair
    See also

    stopAutoRepairFunctionality

  92. def storageBehavior: Receive
    Definition Classes
    NtuStorageBehavior
  93. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  94. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  95. val takesDamage: Receive

    the official mixin hook; orElse onto the "control" Actor receive; or, cite the originalTakesDamage protocol during inheritance overrides

    the official mixin hook; orElse onto the "control" Actor receive; or, cite the originalTakesDamage protocol during inheritance overrides

    Definition Classes
    DamageableWeaponTurretDamageable
  96. def toString(): String
    Definition Classes
    AnyRef → Any
  97. def tryAutoRepair(): Boolean

    Attempt to start auto-repair operation only if no operation is currently being processed.

    Attempt to start auto-repair operation only if no operation is currently being processed.

    returns

    true, if the auto-repair process started specifically due to this call; false, if it was already started, or did not start

    Definition Classes
    FacilityTurretControlAmenityAutoRepair
    See also

    actuallyTryAutoRepair

  98. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  99. def unpoweredStateLogic: Receive
  100. val usedMountPoint: HashMap[String, Int]

    retain the mount point that was used by this occupant to mount

    retain the mount point that was used by this occupant to mount

    Definition Classes
    MountableBehavior
  101. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  102. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  103. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  104. var weaponAmmoRechargeTimer: Cancellable
  105. def withNtuSupplyCallback(): Unit

    Confirm that a provision of NTU to the potential requesting amenity is possible.

    Confirm that a provision of NTU to the potential requesting amenity is possible. Attempt to start auto-repair operations.

    Definition Classes
    AmenityAutoRepair

Inherited from JammableMountedWeapons

Inherited from JammableBehavior

Inherited from AmenityAutoRepair

Inherited from NtuStorageBehavior

Inherited from RepairableWeaponTurret

Inherited from RepairableEntity

Inherited from Repairable

Inherited from DamageableWeaponTurret

Inherited from AggravatedBehavior

Inherited from DamageableEntity

Inherited from Damageable

Inherited from MountableBehavior

Inherited from Check

Inherited from BasicAffinity

Inherited from PoweredAmenityControl

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped