Class/Object

net.psforever.packet.game

OxygenStateMessage

Related Docs: object OxygenStateMessage | package game

Permalink

final case class OxygenStateMessage(player_guid: PlanetSideGUID, progress: Float, active: Boolean, vehicle_state: Option[WaterloggedVehicleState] = None) extends PlanetSideGamePacket with Product with Serializable

Dispatched by the server to cause the player to slowly drown. If the player is mounted in a vehicle at the time, alert the player that the vehicle may be disabled.

When a player walks too far underwater, a borderless red progress bar with a countdown from 100 (98) is displayed across the screen. The countdown proceeds to zero at a fixed rate and is timed with the depleting progress bar. When it reaches zero, the player will be killed. If the player is in a vehicle after a certain depth, a blue bar and countdown pair will superimpose the red indicators. It depletes much more rapidly than the red indicators. When it reaches zero, the vehicle will become disabled. All players in the vehicle's seats will be kicked and they will not be allowed back in.

Normally, the countdowns should be set to begin at 100 (100.0). This is the earliest the drowning GUI will appear for either blue or red indicators. Passing greater intervals - up to 204.8 - will start the countdown silently but the GUI will be hidden until 100.0. (The progress indicators will actually appear to start counting from 98.) Managing the secondary vehicle countdown independent of the primary player countdown requires updating with the correct levels. The countdown can be cancelled by instructing it to be active = false.

Except for updating the indicators, all other functionality of "drowning" is automated by the server.

player_guid

the player

progress

the remaining countdown; for character oxygen, the progress per second rate is about 1

active

show a new countdown if true (resets any active countdown); clear any active countdowns if false

vehicle_state

optional state of the vehicle the player is driving

Source
OxygenStateMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OxygenStateMessage
  2. Product
  3. Equals
  4. PlanetSideGamePacket
  5. PlanetSidePacket
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OxygenStateMessage(player_guid: PlanetSideGUID, progress: Float, active: Boolean, vehicle_state: Option[WaterloggedVehicleState] = None)

    Permalink

    player_guid

    the player

    progress

    the remaining countdown; for character oxygen, the progress per second rate is about 1

    active

    show a new countdown if true (resets any active countdown); clear any active countdowns if false

    vehicle_state

    optional state of the vehicle the player is driving

Type Members

  1. type Packet = OxygenStateMessage

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to any2stringadd[OxygenStateMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (OxygenStateMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to ArrowAssoc[OxygenStateMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. val active: Boolean

    Permalink

    show a new countdown if true (resets any active countdown); clear any active countdowns if false

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    OxygenStateMessagePlanetSidePacket
  10. def ensuring(cond: (OxygenStateMessage) ⇒ Boolean, msg: ⇒ Any): OxygenStateMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to Ensuring[OxygenStateMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (OxygenStateMessage) ⇒ Boolean): OxygenStateMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to Ensuring[OxygenStateMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): OxygenStateMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to Ensuring[OxygenStateMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): OxygenStateMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to Ensuring[OxygenStateMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to StringFormat[OxygenStateMessage] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def opcode: GamePacketOpcode.Value

    Permalink
  23. val player_guid: PlanetSideGUID

    Permalink

    the player

  24. val progress: Float

    Permalink

    the remaining countdown; for character oxygen, the progress per second rate is about 1

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. val vehicle_state: Option[WaterloggedVehicleState]

    Permalink

    optional state of the vehicle the player is driving

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (OxygenStateMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from OxygenStateMessage to ArrowAssoc[OxygenStateMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Product

Inherited from Equals

Inherited from PlanetSideGamePacket

Inherited from PlanetSidePacket

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from OxygenStateMessage to any2stringadd[OxygenStateMessage]

Inherited by implicit conversion StringFormat from OxygenStateMessage to StringFormat[OxygenStateMessage]

Inherited by implicit conversion Ensuring from OxygenStateMessage to Ensuring[OxygenStateMessage]

Inherited by implicit conversion ArrowAssoc from OxygenStateMessage to ArrowAssoc[OxygenStateMessage]

Ungrouped