ObjectCreateBase

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. val baseCodec: Codec[basePattern]

   

   Codec for handling the primary fields of both ObjectCreateMessage packets and ObjectCreateDetailedMessage packets.

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. def decodeData(objectClass: Int, data: BitVector, getCodecFunc: (Int) ⇒ Codec[ConstructorData]): Attempt[ConstructorData]

   

   Take bit data and transform it into an object that expresses the important information of a game piece.

   Take bit data and transform it into an object that expresses the important information of a game piece. This function is fail-safe because it catches errors involving bad parsing of the bitstream data. Generally, the Exception messages themselves are not useful here. The important parts are what the packet thought the object class should be and what it actually processed.

   objectClass

   the code for the type of object being constructed

   data

   the bitstream data

   getCodecFunc

   a lookup function that returns a Codec for this object class

   returns

   the optional constructed object

   See also

   ObjectClass

8. def encodeData(objectClass: Int, obj: ConstructorData, getCodecFunc: (Int) ⇒ Codec[ConstructorData]): Attempt[BitVector]

   

   Take the important information of a game piece and transform it into bit data.

   Take the important information of a game piece and transform it into bit data. This function is fail-safe because it catches errors involving bad parsing of the object data. Generally, the Exception messages themselves are not useful here.

   objectClass

   the code for the type of object being deconstructed

   obj

   the object data

   getCodecFunc

   a lookup function that returns a Codec for this object class

   returns

   the bitstream data

   See also

   ObjectClass

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

   

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

13. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

14. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

15. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

16. final def notify(): Unit

    

    Definition Classes

    AnyRef

17. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

18. def streamLen(parentInfo: Option[ObjectCreateMessageParent], data: StreamBitSize): Long

    

    Calculate the stream length in number of bits by factoring in the whole message in two portions.

    Calculate the stream length in number of bits by factoring in the whole message in two portions. This process automates for: object encoding.
    
    Ignoring the parent data, constant field lengths have already been factored into the results. That includes: the length of the stream length field (32u), the object's class (11u), the object's GUID (16u), and the bit to determine if there will be parent data. In total, these fields form a known fixed length of 60u.

    parentInfo

    if defined, the relationship between this object and another object (its parent); information about the parent adds either 24u or 32u

    data

    if defined, the data used to construct this type of object; the data length is indeterminate until it is walked-through; note: the type is StreamBitSize as opposed to ConstructorData

    returns

    the total length of the resulting data stream in bits

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

    

    Definition Classes

    AnyRef

20. def toString(): String

    

    Definition Classes

    AnyRef → Any

21. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )