FavoritesMessage

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: the type of exo-suit, if an Infantry loadout

Source: FavoritesMessage.scala

Linear Supertypes

Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any

Instance Constructors

new FavoritesMessage(list: types.LoadoutType.Value, player_guid: PlanetSideGUID, line: Int, label: String, armor: 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
the type of exo-suit, if an Infantry loadout

Type Members

type Packet = FavoritesMessage

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from FavoritesMessage to any2stringadd[FavoritesMessage] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (FavoritesMessage, B)

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

Definition Classes
AnyRef → Any
val armor: Option[Int]

the type of exo-suit, if an Infantry loadout
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
FavoritesMessage → PlanetSidePacket
def ensuring(cond: (FavoritesMessage) ⇒ Boolean, msg: ⇒ Any): FavoritesMessage

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

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

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

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

Definition Classes
AnyRef
def finalize(): Unit

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

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

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

Definition Classes
Any
val label: String

the identifier for this entry
val line: Int

the zero-indexed line number of this entry in its list
val list: types.LoadoutType.Value

the destination list
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def opcode: GamePacketOpcode.Value

Definition Classes
FavoritesMessage → PlanetSideGamePacket → PlanetSidePacket
val player_guid: PlanetSideGUID

the player
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (FavoritesMessage, B)

Implicit information
This member is added by an implicit conversion from FavoritesMessage to ArrowAssoc[FavoritesMessage] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object FavoritesMessage | package game

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

Instance Constructors

new FavoritesMessage(list: types.LoadoutType.Value, player_guid: PlanetSideGUID, line: Int, label: String, armor: Option[Int])

Type Members

type Packet = FavoritesMessage

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (FavoritesMessage, B)

final def ==(arg0: Any): Boolean

val armor: Option[Int]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def encode: Attempt[BitVector]

def ensuring(cond: (FavoritesMessage) ⇒ Boolean, msg: ⇒ Any): FavoritesMessage

def ensuring(cond: (FavoritesMessage) ⇒ Boolean): FavoritesMessage

def ensuring(cond: Boolean, msg: ⇒ Any): FavoritesMessage

def ensuring(cond: Boolean): FavoritesMessage

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val label: String

val line: Int

val list: types.LoadoutType.Value

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def opcode: GamePacketOpcode.Value

val player_guid: PlanetSideGUID

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

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (FavoritesMessage, B)

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 FavoritesMessage to any2stringadd[FavoritesMessage]

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

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

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

Ungrouped