Class/Object

net.psforever.packet.game.objectcreate

PlayerData

Related Docs: object PlayerData | package objectcreate

Permalink

final case class PlayerData(pos: Option[PlacementData], basic_appearance: CharacterAppearanceData, character_data: CharacterData, inventory: Option[InventoryData], drawn_slot: DrawnSlot.Value)(position_defined: Boolean) extends ConstructorData with Product with Serializable

A representation of another player's character for the ObjectCreateMessage packet. In general, this packet is used to describe other players.

Divisions exist to make the data more manageable. The first division defines the player's location within the game coordinate system. The second division defines features of the character that are shared by both the ObjectCreateDetailedMessage version of a controlled player character and the ObjectCreateMessage version of a player character (this). The third field provides further information on the appearance of the player character, albeit condensed. The fourth field involves the player's Equipment holsters and their inventory. The hand that the player has exposed is last. One of the most compact forms of a player character description is transcribed using this information.

The presence or absence of position data as the first division creates a cascading effect causing all of fields in the other two divisions to gain offset values. These offsets exist in the form of String and List padding.

pos

the optional position of the character in the world environment

basic_appearance

common fields regarding the the character's appearance

character_data

the class-specific data that explains about the character

inventory

the player's inventory; typically, only the tools and weapons in the equipment holster slots

drawn_slot

the holster that is initially drawn

position_defined

used by the Codec to seed the state of the optional pos field

Source
PlayerData.scala
See also

CharacterData
InventoryData
DrawnSlot

Linear Supertypes
Serializable, Serializable, Product, Equals, ConstructorData, StreamBitSize, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayerData
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ConstructorData
  7. StreamBitSize
  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 PlayerData(pos: Option[PlacementData], basic_appearance: CharacterAppearanceData, character_data: CharacterData, inventory: Option[InventoryData], drawn_slot: DrawnSlot.Value)(position_defined: Boolean)

    Permalink

    pos

    the optional position of the character in the world environment

    basic_appearance

    common fields regarding the the character's appearance

    character_data

    the class-specific data that explains about the character

    inventory

    the player's inventory; typically, only the tools and weapons in the equipment holster slots

    drawn_slot

    the holster that is initially drawn

    position_defined

    used by the Codec to seed the state of the optional pos field

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 PlayerData to any2stringadd[PlayerData] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PlayerData, B)

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

    Permalink

    common fields regarding the the character's appearance

  8. def bitsize: Long

    Permalink

    Performs a "sizeof()" analysis of the given object.

    The calculation reflects the scodec Codec definition rather than the explicit parameter fields.

    Performs a "sizeof()" analysis of the given object.

    The calculation reflects the scodec Codec definition rather than the explicit parameter fields. For example, a traditional Int is normally a 32-bit number, often rendered as a 32u number. When parsed with a uintL(7), it's length will be considered 7 bits (7u). (Note: being permanently signed, an scodec value of 32u or longer must fit into a Long type.)

    returns

    the number of bits necessary to measure an object of this class; defaults to 0L

    Definition Classes
    PlayerDataStreamBitSize
  9. val character_data: CharacterData

    Permalink

    the class-specific data that explains about the character

  10. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val drawn_slot: DrawnSlot.Value

    Permalink

    the holster that is initially drawn

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. val inventory: Option[InventoryData]

    Permalink

    the player's inventory; typically, only the tools and weapons in the equipment holster slots

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. val pos: Option[PlacementData]

    Permalink

    the optional position of the character in the world environment

  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. def [B](y: B): (PlayerData, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ConstructorData

Inherited from StreamBitSize

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PlayerData to any2stringadd[PlayerData]

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

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

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

Ungrouped