Class/Object

net.psforever.packet.game

BindPlayerMessage

Related Docs: object BindPlayerMessage | package game

Permalink

final case class BindPlayerMessage(action: BindStatus.Value, bind_desc: String, display_icon: Boolean, logging: Boolean, spawn_group: types.SpawnGroup.Value, zone_number: Long, unk4: Long, pos: Vector3) extends PlanetSideGamePacket with Product with Serializable

A packet dispatched to maintain a manually-set respawn location.

The packet establishes the player's ability to spawn in an arbitrary location that is not a normal local option. This process is called "binding one's matrix." In addition to player establishing the binding, the packet updates as conditions of the respawn location changes.

If logging is turned on, packets will display different messages depending on context. The bind descriptor will be used to flavor the events chat message. As long as the event is marked to be logged, when the packet is received, a message is displayed in the events window. If the logged action is applicable, the matrixing sound effect will be played too. Not displaying events is occasionally warranted for aesthetics. The game will always note if this is your first time binding regardless of the state of this flag.

Bind Descriptors:
@amp_station
@ams
@comm_station (interlink facility?)
@comm_station_dsp (dropship center?)
@cryo_facility (biolab?)
@tech_plant

Exploration:
Find other bind descriptors.

action

the purpose of the packet

bind_desc

a text description of the respawn binding point

display_icon

show the selection icon on the redeployment map

logging

true, to report on bind point change visible in the events window; false, to render spawn change silently; some first time notifications will always display regardless of this flag

spawn_group

the kind of spawn request that will be made; affects the type of icon displayed; will coincide with the value of unk2 in SpawnRequestMessage when the spawn option is selected

zone_number

the number of the zone in which to display this spawn option; if zone_number is not the current zone, and the action is positive, a small map of the alternate zone with selectable spawn point will become visible

unk4

na

pos

coordinates for any displayed deployment map icon; x and y determine the position

Source
BindPlayerMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BindPlayerMessage
  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 BindPlayerMessage(action: BindStatus.Value, bind_desc: String, display_icon: Boolean, logging: Boolean, spawn_group: types.SpawnGroup.Value, zone_number: Long, unk4: Long, pos: Vector3)

    Permalink

    action

    the purpose of the packet

    bind_desc

    a text description of the respawn binding point

    display_icon

    show the selection icon on the redeployment map

    logging

    true, to report on bind point change visible in the events window; false, to render spawn change silently; some first time notifications will always display regardless of this flag

    spawn_group

    the kind of spawn request that will be made; affects the type of icon displayed; will coincide with the value of unk2 in SpawnRequestMessage when the spawn option is selected

    zone_number

    the number of the zone in which to display this spawn option; if zone_number is not the current zone, and the action is positive, a small map of the alternate zone with selectable spawn point will become visible

    unk4

    na

    pos

    coordinates for any displayed deployment map icon; x and y determine the position

Type Members

  1. type Packet = BindPlayerMessage

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from BindPlayerMessage to ArrowAssoc[BindPlayerMessage] 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 action: BindStatus.Value

    Permalink

    the purpose of the packet

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val bind_desc: String

    Permalink

    a text description of the respawn binding point

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val display_icon: Boolean

    Permalink

    show the selection icon on the redeployment map

  11. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    BindPlayerMessagePlanetSidePacket
  12. def ensuring(cond: (BindPlayerMessage) ⇒ Boolean, msg: ⇒ Any): BindPlayerMessage

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  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 BindPlayerMessage to StringFormat[BindPlayerMessage] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  21. val logging: Boolean

    Permalink

    true, to report on bind point change visible in the events window; false, to render spawn change silently; some first time notifications will always display regardless of this flag

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

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

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

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

    Permalink
  26. val pos: Vector3

    Permalink

    coordinates for any displayed deployment map icon; x and y determine the position

  27. val spawn_group: types.SpawnGroup.Value

    Permalink

    the kind of spawn request that will be made; affects the type of icon displayed; will coincide with the value of unk2 in SpawnRequestMessage when the spawn option is selected

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

    Permalink
    Definition Classes
    AnyRef
  29. val unk4: Long

    Permalink

    na

  30. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. val zone_number: Long

    Permalink

    the number of the zone in which to display this spawn option; if zone_number is not the current zone, and the action is positive, a small map of the alternate zone with selectable spawn point will become visible

  34. def [B](y: B): (BindPlayerMessage, B)

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

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

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

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

Ungrouped