Class/Object

net.psforever.packet.game

PlayerStateMessage

Related Docs: object PlayerStateMessage | package game

Permalink

final case class PlayerStateMessage(guid: PlanetSideGUID, pos: Vector3, vel: Option[Vector3], facingYaw: Float, facingPitch: Float, facingYawUpper: Float, timestamp: Int, is_crouching: Boolean = false, is_jumping: Boolean = false, jump_thrust: Boolean = false, is_cloaked: Boolean = false) extends PlanetSideGamePacket with Product with Serializable

The server instructs some clients to render a player (usually not that client's avatar) to move in a certain way.

This packet instructs the basic aspects of how the player character is positioned and how the player character moves. Each client keeps track of where a character "currently" is according to that client. pos reflects an update in regards to where the character should be moved. Data between this "currently" and "new" are interpolated over a fixed time interval. Position and velocity data is standard to normal PlanetSide ranges. All angles follow the convention that every 0x1 is about 2.8125 degrees; so, 0x10 is 45.0 degrees.

The avatar model normally moves from where it "currently" is to pos. When vel is defined, pos is treated as where the avatar model starts its animation. In that case, it appears to teleport to pos to carry out the interpolated movement according to vel. After the move, it remains at essentially pos + vel * t. The repositioning always takes the same amount of time. The player model is left in a walking/running animation (in place) until directed otherwise.

If the model must interact with the environment during a velocity-driven move, it copes with local physics. A demonstration of this is what happens when one player "runs past"/"into" another player running up stairs. The climbing player is frequently reported by the other to appear to bounce over that player's head. If the other player is off the ground, passing too near to the observer can cause a rubber band effect on trajectory. This effect is entirely client-side to the observer and affects the moving player in no way.

guid

the avatar's guid

pos

the position of the avatar in the world environment (in three coordinates)

vel

an optional velocity

facingYaw

a "yaw" angle

facingPitch

a "pitch" angle

facingYawUpper

a "yaw" angle that represents the angle of the avatar's upper body with respect to its forward-facing direction; this number is normally 0 for forward facing; the range is limited between approximately 61 degrees of center turned to left or right

timestamp

A sequential counter

is_crouching

avatar is crouching

is_jumping

avatar is jumping; must remain flagged for jump to maintain animation

jump_thrust

provide a measure of vertical stability when really close to the avatar character

is_cloaked

avatar is cloaked by virtue of an Infiltration Suit

Source
PlayerStateMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayerStateMessage
  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 PlayerStateMessage(guid: PlanetSideGUID, pos: Vector3, vel: Option[Vector3], facingYaw: Float, facingPitch: Float, facingYawUpper: Float, timestamp: Int, is_crouching: Boolean = false, is_jumping: Boolean = false, jump_thrust: Boolean = false, is_cloaked: Boolean = false)

    Permalink

    guid

    the avatar's guid

    pos

    the position of the avatar in the world environment (in three coordinates)

    vel

    an optional velocity

    facingYaw

    a "yaw" angle

    facingPitch

    a "pitch" angle

    facingYawUpper

    a "yaw" angle that represents the angle of the avatar's upper body with respect to its forward-facing direction; this number is normally 0 for forward facing; the range is limited between approximately 61 degrees of center turned to left or right

    timestamp

    A sequential counter

    is_crouching

    avatar is crouching

    is_jumping

    avatar is jumping; must remain flagged for jump to maintain animation

    jump_thrust

    provide a measure of vertical stability when really close to the avatar character

    is_cloaked

    avatar is cloaked by virtue of an Infiltration Suit

Type Members

  1. type Packet = PlayerStateMessage

    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 PlayerStateMessage to any2stringadd[PlayerStateMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PlayerStateMessage, B)

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

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

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

    Permalink
    Definition Classes
    PlayerStateMessagePlanetSidePacket
  9. def ensuring(cond: (PlayerStateMessage) ⇒ Boolean, msg: ⇒ Any): PlayerStateMessage

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  14. val facingPitch: Float

    Permalink

    a "pitch" angle

  15. val facingYaw: Float

    Permalink

    a "yaw" angle

  16. val facingYawUpper: Float

    Permalink

    a "yaw" angle that represents the angle of the avatar's upper body with respect to its forward-facing direction; this number is normally 0 for forward facing; the range is limited between approximately 61 degrees of center turned to left or right

  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. val guid: PlanetSideGUID

    Permalink

    the avatar's guid

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. val is_cloaked: Boolean

    Permalink

    avatar is cloaked by virtue of an Infiltration Suit

  23. val is_crouching: Boolean

    Permalink

    avatar is crouching

  24. val is_jumping: Boolean

    Permalink

    avatar is jumping; must remain flagged for jump to maintain animation

  25. val jump_thrust: Boolean

    Permalink

    provide a measure of vertical stability when really close to the avatar character

  26. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
  30. val pos: Vector3

    Permalink

    the position of the avatar in the world environment (in three coordinates)

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

    Permalink
    Definition Classes
    AnyRef
  32. val timestamp: Int

    Permalink

    A sequential counter

  33. val vel: Option[Vector3]

    Permalink

    an optional velocity

  34. final def wait(): Unit

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from PlayerStateMessage to ArrowAssoc[PlayerStateMessage] 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 PlayerStateMessage to any2stringadd[PlayerStateMessage]

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

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

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

Ungrouped