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 CanBeRepairedByNanoDispenser(player: Player, item: Tool): Unit

   The shield generator has two upgrade paths - blocking projectiles, and providing ammunition like a terminal.

   The shield generator has two upgrade paths - blocking projectiles, and providing ammunition like a terminal. Both upgrade paths are possible using the nano dispenser with an armor canister, and can only be started when the generator is undamaged.

   player

   the user of the nano dispenser tool

   item

   the nano dispenser tool

   Definition Classes

   ShieldGeneratorControl → RepairableEntity → Repairable

   See also

   PlanetSideGameObject.CanRepair

   RepairableEntity.CanPerformRepairs

5.  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

6.  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

   ShieldGeneratorControl → JammableBehavior

7.  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

   ShieldGeneratorControl → JammableBehavior

8.  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

   ShieldGeneratorControl → DamageableEntity

9.  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

10.  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

11.  def DamageableObject: ShieldGeneratorDeployable

    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

    ShieldGeneratorControl → Damageable

12.  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

    ShieldGeneratorControl → DamageableEntity

    See also

    Damageable.DestructionAwareness

13.  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

14.  def JammableObject: ShieldGeneratorDeployable

    ZoneAware is used for callback to the event systems

    ZoneAware is used for callback to the event systems

    Definition Classes

    ShieldGeneratorControl → JammableBehavior

15.  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

    ShieldGeneratorControl → DamageableEntity → Damageable

    See also

    DamageableAmenity.TakesDamage

    ResolutionCalculations.Output

    Vitality.Health

16.  def PerformRepairs(target: Target, amount: Int): Int

    Attributes

    protected

    Definition Classes

    RepairableEntity

17.  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

18.  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

19.  def RepairableObject: ShieldGeneratorDeployable

    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

    ShieldGeneratorControl → Repairable

20.  def Restoration(obj: Target): Unit

    The entity is no longer destroyed.

    The entity is no longer destroyed.

    obj

    the entity

    Definition Classes

    Repairable

21.  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

    ShieldGeneratorControl → JammableBehavior

22.  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

    ShieldGeneratorControl → JammableBehavior

23.  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

24.  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

25.  def aroundPostRestart(reason: Throwable): Unit

    Attributes

    protected[akka]

    Definition Classes

    Actor

    Annotations

    @InternalApi()

26.  def aroundPostStop(): Unit

    Attributes

    protected[akka]

    Definition Classes

    Actor

    Annotations

    @InternalApi()

27.  def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Attributes

    protected[akka]

    Definition Classes

    Actor

    Annotations

    @InternalApi()

28.  def aroundPreStart(): Unit

    Attributes

    protected[akka]

    Definition Classes

    Actor

    Annotations

    @InternalApi()

29.  def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

    Attributes

    protected[akka]

    Definition Classes

    Actor

    Annotations

    @InternalApi()

30.  final def asInstanceOf[T0]: T0

    Definition Classes

    Any

31.  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

32.  def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.CloneNotSupportedException]) @native()

33.  implicit val context: ActorContext

    Definition Classes

    Actor

34.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

35.  def equals(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef → Any

36.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.Throwable])

37.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

38.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

39.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

40.  val jammableBehavior: Receive

    Definition Classes

    JammableBehavior

41.  val jammedSound: Boolean

    flag for jammed sound

    flag for jammed sound

    Attributes

    protected

    Definition Classes

    JammableBehavior

42.  val jammeredSoundTimer: Cancellable

    the sound timer

    the sound timer

    Attributes

    protected

    Definition Classes

    JammableBehavior

43.  val jammeredStatusTimer: Cancellable

    the effect timer

    the effect timer

    Attributes

    protected

    Definition Classes

    JammableBehavior

44.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

45.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

46.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

47.  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

48.  def postRestart(reason: Throwable): Unit

    Definition Classes

    Actor

    Annotations

    @throws(classOf[java.lang.Exception])

49.  def postStop(): Unit

    Definition Classes

    Actor

    Annotations

    @throws(classOf[java.lang.Exception])

50.  def preRestart(reason: Throwable, message: Option[Any]): Unit

    Definition Classes

    Actor

    Annotations

    @throws(classOf[java.lang.Exception])

51.  def preStart(): Unit

    Definition Classes

    Actor

    Annotations

    @throws(classOf[java.lang.Exception])

52.  def receive: Receive

    Definition Classes

    ShieldGeneratorControl → Actor

53.  implicit final val self: ActorRef

    Definition Classes

    Actor

54.  final def sender(): ActorRef

    Definition Classes

    Actor

55.  def supervisorStrategy: SupervisorStrategy

    Definition Classes

    Actor

56.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

57.  val takesDamage: akka.actor.Actor.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

    Damageable

58.  def toString(): String

    Definition Classes

    AnyRef → Any

59.  def unhandled(message: Any): Unit

    Definition Classes

    Actor

60.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

61.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

62.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()