Class/Object

net.psforever.packet.game

ObjectCreateMessage

Related Docs: object ObjectCreateMessage | package game

Permalink

final case class ObjectCreateMessage(streamLength: Long, objectClass: Int, guid: PlanetSideGUID, parentInfo: Option[ObjectCreateMessageParent], data: ConstructorData) extends PlanetSideGamePacket with Product with Serializable

Communicate with the client that a certain object with certain properties is to be created. In general, ObjectCreateMessage and its counterpart ObjectCreateDetailedMessage should look similar.

ObjectCreateMessage is capable of creating every non-environmental object in the game through the use of encoding patterns. The objects produced by this packet generally do not always fully express all the complexities of the object class. With respect to a client's avatar, all of the items in his inventory are given thorough detail so that the client can account for their interaction. The "shallow" objects produced by this packet are not like that. They express only the essential information necessary for client interaction when the client interacts with them. For example, a weapon defined by this packet may not care internally what fire mode it is in or how much ammunition it has. Such a weapon is not in the client's player's holster or inventory. It is imperceptive information to which he would not currently have access. An 0x17 game object is, therefore, a game object with only the essential data exposed.

When interacting with an 0x17 game object, the server will swap back and forth between it and an 0x18 object. (Or it will be removed when it is placed somewhere a given client will no longer be able to see it.) The purpose of this conversion is to control network traffic and object agency. It is not necessary to keep track of all objects on every player on every client individually. This relates to the goal of this packet exposing only "essential data." One player does not need to know how much ammunition remains in a weapon belonging to another player normally. One player also does not need to know how much ammunition is used up when another player reloads their weapon. The only way the first player will know is when the weapon is transferred into his own inventory. All other clients are spared micromanagement of the hypothetical other player's weapon. Updated information is only made available when and where it is needed.

Knowing the object's type is necessary for proper parsing. If the object does not have encoding information or is unknown, it will not translate between byte data and a game object.

streamLength

the total length of the data that composes this packet in bits; exclude the opcode (1 byte) and end padding (0-7 bits); when encoding, it will be calculated automatically

objectClass

the code for the type of object being constructed; always an 11-bit LE value

guid

the GUID this object will be assigned

parentInfo

if defined, the relationship between this object and another object (its parent)

data

the data used to construct this type of object; on decoding, set to None if the process failed

Source
ObjectCreateMessage.scala
See also

ObjectCreateMessageParent

ObjectCreateDetailedMessage

Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjectCreateMessage
  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 ObjectCreateMessage(streamLength: Long, objectClass: Int, guid: PlanetSideGUID, parentInfo: Option[ObjectCreateMessageParent], data: ConstructorData)

    Permalink

    streamLength

    the total length of the data that composes this packet in bits; exclude the opcode (1 byte) and end padding (0-7 bits); when encoding, it will be calculated automatically

    objectClass

    the code for the type of object being constructed; always an 11-bit LE value

    guid

    the GUID this object will be assigned

    parentInfo

    if defined, the relationship between this object and another object (its parent)

    data

    the data used to construct this type of object; on decoding, set to None if the process failed

Type Members

  1. type Packet = ObjectCreateMessage

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

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

    Permalink

    the data used to construct this type of object; on decoding, set to None if the process failed

  9. def encode: Attempt[BitVector]

    Permalink
    Definition Classes
    ObjectCreateMessagePlanetSidePacket
  10. def ensuring(cond: (ObjectCreateMessage) ⇒ Boolean, msg: ⇒ Any): ObjectCreateMessage

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. val guid: PlanetSideGUID

    Permalink

    the GUID this object will be assigned

  19. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. val objectClass: Int

    Permalink

    the code for the type of object being constructed; always an 11-bit LE value

  24. def opcode: GamePacketOpcode.Value

    Permalink
  25. val parentInfo: Option[ObjectCreateMessageParent]

    Permalink

    if defined, the relationship between this object and another object (its parent)

  26. val streamLength: Long

    Permalink

    the total length of the data that composes this packet in bits; exclude the opcode (1 byte) and end padding (0-7 bits); when encoding, it will be calculated automatically

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

    Permalink
    Definition Classes
    AnyRef
  28. final def wait(): Unit

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

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

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

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

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

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

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

Ungrouped