class GeneratorControl extends Actor with Check with DamageableEntity with RepairableEntity with AmenityAutoRepair
An Actor that handles messages being dispatched to a specific Generator.
- Source
- GeneratorControl.scala
- Alphabetic
- By Inheritance
- GeneratorControl
- AmenityAutoRepair
- NtuStorageBehavior
- RepairableEntity
- Repairable
- DamageableEntity
- Damageable
- Check
- BasicAffinity
- Actor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 AutoRepairObject: Generator
- Definition Classes
- GeneratorControl → AmenityAutoRepair
- 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(obj: 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.- 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
- GeneratorControl → RepairableEntity
- See also
org.log4s.getLoggerPlanetSideEmpireVector3.DistanceVitalityDefinition
- 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
- GeneratorControl → 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: Generator
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
- GeneratorControl → Damageable
- 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
- GeneratorControl → DamageableEntity
- See also
Damageable.DestructionAwareness
- def FactionObject: Generator
- Definition Classes
- GeneratorControl → BasicAffinity
- 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
- 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
- AmenityAutoRepair → NtuStorageBehavior
- See also
RepairableAmenity
- def HandleNtuOffer(sender: ActorRef, src: NtuContainer): Unit
- Definition Classes
- AmenityAutoRepair → NtuStorageBehavior
- def HandleNtuRequest(sender: ActorRef, min: Float, max: Float): Unit
- Definition Classes
- AmenityAutoRepair → NtuStorageBehavior
- def NtuStorageObject: NtuContainer
- Definition Classes
- NtuStorageBehavior
- 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
DamageableAmenitywith 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
- DamageableEntity → Damageable
- See also
DamageableAmenity.TakesDamageResolutionCalculations.OutputVitality.Health
- def PerformRepairs(target: Target, amount: Int): Int
- Definition Classes
- GeneratorControl → RepairableEntity
- 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 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
- def RepairableObject: Generator
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
- GeneratorControl → Repairable
- def Restoration(obj: Target): Unit
The entity is no longer destroyed.
- def StopNtuBehavior(sender: ActorRef): Unit
Stop the auto-repair timer.
Stop the auto-repair timer.
- Definition Classes
- AmenityAutoRepair → NtuStorageBehavior
- 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
- GeneratorControl → DamageableEntity
- See also
Damageable.CanDamageOrJammerPerformDamage
- 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
tryAutoRepairis 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
- var alarmCooldown: Cancellable
when damaged, announce that damage was dealt on a schedule
- 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 autoRepairBehavior: Receive
- Definition Classes
- AmenityAutoRepair
- 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 checkBehavior: Receive
- Definition Classes
- Check
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val commonBehavior: Receive
behavior that is valid for both "with-ntu" and "without-ntu"
- implicit val context: ActorContext
- Definition Classes
- Actor
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- lazy val explosionFunc: (PlanetSideGameObject, PlanetSideGameObject, Float) => Boolean
the canned explosion used by this generator
- 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()
- var imminentExplosion: Boolean
flagged to explode after some time
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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
- GeneratorControl → AmenityAutoRepair
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- def postRestart(reason: Throwable): Unit
- Definition Classes
- Actor
- Annotations
- @throws(classOf[java.lang.Exception])
- def postStop(): Unit
- Definition Classes
- Actor
- Annotations
- @throws(classOf[java.lang.Exception])
- 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])
- var queuedExplosion: Cancellable
explode when this timer completes
- def receive: Receive
- Definition Classes
- GeneratorControl → Actor
- implicit final val self: ActorRef
- Definition Classes
- Actor
- final def sender(): ActorRef
- Definition Classes
- Actor
- 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
- def storageBehavior: Receive
- Definition Classes
- NtuStorageBehavior
- def supervisorStrategy: SupervisorStrategy
- Definition Classes
- Actor
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val takesDamage: akka.actor.Actor.Receive
the official mixin hook;
orElseonto the "control"Actorreceive; or, cite theoriginalTakesDamageprotocol during inheritance overridesthe official mixin hook;
orElseonto the "control"Actorreceive; or, cite theoriginalTakesDamageprotocol during inheritance overrides- Definition Classes
- Damageable
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- AmenityAutoRepair
- See also
actuallyTryAutoRepair
- 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()
- def withNtu: Receive
- 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
- GeneratorControl → AmenityAutoRepair
- def withoutNtu: Receive