class PlayerControl extends Actor with JammableBehavior with Damageable with ContainableBehavior with AggravatedBehavior with AuraEffectBehavior with RespondsToZoneEnvironment
- Source
- PlayerControl.scala
- Alphabetic
- By Inheritance
- PlayerControl
- RespondsToZoneEnvironment
- AuraEffectBehavior
- AggravatedBehavior
- ContainableBehavior
- Damageable
- JammableBehavior
- 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 AggravatedObject: Player
- Definition Classes
- PlayerControl → AggravatedBehavior
- def AggravatedReaction: Boolean
- Definition Classes
- AggravatedBehavior
- def AggravationCleanup(id: Long): Unit
- Definition Classes
- AggravatedBehavior
- def ApplicableEffect(effect: Aura): Unit
Only pre-apporved aura effects will be emitted by this target.
Only pre-apporved aura effects will be emitted by this target.
- effect
the aura effect
- Definition Classes
- AuraEffectBehavior
- def AuraTargetObject: Player
- Definition Classes
- PlayerControl → AuraEffectBehavior
- def CancelJammeredSound(target: Any): Unit
Stop the jammered buzzing.
Stop the jammered buzzing.
- target
an object that can be affected by the jammered status
- Definition Classes
- PlayerControl → JammableBehavior
- See also
JammableBehavior.CancelJammeredSound
- 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
- PlayerControl → JammableBehavior
- def CleanupAggravationTimer(id: Long): Unit
- Definition Classes
- AggravatedBehavior
- def ContainerObject: Player
- Definition Classes
- PlayerControl → ContainableBehavior
- def DamageAwareness(target: Player, cause: DamageResult, damageToHealth: Int, damageToArmor: Int, damageToStamina: Int, damageToCapacitor: Int): Unit
- def DamageableObject: Player
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
- PlayerControl → Damageable
- def DestructionAwareness(target: Player, cause: DamageResult): Unit
The player has lost all his vitality and must be killed.
Shift directly into a state of being dead on the client by setting health to zero points, whereupon the player will perform a dramatic death animation.The player has lost all his vitality and must be killed.
Shift directly into a state of being dead on the client by setting health to zero points, whereupon the player will perform a dramatic death animation. Stamina is also set to zero points. If the player was in a vehicle at the time of demise, special conditions apply and the model must be manipulated so it behaves correctly. Do not move or completely destroy thePlayerobject as its coordinates of death will be important.
A maximum revive waiting timer is started. When this timer reaches zero, the avatar will attempt to spawn back on its faction-specific sanctuary continent.- target
na
- cause
na
- def EndAllAggravation(): Unit
- Definition Classes
- AggravatedBehavior
- def EndAllEffects(): Unit
Stop the target entity from emitting all aura particle effects.
Stop the target entity from emitting all aura particle effects.
- Definition Classes
- AuraEffectBehavior
- def EndAllEffectsAndUpdate(): Unit
Stop the target entity from emitting all aura particle effects.
Stop the target entity from emitting all aura particle effects. Animate the new particle effect state.
- Definition Classes
- AuraEffectBehavior
- def EndAuraEffect(effect: Aura): Boolean
Stop the target entity from emitting the aura particle effect, if it currently is.
Stop the target entity from emitting the aura particle effect, if it currently is.
- effect
the target effect
- returns
true, if the effect was being emitted but has been stoppedfalse, if the effect was not approved or is not being emitted
- Definition Classes
- AuraEffectBehavior
- def EndAuraEffectAndUpdate(effect: Aura): Unit
Stop the target entity from emitting the aura particle effect, if it currently is.
Stop the target entity from emitting the aura particle effect, if it currently is. If the effect has been stopped, animate the new particle effect state.
- Definition Classes
- AuraEffectBehavior
- def HandleDamage(target: Player, cause: DamageResult, damageToHealth: Int, damageToArmor: Int, damageToStamina: Int, damageToCapacitor: Int): Unit
na
na
- target
na
- def InteractWith: Option[PieceOfEnvironment]
- Definition Classes
- RespondsToZoneEnvironment
- def InteractiveObject: Player
- Definition Classes
- PlayerControl → RespondsToZoneEnvironment
- def JammableObject: Player
ZoneAwareis used for callback to the event systemsZoneAwareis used for callback to the event systems- Definition Classes
- PlayerControl → JammableBehavior
- 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
- PlayerControl → ContainableBehavior
- 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 damage with no new message handling, 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
- PlayerControl → Damageable
- See also
ResolutionCalculations.Output
- 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
- PlayerControl → ContainableBehavior
- def RemoveAggravatedEntry(id: Long): Aura
- Definition Classes
- AggravatedBehavior
- 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
- PlayerControl → ContainableBehavior
- def RepairValue(item: Tool): Int
- 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 Resume(): Unit
Decrement the flag for blocking messages.
Decrement the flag for blocking messages.
- Definition Classes
- ContainableBehavior
- def SetInteraction(attribute: EnvironmentTrait, action: Interaction): Unit
- Definition Classes
- RespondsToZoneEnvironment
- def SetInteractionStop(attribute: EnvironmentTrait, action: Interaction): Unit
- Definition Classes
- RespondsToZoneEnvironment
- def StartAuraEffect(effect: Aura, duration: Long): Unit
An aura particle effect is to be emitted by the target.
An aura particle effect is to be emitted by the target. If the effect was not previously applied to the target in an ongoing manner, animate it appropriately.
- effect
the effect to be emitted
- duration
for how long the effect will be emitted
- returns
the active effect index number
- Definition Classes
- AuraEffectBehavior
- def StartJammeredSound(target: Any, dur: Int): Unit
Start the jammered buzzing.
Start the jammered buzzing. Although, as a rule, the jammering sound effect should last as long as the jammering status, Infantry seem to hear the sound for a bit longer than the effect.
- target
an object that can be affected by the jammered status
- dur
the duration of the timer, in milliseconds; by default, 30000
- Definition Classes
- PlayerControl → JammableBehavior
- See also
JammableBehavior.StartJammeredSound
- def StartJammeredStatus(target: Any, dur: Int): Unit
Perform a variety of tasks to indicate being jammered.
Perform a variety of tasks to indicate being jammered. Deactivate implants (should also uninitialize them), delay stamina regeneration for a certain number of turns, and set the jammered status on specific holstered equipment.
- target
an object that can be affected by the jammered status
- dur
the duration of the timer, in milliseconds
- Definition Classes
- PlayerControl → JammableBehavior
- See also
JammableBehavior.StartJammeredStatus
- 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
- PlayerControl → ContainableBehavior
- def TestForEffect(effect: Aura): Boolean
Is the target entity emitting the aura effect?
Is the target entity emitting the aura effect?
- effect
the effect being tested
- returns
true, if the effect is currently being emitted;false, otherwise
- Definition Classes
- AuraEffectBehavior
- def TryAggravationEffectActivate(data: DamageResult): Option[AggravatedDamage]
- Definition Classes
- AggravatedBehavior
- 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
- def UpdateAuraEffect(target: Target): Unit
An override callback to display aura effects emitted.
An override callback to display aura effects emitted.
- target
the entity from which the aura effects are being emitted
- Definition Classes
- PlayerControl → AuraEffectBehavior
- def Wait(): Unit
Increment the flag for blocking messages.
Increment the flag for blocking messages.
- Definition Classes
- ContainableBehavior
- val aggravatedBehavior: Receive
- Definition Classes
- AggravatedBehavior
- 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
- val auraBehavior: Receive
- Definition Classes
- AuraEffectBehavior
- 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
- def doEnvironmentInteracting(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
- Definition Classes
- RespondsToZoneEnvironment
- def doInteractingWithDeath(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
Death causes players to die outright.
Death causes players to die outright. It's not even considered as environmental damage anymore.
- obj
the target
- body
the environment
- data
additional interaction information, if applicable
- def doInteractingWithGantryField(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
- def doInteractingWithLava(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
Lava causes players to take (considerable) damage until they inevitably die.
Lava causes players to take (considerable) damage until they inevitably die.
- obj
the target
- body
the environment
- data
additional interaction information, if applicable
- def doInteractingWithWater(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
Water causes players to slowly suffocate.
Water causes players to slowly suffocate. When they (finally) drown, they will die.
- obj
the target
- body
the environment
- data
additional interaction information, if applicable; for players, this will be data from any mounted vehicles
- val environmentBehavior: Receive
- Definition Classes
- RespondsToZoneEnvironment
- 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])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val interactWith: Option[PieceOfEnvironment]
the environment that we are currently in interaction with
the environment that we are currently in interaction with
- Definition Classes
- RespondsToZoneEnvironment
- val interactionTime: Long
how long the current interaction has been progressing in the current way
how long the current interaction has been progressing in the current way
- Definition Classes
- RespondsToZoneEnvironment
- val interactionTimer: Cancellable
a gesture of automation added to the interaction
a gesture of automation added to the interaction
- Definition Classes
- RespondsToZoneEnvironment
- 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 lockerControlAgent: ActorRef
control agency for the player's locker container (dedicated inventory slot #5)
- 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()
- 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
- PlayerControl → 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
- PlayerControl → Actor
- def recoverFromEnvironmentInteracting(): Unit
Reset the environment encounter fields and completely stop whatever is the current mechanic.
Reset the environment encounter fields and completely stop whatever is the current mechanic. This does not perform messaging relay either with mounted occupants or with any other service.
- Definition Classes
- PlayerControl → RespondsToZoneEnvironment
- implicit final val self: ActorRef
- Definition Classes
- Actor
- final def sender(): ActorRef
- Definition Classes
- Actor
- def stopEnvironmentInteracting(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
- Definition Classes
- RespondsToZoneEnvironment
- def stopInteractingWithWater(obj: PlanetSideServerObject, body: PieceOfEnvironment, data: Option[OxygenStateTarget]): Unit
When out of water, the player is no longer suffocating.
When out of water, the player is no longer suffocating. The player does have to endure a recovery period to get back to normal, though.
- obj
the target
- body
the environment
- data
additional interaction information, if applicable; for players, this will be data from any mounted vehicles
- var submergedCondition: Option[OxygenState]
suffocating, or regaining breath?
- def suicide(): Unit
- 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 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()