Class/Object

net.psforever.packet.game

DisplayedAwardMessage

Related Docs: object DisplayedAwardMessage | package game

Permalink

final case class DisplayedAwardMessage(player_guid: PlanetSideGUID, ribbon: types.MeritCommendation.Value = MeritCommendation.None, bar: RibbonBarsSlot.Value = RibbonBarsSlot.TermOfService) extends PlanetSideGamePacket with Product with Serializable

Dispatched to configure a player's merit commendation ribbons.

Normally, this packet is dispatched by the client when managing merit commendations through the "Character Info/Achievements" tab. On Gemini Live, this packet was also always dispatched once by the server during character login. It set the term of service ribbon explicitly. Generally, this was unnecessary, as the encoded character data maintains information about displayed ribbons. This behavior was probably a routine that ensured that correct yearly progression was tracked if the player earned it while offline. It never set any of the other ribbon slot positions during login.

A specific ribbon may only be set once to one slot. The last set slot is considered the valid position to which that ribbon will be placed/moved.

player_guid

the player

ribbon

the award to be displayed; defaults to MeritCommendation.None; use MeritCommendation.None when indicating "no ribbon"

bar

any of the four positions where the award ribbon is to be displayed; defaults to TermOfService

Source
DisplayedAwardMessage.scala
See also

MeritCommendation

RibbonBars

Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DisplayedAwardMessage
  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 DisplayedAwardMessage(player_guid: PlanetSideGUID, ribbon: types.MeritCommendation.Value = MeritCommendation.None, bar: RibbonBarsSlot.Value = RibbonBarsSlot.TermOfService)

    Permalink

    player_guid

    the player

    ribbon

    the award to be displayed; defaults to MeritCommendation.None; use MeritCommendation.None when indicating "no ribbon"

    bar

    any of the four positions where the award ribbon is to be displayed; defaults to TermOfService

Type Members

  1. type Packet = DisplayedAwardMessage

    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 DisplayedAwardMessage to any2stringadd[DisplayedAwardMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (DisplayedAwardMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DisplayedAwardMessage to ArrowAssoc[DisplayedAwardMessage] 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. val bar: RibbonBarsSlot.Value

    Permalink

    any of the four positions where the award ribbon is to be displayed; defaults to TermOfService

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    DisplayedAwardMessage → PlanetSidePacket

  10. def ensuring(cond: (DisplayedAwardMessage) ⇒ Boolean, msg: ⇒ Any): DisplayedAwardMessage

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

  11. def ensuring(cond: (DisplayedAwardMessage) ⇒ Boolean): DisplayedAwardMessage

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

  12. def ensuring(cond: Boolean, msg: ⇒ Any): DisplayedAwardMessage

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

  13. def ensuring(cond: Boolean): DisplayedAwardMessage

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

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from DisplayedAwardMessage to StringFormat[DisplayedAwardMessage] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def opcode: GamePacketOpcode.Value

    Permalink
    Definition Classes
    DisplayedAwardMessage → PlanetSideGamePacket → PlanetSidePacket

  23. val player_guid: PlanetSideGUID

    Permalink

    the player

  24. val ribbon: types.MeritCommendation.Value

    Permalink

    the award to be displayed; defaults to MeritCommendation.None; use MeritCommendation.None when indicating "no ribbon"

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

    Permalink
    Definition Classes
    AnyRef

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (DisplayedAwardMessage, B)

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

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

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

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

Ungrouped