PacketLogger.FieldType

Type of Fields available for FieldTemplate Example of "Damage" (0x0B) packet: { 'packetID': 0x0B, 'name': 'Damage 0x0B', 'showHexDump': true, 'fields':[ { 'name':'packetID', 'length':1, 'type':'packetID'}, { 'name':'Serial', 'length':4, 'type':'serial'}, { 'name':'Damage', 'length': 2, 'type':'int'}, ] }

Table of Contents

Properties

BOOL

Syntax: PacketLogger.FieldType.BOOL
Returns: String

Boolean type, length is fixed to 1 byte. Example: {'name':'Paralized', 'type':'bool'}

DUMP

Syntax: PacketLogger.FieldType.DUMP
Returns: String

Dump a certain amount of data as raw bytes-by-bytes HEX Length is mandatory. Example: {'name':'unused', 'type':'dump', 'length': 40}

FIELDS

Syntax: PacketLogger.FieldType.FIELDS
Returns: String

A special field which has subfields, useful for displaying stucts. 'length' is ignored, 'type' is optional, 'fields' is mandatory. Example: {'name':'Player Position', 'type':'fields', 'fields':[ {'name':'X', 'type':'uint', 'length': 2} {'name':'Y', 'type':'uint', 'length': 2} {'name':'Z', 'type':'uint', 'length': 1} ] }

FIELDSFOR

Syntax: PacketLogger.FieldType.FIELDSFOR
Returns: String

HEX

Syntax: PacketLogger.FieldType.HEX
Returns: String

Hex type is equivalent to unsigned integers but the contents is displayed as 0x hex. Length is mandatory and can range between 1 and 4 bytes. Example: {'name':'Hue', 'type':'hex', 'length': 2}

INT

Syntax: PacketLogger.FieldType.INT
Returns: String

Integers type used for positive and negative integers. Length is mandatory and can range between 1 and 4 bytes. Example: {'name':'Z Level', 'type':'int', 'length': 2}

MODELID

Syntax: PacketLogger.FieldType.MODELID
Returns: String

ModelID type like Item.ItemdID, Mobile.Body, etc. Length is fixed to 2 bytes and is displayed as 0x hex. Example: {'name':'Item ID', 'type':'modelID'} {'name':'Mobile Body', 'type':'modelID'} {'name':'Static ID', 'type':'modelID'}

PACKETID

Syntax: PacketLogger.FieldType.PACKETID
Returns: String

Common type present in every packet, packetID, length is fixed to 1 byte. Example: {'name':'packetID', 'type':'packetID'}

SERIAL

Syntax: PacketLogger.FieldType.SERIAL
Returns: String

Serial type, length is fixed to 4 bytes and is displayed as 0x hex. Example: {'name':'Target Serial', 'type':'serial'}

SKIP

Syntax: PacketLogger.FieldType.SKIP
Returns: String

Skip a certain amount of data. Length is mandatory. Example: {'name':'unused', 'type':'skip', 'length': 40}

SUBPACKET

Syntax: PacketLogger.FieldType.SUBPACKET
Returns: String

A special field which denotes the beginning of a subpacket. 'length' is ignored, 'type' is optional, 'subpacket' is mandatory. Example: {'name':'action', 'type':'subpacket', 'subpacket':{ 'name':'my subpacket' 'fields':[ ... ] } }

TEXT

Syntax: PacketLogger.FieldType.TEXT
Returns: String

Text reads bytes as text. Length is mandatory. Example: {'name':'Name', 'type':'text', 'length': 20}

UINT

Syntax: PacketLogger.FieldType.UINT
Returns: String

Unsigned integers type used for positive integers. Length is mandatory and can range between 1 and 4 bytes. Example: {'name':'Z Level', 'type':'uint', 'length': 2}

UTF8

Syntax: PacketLogger.FieldType.UTF8
Returns: String

Text reads bytes as UTF8 text. Length is mandatory. Example: {'name':'Pet name', 'type':'utf8', 'length': 40}

VALID_TYPES

Syntax: PacketLogger.FieldType.VALID_TYPES
Returns: String[]

List of valid types

Methods

IsValid

Syntax: PacketLogger.FieldType.IsValid(typename)

Check if the name of type is a valid Template filed type.

Parameters:
  • typename (String): Name of the types
Returns: Boolean