Packages

final case class FavoritesMessage(list: types.LoadoutType.Value, player_guid: PlanetSideGUID, line: Int, label: String, armor_type: Option[Int]) extends PlanetSideGamePacket with Product with Serializable

Load the designator for an entry in the player's favorites list.

This entry defines a user-defined loadout label that appears on a "Favorites" tab list and can be selected. A subsequent server request - ItemTransactionMessage - must be made to retrieve the said loadout contents. Multiple separated favorites lists are present in the game. All entries are prepended with their destination list which indicates how from how that list is viewable. Different lists also have different numbers of available lines to store loadout entries.

Infantry equipment favorites are appended with a code for the type of exo-suit that they will load on a player. This does not match the same two field numbering system as in ArmorChangedMessage packets.

Armors:
1 - Agile
2 - Reinforced
4 - AA MAX
5 - AI MAX
6 - AV MAX

Exploration:
There are three unaccounted exo-suit indices - 0, 3, and 7; and, there are two specific kinds of exo-suit that are not defined - Infiltration and Standard. It is possible that one of the indices also defines the generic MAX (see ArmorChangedMessage). Which exo-suit is associated with which index?

list

the destination list

player_guid

the player

line

the zero-indexed line number of this entry in its list

label

the identifier for this entry

armor_type

the type of exo-suit, if an Infantry loadout; the type of battleframe, if a Battleframe loadout; None, if just a Vehicle loadout

Source
FavoritesMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FavoritesMessage
  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 FavoritesMessage(list: types.LoadoutType.Value, player_guid: PlanetSideGUID, line: Int, label: String, armor_type: Option[Int])

    list

    the destination list

    player_guid

    the player

    line

    the zero-indexed line number of this entry in its list

    label

    the identifier for this entry

    armor_type

    the type of exo-suit, if an Infantry loadout; the type of battleframe, if a Battleframe loadout; None, if just a Vehicle loadout

Type Members

  1. type Packet = FavoritesMessage

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. val armor_type: Option[Int]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def encode: Attempt[BitVector]
    Definition Classes
    FavoritesMessage → PlanetSidePacket
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val label: String
  13. val line: Int
  14. val list: types.LoadoutType.Value
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def opcode: GamePacketOpcode.Value
    Definition Classes
    FavoritesMessage → PlanetSideGamePacket → PlanetSidePacket
  19. val player_guid: PlanetSideGUID
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. 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