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 iffalse- vehicle_state
optional state of the vehicle the player is driving
- Source
- OxygenStateMessage.scala
- Alphabetic
- By Inheritance
- OxygenStateMessage
- Product
- Equals
- PlanetSideGamePacket
- PlanetSidePacket
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new OxygenStateMessage(player_guid: PlanetSideGUID, progress: Float, active: Boolean, vehicle_state: Option[WaterloggedVehicleState] = None)
- 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 iffalse- vehicle_state
optional state of the vehicle the player is driving
Type Members
- type Packet = OxygenStateMessage
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
- val active: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def encode: Attempt[BitVector]
- Definition Classes
- OxygenStateMessage → PlanetSidePacket
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def opcode: GamePacketOpcode.Value
- Definition Classes
- OxygenStateMessage → PlanetSideGamePacket → PlanetSidePacket
- val player_guid: PlanetSideGUID
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val progress: Float
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val vehicle_state: Option[WaterloggedVehicleState]
- 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()