Class/Object

net.psforever.packet.game.objectcreate

CharacterData

Related Docs: object CharacterData | package objectcreate

Permalink

final case class CharacterData(health: Int, armor: Int, uniform_upgrade: UniformStyle.Value, unk: Int, command_rank: Int, implant_effects: List[ImplantEffects.Value], cosmetics: Option[Cosmetics])(is_backpack: Boolean, is_seated: Boolean) extends ConstructorData with Product with Serializable

A representation of a portion of an avatar's ObjectCreateDetailedMessage packet data.

This information outlines most of the specifics required to depict some other player's character. Someone else decides how that character is behaving and the server tells each client how to depict that behavior. For that reason, the character is mostly for presentation purposes, rather than really being fleshed-out. Of the inventory for this character, only the initial five weapon slots are defined. In the "backend of the client," the character produced by this data is no different from the kind of character that could be declared a given player's avatar. In terms of equipment and complicated features common to an avatar character, however, any user would find this character ill-equipped.

health

the amount of health the player has, as a percentage of a filled bar; the bar has 85 states, with 3 points for each state; when 0% (less than 3 of 255), the player will collapse into a death pose on the ground; while is_backpack == true, health will always report as 0; while is_seated == true, health will (try to) report as 100

armor

the amount of armor the player has, as a percentage of a filled bar; the bar has 85 states, with 3 points for each state; while is_seated == true, armor will always report as 0

uniform_upgrade

the level of upgrade to apply to the player's base uniform

command_rank

the player's command rank as a number from 0 to 5; cosmetic armor associated with the command rank will be applied automatically

implant_effects

the effects of implants that can be seen on a player's character; the number of entries equates to the number of effects applied; the maximu number of effects is three

cosmetics

optional decorative features that are added to the player's head model by console/chat commands; they become available at battle rank 24, but here they require the third uniform upgrade (rank 25); these flags do not exist if they are not applicable

is_backpack

this player character should be depicted as a corpse; corpses are either coffins (defunct), backpacks (normal), or a pastry (festive); the alternate model bit should be flipped

is_seated

this player character is seated in a vehicle or mounted to some other object; alternate format for data parsing applies

Source
CharacterData.scala
See also

Cosmetics

DetailedCharacterData

Linear Supertypes
Serializable, Serializable, Product, Equals, ConstructorData, StreamBitSize, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CharacterData
  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 CharacterData(health: Int, armor: Int, uniform_upgrade: UniformStyle.Value, unk: Int, command_rank: Int, implant_effects: List[ImplantEffects.Value], cosmetics: Option[Cosmetics])(is_backpack: Boolean, is_seated: Boolean)

    Permalink

    health

    the amount of health the player has, as a percentage of a filled bar; the bar has 85 states, with 3 points for each state; when 0% (less than 3 of 255), the player will collapse into a death pose on the ground; while is_backpack == true, health will always report as 0; while is_seated == true, health will (try to) report as 100

    armor

    the amount of armor the player has, as a percentage of a filled bar; the bar has 85 states, with 3 points for each state; while is_seated == true, armor will always report as 0

    uniform_upgrade

    the level of upgrade to apply to the player's base uniform

    command_rank

    the player's command rank as a number from 0 to 5; cosmetic armor associated with the command rank will be applied automatically

    implant_effects

    the effects of implants that can be seen on a player's character; the number of entries equates to the number of effects applied; the maximu number of effects is three

    cosmetics

    optional decorative features that are added to the player's head model by console/chat commands; they become available at battle rank 24, but here they require the third uniform upgrade (rank 25); these flags do not exist if they are not applicable

    is_backpack

    this player character should be depicted as a corpse; corpses are either coffins (defunct), backpacks (normal), or a pastry (festive); the alternate model bit should be flipped

    is_seated

    this player character is seated in a vehicle or mounted to some other object; alternate format for data parsing applies

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. val armor: Int

    Permalink

    the amount of armor the player has, as a percentage of a filled bar; the bar has 85 states, with 3 points for each state; while is_seated == true, armor will always report as 0

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  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
    CharacterDataStreamBitSize
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val command_rank: Int

    Permalink

    the player's command rank as a number from 0 to 5; cosmetic armor associated with the command rank will be applied automatically

  11. val cosmetics: Option[Cosmetics]

    Permalink

    optional decorative features that are added to the player's head model by console/chat commands; they become available at battle rank 24, but here they require the third uniform upgrade (rank 25); these flags do not exist if they are not applicable

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from CharacterData to Ensuring[CharacterData] 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 CharacterData to StringFormat[CharacterData] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. val health: Int

    Permalink

    the amount of health the player has, as a percentage of a filled bar; the bar has 85 states, with 3 points for each state; when 0% (less than 3 of 255), the player will collapse into a death pose on the ground; while is_backpack == true, health will always report as 0; while is_seated == true, health will (try to) report as 100

  21. val implant_effects: List[ImplantEffects.Value]

    Permalink

    the effects of implants that can be seen on a player's character; the number of entries equates to the number of effects applied; the maximu number of effects is three

  22. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. val uniform_upgrade: UniformStyle.Value

    Permalink

    the level of upgrade to apply to the player's base uniform

  28. val unk: Int

    Permalink
  29. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (CharacterData, B)

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

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

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

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

Ungrouped