Packet Guide - Revision history

Exca: /* Variable Types */

2007-03-21T10:58:22Z

‎Variable Types

Exca: /* Variable Types */

2007-03-21T10:36:19Z

‎Variable Types

Snow at 03:42, 19 December 2006

2006-12-19T03:42:23Z

New page

==Packet Structure==

Each Page should have a STRUCT section, which gives the variable type and a variable name if known.

==Variable Types ==

{| class="wikitable"
|- align="center"
|'''TYPE'''||'''Example'''||'''Description'''
|-
|align="center" style="background:#B3C0DE; color:white;"|'''BYTE'''||align="center"|'''00'''||'''uint8''' -- 1 byte, mostly used for flags or small integer IDs
|-
|align="center" style="background:#6C86BF; color:white;"|'''SHORT'''||align="center"|'''00'''||'''uint16''' -- 2 bytes. Used for various data.
|-
|align="center" style="background:#3C548A; color:white;"|'''INT'''||align="center"|'''00'''||'''uint32''' -- 4 bytes. Used for various data.
|-
|align="center" style="background:#3C5466; color:white;"|'''FLOAT'''||align="center"|'''00'''||'''uint32''' -- 4 bytes. Floating point value. Used for various data.
|-
|align="center" style="background:#3C4565; color:white;"|'''LONG'''||align="center"|'''00'''||'''uint64''' -- 8 bytes. Used mostly for object IDs.
|-
|align="center" style="background:#D8F2E0; color:#3C4565;"|'''A_STRING'''||align="center"|'''00'''||'''ASCII String''' -- 2 byte Size, 1 byte characters.
|-
|align="center" style="background:#8BD9A3; color:white;"|'''U_STRING'''||align="center"|'''00'''||'''Unicode String''' -- 4 byte Size, 2 byte characters.
|-
|align="center" style="background:#3EC166; color:white;"|'''C_STRING'''||align="center"|'''00'''||'''Customization String''' -- 2 byte Size, see Customization String Format Below.
|-
|align="center" style="background:#25733D; color:white;"|'''B_STRING'''||align="center"|'''00'''||'''Byte String''' -- 4 bytes Size, 1 byte characters. Used only for session key.
|-
|align="center" style="background:#C6C600; color:white;"|'''{ }'''||align="center"|'''00'''||'''LIST component''' -- this is a sub section repeated as a list of data. Indent Variable types with 1 space.
|-
|align="center" style="background:#DF97A7; color:white;"|'''?'''||align="center"|'''00'''||'''Uncertin Variables''' -- Use a single question mark ? in the name to display uncertainty in the variables understanding.
|-
|align="center" style="background:#C84966; color:white;"|'''??'''||align="center"|'''00'''||'''Unknown Variable Names''' -- Use ?? or Unknown for the name to display that there is no clue as to what the data does.
|-
|}

==Additional Guidelines==

In Addition, each page should contain a section for Variable Descriptions should be made. This should include a brief, or detailed description as needed to document what the variable does and how it can be used. Also the Opperand_Count and Opcode should be listed with it.

Finally an Additional Info section should be provided to give more info in the case it is needed for that packet.

<pre>
= STRUCT =
{{{
SHORT: VarName
SHORT: 16bitVariable
INT: 32bitVariable
INT: LookAList
{
LONG: 64bitVariable
BYTE: 8bitVariable
BYTE: ??
}
A_STRING: AsciiString
U_STRING: UnicodeString
C_STRING: CustomizationString
}}}
----
= Variable Description =
{{{
OpperandCount = 9
Opcode = FFFFFFFF

AsciiString:
This variable is a string for the name.

64bitVariable:
This variable is an ID for that guy.

8bitVariable:
This byte is a flag for stuff.
}}}
----
= Notes =
{{{
Anything Additional Goes here.
}}}
</pre>

@@ Line 4: / Line 4: @@
 ==Variable Types ==
-{| class="wikitable"
+{{field types}}
-|-
-|{{bool}}||bool||'''bool''' (1byte, 0:false, other value:true)
-|-
-|{{sbyte}}||sbyte||'''sbyte''' (1byte, signed)
-|-
-|{{byte}}||byte||'''byte''' (1byte, unsigned)
-|-
-|{{short}}||short||'''short''' (2bytes, signed)
-|-
-|{{ushort}}||ushort||'''ushort''' (2bytes, unsigned)
-|-
-|{{int}}||int||'''int''' (4bytes, signed)
-|-
-|{{uint}}||uint||'''uint''' (4bytes, unsigned)
-|-
-|{{float}}||float||'''float''' (4bytes, signed)
-|-
-|{{long}}||long||'''long''' (8bytes, signed, mostly used for object ids)
-|-
-|{{ulong}}||ulong||'''ulong''' (8bytes, unsigned, mostly used for object ids)
-|-
-|{{double}}||double||'''double''' (8bytes, signed)
-|-
-|{{a_string}}||a_string||'''ANSI/ASCII String''' (1byte chars, ASCII:leading0+7bits, ANSI:8bits)
-|-
-|{{u_string}}||u_string||'''Unicode String''' (2bytes chars)
-|-
-|{{c_string}}||c_string||'''Customization String''' (2bytes size + 2bytes chars)
-|-
-|{{b_string}}||b_string||'''Byte String''' (4bytes size + 1byte chars, used for session key only)
-|-
-|{{list}}||list||'''LIST Component''' (this is a sub section repeated as a list of data. Indent Variable types with 1 space.)
-|-
-|{{uncertain}}||uncertain||'''Uncertain Values''' (use a single question mark ? in the name to display uncertainty in the variables understanding.)
-|-
-|{{unknown}}||unknown||'''Unknown Variable Name''' (use ?? or Unknown for the name to display that there is no clue as to what the data does.)
-|-
-|}
 ==Additional Guidelines==