Class/Object

net.psforever.packet.game

ObjectCreateDetailedMessage

Related Docs: object ObjectCreateDetailedMessage | package game

Permalink

final case class ObjectCreateDetailedMessage(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.

In normal packet data order, the parent object is specified before the actual object is specified. This is most likely a method of early correction. "Does this parent object exist?" "Is this new object something that can be attached to this parent?" "Does the parent have the appropriate attachment slot?" There is no fail-safe method for any of these circumstances being false, however, and the object will simply not be created. In instance where the parent data does not exist, the object-specific data is immediately encountered.

The object's GUID is assigned by the server. The clients are required to adhere to this new GUID referring to the object. There is no fail-safe for a conflict between what the server thinks is a new GUID and what any client thinks is an already-assigned GUID. Likewise, there is no fail-safe between a client failing or refusing to create an object and the server thinking an object has been created. (The GM-level command /sync tests for objects that "do not match" between the server and the client. It's implementation and scope are undefined.)

Knowing the object's type is essential for parsing the specific information passed by the data parameter. 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, excluding the opcode and end padding

objectClass

the code for the type of object being constructed

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
ObjectCreateDetailedMessage.scala
Linear Supertypes
Product, Equals, PlanetSideGamePacket, PlanetSidePacket, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObjectCreateDetailedMessage
  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 ObjectCreateDetailedMessage(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, excluding the opcode and end padding

    objectClass

    the code for the type of object being constructed

    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 = ObjectCreateDetailedMessage

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ObjectCreateDetailedMessage to ArrowAssoc[ObjectCreateDetailedMessage] 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
  10. def ensuring(cond: (ObjectCreateDetailedMessage) ⇒ Boolean, msg: ⇒ Any): ObjectCreateDetailedMessage

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ObjectCreateDetailedMessage to Ensuring[ObjectCreateDetailedMessage] 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 ObjectCreateDetailedMessage to StringFormat[ObjectCreateDetailedMessage] 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

  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, excluding the opcode and end padding

  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): (ObjectCreateDetailedMessage, B)

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

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

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

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

Ungrouped