Updated Lua Packet (markdown)

KimLS 2014-09-24 03:58:14 -07:00
parent 3bf23dd564
commit 6ca9570b5e

@ -1,34 +1,37 @@
Packet is a class exported to Lua that represents the EQApplicationPacket object from EQEmu.
[Return to the Lua API](Lua-API)
### Properties
```
packet.null -- Returns true if this object is null
packet.valid -- Returns true if this object is not null
```
### Member Functions
```
Packet() -- Creates a null spell
Packet(Integer opcode, Integer size)
Integer GetSize();
Integer GetOpcode();
Void SetOpcode(Integer op);
Void WriteInteger8(Integer offset, Integer value);
Void WriteInteger16(Integer offset, Integer value);
Void WriteInteger32(Integer offset, Integer value);
Void WriteInteger64(Integer offset, Integer value);
Void WriteFloat(Integer offset, Real value);
Void WriteDouble(Integer offset, Real value);
Void WriteString(Integer offset, String value);
Void WriteFixedLengthString(Integer offset, String value, Integer string_length);
Integer ReadInteger8(Integer offset);
Integer ReadInteger16(Integer offset);
Integer ReadInteger32(Integer offset);
Integer ReadInteger64(Integer offset);
Real ReadFloat(Integer offset);
Real ReadDouble(Integer offset);
String ReadString(Integer offset);
String ReadFixedLengthString(Integer offset, Integer string_length);
Packet is a class exported to Lua that represents the EQApplicationPacket object from EQEmu.
[Return to the Lua API](Lua-API)
### Properties
```
packet.null -- Returns true if this object is null
packet.valid -- Returns true if this object is not null
```
### Member Functions
```
Packet() -- Creates a null spell
Packet(Integer opcode, Integer size)
Packet(Integer opcode, Integer size, Boolean use_raw_opcode)
Integer GetSize();
Integer GetOpcode();
Void SetOpcode(Integer op);
Integer GetRawOpcode();
Void SetRawOpcode(Integer op);
Void WriteInteger8(Integer offset, Integer value);
Void WriteInteger16(Integer offset, Integer value);
Void WriteInteger32(Integer offset, Integer value);
Void WriteInteger64(Integer offset, Integer value);
Void WriteFloat(Integer offset, Real value);
Void WriteDouble(Integer offset, Real value);
Void WriteString(Integer offset, String value);
Void WriteFixedLengthString(Integer offset, String value, Integer string_length);
Integer ReadInteger8(Integer offset);
Integer ReadInteger16(Integer offset);
Integer ReadInteger32(Integer offset);
Integer ReadInteger64(Integer offset);
Real ReadFloat(Integer offset);
Real ReadDouble(Integer offset);
String ReadString(Integer offset);
String ReadFixedLengthString(Integer offset, Integer string_length);
```