Class/Object

net.psforever.packet.game

ChatMsg

Related Docs: object ChatMsg | package game

Permalink

final case class ChatMsg(messageType: types.ChatMessageType.Value, wideContents: Boolean, recipient: String, contents: String, note: Option[String]) extends PlanetSideGamePacket with Product with Serializable

Instructs client to display and/or process a chat message/command when sent server to client. Instructs server to route and/or process a chat message/command when sent client to server.

messageType

the type of the chat message (CMT)

wideContents

whether the contents contains wide characters or not. This is required because Java/Scala have one String type with a charset of UTF-16. Therefore, there is no way at runtime to determine the charset of String.

recipient

identifies the recipient of the message, such as in a tell (occasionally used as "sender" instead i.e. /note)

contents

the textual contents of the message

note

only used when the message is of note type

Source
ChatMsg.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChatMsg
  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 ChatMsg(messageType: types.ChatMessageType.Value, wideContents: Boolean, recipient: String, contents: String, note: Option[String])

    Permalink

    messageType

    the type of the chat message (CMT)

    wideContents

    whether the contents contains wide characters or not. This is required because Java/Scala have one String type with a charset of UTF-16. Therefore, there is no way at runtime to determine the charset of String.

    recipient

    identifies the recipient of the message, such as in a tell (occasionally used as "sender" instead i.e. /note)

    contents

    the textual contents of the message

    note

    only used when the message is of note type

Type Members

  1. type Packet = ChatMsg

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ChatMsg to ArrowAssoc[ChatMsg] 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. def clone(): AnyRef

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

  8. val contents: String

    Permalink

    the textual contents of the message

  9. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    ChatMsg → PlanetSidePacket

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

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

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

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

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

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

  13. def ensuring(cond: Boolean): ChatMsg

    Permalink
    Implicit information
    This member is added by an implicit conversion from ChatMsg to Ensuring[ChatMsg] 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 ChatMsg to StringFormat[ChatMsg] 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. val messageType: types.ChatMessageType.Value

    Permalink

    the type of the chat message (CMT)

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

    Permalink
    Definition Classes
    AnyRef

  21. val note: Option[String]

    Permalink

    only used when the message is of note type

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. def opcode: GamePacketOpcode.Value

    Permalink
    Definition Classes
    ChatMsg → PlanetSideGamePacket → PlanetSidePacket

  25. val recipient: String

    Permalink

    identifies the recipient of the message, such as in a tell (occasionally used as "sender" instead i.e.

    identifies the recipient of the message, such as in a tell (occasionally used as "sender" instead i.e. /note)

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

    Permalink
    Definition Classes
    AnyRef

  27. final def wait(): Unit

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

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

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

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

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

  30. val wideContents: Boolean

    Permalink

    whether the contents contains wide characters or not.

    whether the contents contains wide characters or not. This is required because Java/Scala have one String type with a charset of UTF-16. Therefore, there is no way at runtime to determine the charset of String.

  31. def →[B](y: B): (ChatMsg, B)

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

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

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

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

Ungrouped