Palanthir Library Reference

MODULE DESCRIPTION

Functions:

charconfiggetcustomvarsgetgumpcountlognewgumpregisterpackethandlersetshardname
closegetcvismeloginnewpacketreturntologinshardconfig
configgetgumpkeyboardmouseopenjournalsendpacketversion

MODULE FUNCTIONS

palanthir.charconfig()

Description:
Returns the player spezific configfile object.

Back to top


palanthir.close()

Description:
Closes the client.

Back to top
palanthir.config()

Description:
Returns the global configfile object.

Back to top
palanthir.getcustomvars()

Description:
Returns a dictionary to save variables in.

Back to top
palanthir.getcv()

Description:
Returns a dictionary to save variables in.

Back to top
palanthir.getgump(index)

- index
Index of the gump.

Return Value:
Returns a gump object.

Description:
Returns the gump at the given index in the internal gump list.

Back to top
palanthir.getgumpcount()

Return Value:
Returns the number of gumps in the internal gump list.


Back to top
palanthir.isme()

Description:
Returns true if selected shard is uome, otherwise false.

Back to top
palanthir.keyboard()

Description:
Returns a the keyboard object of the client.

Back to top
palanthir.log(text)

- text
The Text to write into the log.

Description:
Writes some text into the log.

Back to top
palanthir.login(login, password)

- login

- password

Description:
Sends a loginrequest to the server.

Back to top
palanthir.mouse()

Description:
Returns a the mouse object of the client.

Back to top
palanthir.newgump(x, y)

- x
X position of the new gump (optional).

- y
Y position of the new gump (optional).

Return Value:
Returns a gump object.

Description:
Creates a new gump object.

Back to top
palanthir.newpacket(id, length)

- id
Id of the Packet (first byte)

- length
Length of the Packet

Return Value:
Returns a packet object.

Description:
Creates a new packet object with given id and length.
Id does NOT set the second and third byte to packetlength, even if this packet is expected to have it there.

Back to top
palanthir.openjournal()

Description:
Opens the journal.

Back to top
palanthir.registerpackethandler(packetid, function)

- packetid

- function

Description:
Registers a function to be called when the client recieves a packet with the given packetid.

Back to top
palanthir.returntologin()

Description:
Disconnects from the server if connected and returns to the logingump.

Back to top
palanthir.sendpacket(Packet)

- Packet
A packet object.

Description:
Sends the packet to the server.

Back to top
palanthir.setshardname(name)

- name

Description:
Sets the internal shard name.

Back to top
palanthir.shardconfig()

Description:
Returns the shard spezific configfile object.

Back to top
palanthir.version()

Return Value:
Returns current version of Palanthir.


Back to top

Back to the Module Overview
Back to the Palanthir Reference

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