Packages

final case class ReplicationStreamMessage(behavior: Int, behavior2: Option[Int], entries: Vector[SquadListing]) extends PlanetSideGamePacket with Product with Serializable

Display the list of squads available to a given player.

The four main operations are: initializing the list, updating entries in the list, removing entries from the list, and clearing the list. The process of initializing the list and clearing the list actually are performed by similar behavior. Squads would just not be added after the list clears. Moreover, removing entries from the list overrides the behavior to update entries in the list. Squad list entries are typically referenced by their line index.

Though often specified with a global identifier, squads are rarely accessed using that identifier. Outside of initialization activities, the specific index of the squad listing is referenced. During the list initialization process, the entries must be in ascending order of index. The total number of entries in a packet is not known until they have all been parsed. The minimum number of entries is "no entries." The maximum number of entries is supposedly 254. The last item is always the index 255 and this is interpreted as the end of the stream.

When no updates are provided, the client loads a default (but invalid) selection of data comprising four squads:
0  Holeesh      another purpose  Desolation  6/7
1  Korealis     another purpose  Drugaskan   10/10
2  PsychoSanta  blah blah blah               10/10
3  Squishling   another purpose  Cyssor      8/10
The last entry is entirely in green text.

Behaviors:
behavior behavior2
1        X         Update where initial entry removes a squad from the list
5        6         Clear squad list and initialize new squad list
5        6         Clear squad list (transitions directly into 255-entry)
6        X         Update a squad in the list

behavior

a required code that suggests the operations of the data in this packet

behavior2

an optional code that suggests the operations of the data in this packet; during initialization, this code is read; it typically flags an "update" action

entries

a Vector of the squad listings

Source
ReplicationStreamMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReplicationStreamMessage
  2. Product
  3. Equals
  4. PlanetSideGamePacket
  5. PlanetSidePacket
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ReplicationStreamMessage(behavior: Int, behavior2: Option[Int], entries: Vector[SquadListing])

    behavior

    a required code that suggests the operations of the data in this packet

    behavior2

    an optional code that suggests the operations of the data in this packet; during initialization, this code is read; it typically flags an "update" action

    entries

    a Vector of the squad listings

Type Members

  1. type Packet = ReplicationStreamMessage

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val behavior: Int
  6. val behavior2: Option[Int]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def encode: Attempt[BitVector]
  9. val entries: Vector[SquadListing]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def opcode: GamePacketOpcode.Value
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Product

Inherited from Equals

Inherited from PlanetSideGamePacket

Inherited from PlanetSidePacket

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped