This is an old revision of the document!

Functions in scripts called by PtokaX on events

Function	Description
OnStartup()	Is called on script startup.
OnExit()	Is called on script exit.

—-

OnTimer(uTimerId)

Default function called by timer on given interval.

—-

UserConnected(tUser)	Is called when user finish login sequence.
UserDisconnected(tUser)	Is called when user disconnect or was disconnected.

—-

RegConnected(tUser)	Is called when reg finish login sequence.
RegDisconnected(tUser)	Is called when reg disconnect or was disconnected.

—-

OpConnected(tUser)	Is called when operator finish login sequence.
OpDisconnected(tUser)	Is called when operator disconnect or was disconnected.

—-

OnError(sErrorMsg)

Is called when error was found in script.

—-

SupportsArrival(tUser, sData)	Incoming Supports command from user.
ChatArrival(tUser, sData)	Incoming chat message from user. If script return true hub don't process data.
KeyArrival(tUser, sData)	Incoming Key command from user. It is called only when $Key is first command from client.
ValidateNickArrival(tUser, sData)	Incoming ValidateNick command from user.
PasswordArrival(tUser, sData)	Incoming Password command from user.
VersionArrival(tUser, sData)	Incoming Version command from user.
GetNickListArrival(tUser, sData)	Incoming GetNickList command from user.
MyINFOArrival(tUser, sData)	Incoming MyINFO command from user.
GetINFOArrival(tUser, sData)	Incoming GetINFO command from user.
SearchArrival(tUser, sData)	Incoming Search command from user. If script return true hub don't process data.
ToArrival(tUser, sData)	Incoming To (private message) command from user. If script return true hub don't process data.
ConnectToMeArrival(tUser, sData)	Incoming ConnectToMe (active connection request) command from user. If script return true hub don't process data.
MultiConnectToMeArrival(tUser, sData)	Incoming MultiConnectToMe (active connection request) command from user. If script return true hub don't process data.
RevConnectToMeArrival(tUser, sData)	Incoming RevConnectToMe (passive connection request) command from user. If script return true hub don't process data.
SRArrival(tUser, sData)	Incoming SR (search reply) command from user. If script return true hub don't process data.
UDPSRArrival(tUser, sData)	Incoming SR (search reply) command from user over hub UDP port. If script return true hub don't process data.
KickArrival(tUser, sData)	Incoming Kick command from user. If script return true hub don't process data.
OpForceMoveArrival(tUser, sData)	Incoming OpForceMove (redirect) command from user. If script return true hub don't process data.
UnknownArrival(tUser, sData)	Incoming unknown command from user. If script return true hub don't process data (don't disconnect user).
BotINFOArrival(tUser, sData)	Incoming BotINFO (pinger) command from user. If script return true hub don't process data.
CloseArrival(tUser, sData)	Incoming Close command from user. If script return true hub don't process data.