Class/Object

net.psforever.packet.game

LoginRespMessage

Related Docs: object LoginRespMessage | package game

Permalink

final case class LoginRespMessage(token: String, error: Type, stationError: Type, subscriptionStatus: Type, unkUIRelated: Long, username: String, privilege: Long) extends PlanetSideGamePacket with Product with Serializable

This message is sent from the server to the client upon reception of a LoginMessage.

The result of the login is contained in this message. When a login is successful, a session token is returned to the client which then forwards this to the World server it chooses to connect to.

In terms of failed logins, the PS client favors errors in this order

1. LoginError 2. StationError 3. StationSubscriptionStatus

Don't try and set more than one error at the same time. Just provide a single error message to be displayed.

token

A 'token' which acts exactly like a session cookie in a browser. Allows logins to not use a password

error

A general login error message

stationError

A PlanetSide Sony Online Entertainment (SOE) station result

subscriptionStatus

A response detailing the current subscription type

unkUIRelated

An unknown possible bitfield that controls some game variables (possibly expansions?)

username

The login username

privilege

If set above 10000, then the user has access to GM commands. Not sure of other values.

Source
LoginRespMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LoginRespMessage
  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 LoginRespMessage(token: String, error: Type, stationError: Type, subscriptionStatus: Type, unkUIRelated: Long, username: String, privilege: Long)

    Permalink

    token

    A 'token' which acts exactly like a session cookie in a browser. Allows logins to not use a password

    error

    A general login error message

    stationError

    A PlanetSide Sony Online Entertainment (SOE) station result

    subscriptionStatus

    A response detailing the current subscription type

    unkUIRelated

    An unknown possible bitfield that controls some game variables (possibly expansions?)

    username

    The login username

    privilege

    If set above 10000, then the user has access to GM commands. Not sure of other values.

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from LoginRespMessage to ArrowAssoc[LoginRespMessage] 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. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    LoginRespMessage → PlanetSidePacket

  9. def ensuring(cond: (LoginRespMessage) ⇒ Boolean, msg: ⇒ Any): LoginRespMessage

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

  10. def ensuring(cond: (LoginRespMessage) ⇒ Boolean): LoginRespMessage

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): LoginRespMessage

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

  12. def ensuring(cond: Boolean): LoginRespMessage

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

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

    Permalink
    Definition Classes
    AnyRef

  14. val error: Type

    Permalink

    A general login error message

  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 LoginRespMessage to StringFormat[LoginRespMessage] 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
    LoginRespMessage → PlanetSideGamePacket → PlanetSidePacket

  23. val privilege: Long

    Permalink

    If set above 10000, then the user has access to GM commands.

    If set above 10000, then the user has access to GM commands. Not sure of other values.

  24. val stationError: Type

    Permalink

    A PlanetSide Sony Online Entertainment (SOE) station result

  25. val subscriptionStatus: Type

    Permalink

    A response detailing the current subscription type

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

    Permalink
    Definition Classes
    AnyRef

  27. val token: String

    Permalink

    A 'token' which acts exactly like a session cookie in a browser.

    A 'token' which acts exactly like a session cookie in a browser. Allows logins to not use a password

  28. val unkUIRelated: Long

    Permalink

    An unknown possible bitfield that controls some game variables (possibly expansions?)

  29. val username: String

    Permalink

    The login username

  30. final def wait(): Unit

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

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

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

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

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

  33. def →[B](y: B): (LoginRespMessage, B)

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

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

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

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

Ungrouped