Palanthir Object Reference

OBJECT DESCRIPTION

Name: PACKET

Description:
Represents a packet object.
To create a packet use the newpacket function in the palanthir module.


Methods:

getasciistringgetlongwordgetwordsetasciistringsetbytesetunicodestring 
getbytegetunicodestringsendsetbytesetlongwordsetword 

Properties:

idlength         

OBJECT METHODS

getasciistring(pos, length)

- pos
Position within the packet to read

- length
Maximum length of the string

Return Value:
string


Back to top


getbyte(pos)

- pos
Position within the packet to read

Return Value:
uint8


Back to top
getlongword(pos)

- pos
Position within the packet to read

Return Value:
uint32


Back to top
getunicodestring(pos, length)

- pos
Position within the packet to read

- length
Maximum length of the string

Return Value:
string


Back to top
getword(pos)

- pos
Position within the packet to read

Return Value:
uint16


Back to top
send()

Description:
Sends the packet to the server.

Back to top
setasciistring(pos, value, length)

- pos
Position within the packet to write.

- value
Value to be set.

- length
Maximum length of the string.

Description:
Sets an ascii string within the packet.

Back to top
setbyte(pos, value)

- pos
Position within the packet to write.

- value
Value to set.

Description:
Sets an uint8 Integer within the packet.

Back to top
setbyte(pos, value)

- pos
Position within the packet to write.

- value
Value to set.

Description:
Sets an uint8 Integer within the packet.

Back to top
setlongword(pos, value)

- pos
Position within the packet to write.

- value
Value to set.

Description:
Sets an uint32 Integer within the packet.

Back to top
setunicodestring(pos, value, length)

- pos
Position within the packet to write.

- value
Value to be set.

- length
Maximum length of the string.

Description:
Sets an unicode string within the packet.

Back to top
setword(pos, value)

- pos
Position within the packet to write.

- value
Value to set.

Description:
Sets an uint16 Integer within the packet.

Back to top

OBJECT PROPERTIES


id

Description:
Id of the packet.

Back to top
length

Description:
Length of the packet.

Back to top

Back to the Object Overview
Back to the Palanthir Reference

Generated: 17.08.2006 20:26 | Version: Palanthir 243
© Varan | http://varan.uodev.de