====== 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([[luaapi:user_table|tUser]]) | Is called when user finish login sequence. When true is returned then hub don't send it to next scripts.|
|UserDisconnected([[luaapi:user_table|tUser]]) | Is called when user disconnect or was disconnected.|
| | |
|RegConnected([[luaapi:user_table|tUser]]) | Is called when reg finish login sequence. When true is returned then hub don't send it to next scripts.|
|RegDisconnected([[luaapi:user_table|tUser]]) | Is called when reg disconnect or was disconnected.|
| | |
|OpConnected([[luaapi:user_table|tUser]]) | Is called when operator finish login sequence. When true is returned then hub don't send it to next scripts.|
|OpDisconnected([[luaapi:user_table|tUser]]) | Is called when operator disconnect or was disconnected.|
| | |
|OnError(sErrorMsg) | Is called when error was found in script.|
| | |
|SupportsArrival([[luaapi:user_table|tUser]], sData) | Incoming Supports command from user.|
|ChatArrival([[luaapi:user_table|tUser]], sData) | Incoming chat message from user. If script return true hub don't process data.|
|KeyArrival([[luaapi:user_table|tUser]], sData) | Incoming Key command from user. It is called only when $Key is first command from client.|
|ValidateNickArrival([[luaapi:user_table|tUser]], sData) | Incoming ValidateNick command from user.|
|PasswordArrival([[luaapi:user_table|tUser]], sData) | Incoming Password command from user.|
|VersionArrival([[luaapi:user_table|tUser]], sData) | Incoming Version command from user.|
|GetNickListArrival([[luaapi:user_table|tUser]], sData) | Incoming GetNickList command from user.|
|MyINFOArrival([[luaapi:user_table|tUser]], sData) | Incoming MyINFO command from user.|
|GetINFOArrival([[luaapi:user_table|tUser]], sData) | Incoming GetINFO command  from user.|
|SearchArrival([[luaapi:user_table|tUser]], sData) | Incoming Search command  from user. If script return true hub don't process data.|
|ToArrival([[luaapi:user_table|tUser]], sData) | Incoming To (private message) command from user. If script return true hub don't process data.|
|ConnectToMeArrival([[luaapi:user_table|tUser]], sData) | Incoming ConnectToMe (active connection request) command from user. If script return true hub don't process data.|
|MultiConnectToMeArrival([[luaapi:user_table|tUser]], sData) | Incoming MultiConnectToMe (active connection request) command from user. If script return true hub don't process data.|
|RevConnectToMeArrival([[luaapi:user_table|tUser]], sData) | Incoming RevConnectToMe (passive connection request) command from user. If script return true hub don't process data.|
|SRArrival([[luaapi:user_table|tUser]], sData) | Incoming SR (search reply) command from user. If script return true hub don't process data.|
|UDPSRArrival([[luaapi:user_table|tUser]], sData) | Incoming SR (search reply) command from user over hub UDP port. If script return true hub don't process data.|
|KickArrival([[luaapi:user_table|tUser]], sData) | Incoming Kick command from user. If script return true hub don't process data.|
|OpForceMoveArrival([[luaapi:user_table|tUser]], sData) | Incoming OpForceMove (redirect) command from user. If script return true hub don't process data.|
|UnknownArrival([[luaapi:user_table|tUser]], sData) | Incoming unknown command from user. If script return true hub don't process data (don't disconnect user).|
|BotINFOArrival([[luaapi:user_table|tUser]], sData) | Incoming BotINFO (pinger) command from user. If script return true hub don't process data.|
|CloseArrival([[luaapi:user_table|tUser]], sData) | Incoming Close command from user. If script return true hub don't process data.|