Hub (server) for Direct Connect http://wiki.ptokax.org/ 2026-04-29T21:09:06+00:00 http://wiki.ptokax.org/ http://wiki.ptokax.org/lib/exe/fetch.php?media=wiki:logo.png text/html 2012-10-28T00:07:51+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:ban_table&rev=1351382871&do=diff Ban table Value Description sIPIP or nil when ban don't have ip.sNickNick or nil when ban don't have nick.sReasonReason or nil when ban don't have reason.sByNick of operator who create ban or nil when ban don't have it. iExpireTimeSeconds from 1.1.1970 or nil when ban is perm ban. text/html 2015-02-20T14:09:43+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:profile_permissions_ids&rev=1424441383&do=diff Profile permissions identificators Identificator Description ProfMan.tPermissions.IsOperatorUser have key / is OPProfMan.tPermissions.NoDefloodGetnicklistNo GetNickList DefloodProfMan.tPermissions.NoDefloodMyinfoNo MyINFO DefloodProfMan.tPermissions.NoDefloodSearch text/html 2012-10-14T04:48:54+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:profile_permissions_table&rev=1350190134&do=diff Profile permissions table Value Description bIsOPUser have key / is OP.bNoDefloodGetNickListNo GetNickList Deflood.bNoDefloodNMyINFONo MyINFO Deflood.bNoDefloodSearchNo Search Deflood.bNoDefloodPMNo PM Deflood.bNoDefloodMainChatNo Main Chat Deflood. text/html 2012-10-14T04:45:38+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:profile_table&rev=1350189938&do=diff Profile table Value Description sProfileNameName of profile.iProfileNumberProfile number.tProfilePermissionsProfile permissions table. text/html 2012-12-11T22:53:41+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_arrivals&rev=1355266421&do=diff 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. When true is returned then hub don't send it to next scripts. text/html 2015-06-16T14:03:34+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_banman&rev=1434463414&do=diff Bans manager table functions Function Description BanMan.Save() Save bans. BanMan.GetBans()Return table with ban tables.BanMan.GetTempBans()Return table with ban tables.BanMan.GetPermBans()Return table with ban tables. BanMan.GetBan(sNick/sIP)Return ban table with ban for given nick or nil when not exist. Return table with text/html 2016-01-09T15:14:25+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_core&rev=1452352465&do=diff Core table functions Function Description Core.Version Return PtokaX version.Core.BuildNumber Return PtokaX build number. Core.Restart() Restart hub.Core.Shutdown() Shutdown hub. Core.ResumeAccepts() Resume listening thread(s) if they were suspended. text/html 2015-06-16T14:04:22+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_ip2country&rev=1434463462&do=diff IP to Country table functions Function Description IP2Country.GetCountryCode(sIP)Return country code of given IP or nil when IP is not valid.IP2Country.GetCountryName(sIP)Return country name of given IP or nil when IP is not valid.IP2Country.GetCountryName(tUser) text/html 2015-06-16T14:03:45+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_profman&rev=1434463425&do=diff Profile manager table functions Function Description ProfMan.AddProfile(sProfileName)Add profile to profilemanager, return iProfileNumber if success or nil when profile already exist.ProfMan.RemoveProfile(sProfileName/iProfileNumber)Remove profile from profilemanager, return true if success or nil when profile not exist or is in use. text/html 2015-06-16T14:03:23+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_regman&rev=1434463403&do=diff Registered users manager table functions Function Description RegMan.Save()Save registered users. RegMan.GetRegsByProfile(iProfileNumber)Return table with all registered users with given profile as registered user tables.RegMan.GetNonOps()Return table with all registered users without operator status as text/html 2015-06-16T14:04:14+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_scriptman&rev=1434463454&do=diff Script manager table functions Function Description ScriptMan.GetScript()Return script table with sName, bEnabled, iMemUsage.ScriptMan.GetScripts()Return table with scripts as tables with sName, bEnabled, iMemUsage. ScriptMan.MoveUp(sScriptName)Move script up in script order. Return nil when failed, true if success. text/html 2015-06-16T14:03:12+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_setman&rev=1434463392&do=diff Setting manager table functions Function Description SetMan.Save() Save settings. SetMan.GetMOTD() Return actual MOTD.SetMan.SetMOTD(sString) Set MOTD. is not allowed. SetMan.GetBool(iBoolId) Return true or nil for given identificator.SetMan.SetBool( text/html 2015-06-16T14:03:53+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_tmrman&rev=1434463433&do=diff Timer manager table functions Function Description TmrMan.AddTimer(iTimerInterval)Add new timer for script. iTimerInterval is in ms. Return nil when failed or uTimerId when success.TmrMan.AddTimer(iTimerInterval, fFunction)Add new timer for script. iTimerInterval is in ms. fFunction is Lua function called by this timer. Return nil when failed or uTimerId when success. text/html 2015-06-16T14:04:04+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:px_udpdbg&rev=1434463444&do=diff UDP debug table functions FIXME Add some description about UDP Debug Receiver app + link. Function Description UDPDbg.Reg(sIp, nPort, bAllData)Register to receiving data to PtokaX UDP Debug receiver, bAllData false means to receive only data from this script. Return nil when failed or true when success. text/html 2012-10-28T00:08:05+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:rangeban_table&rev=1351382885&do=diff Range ban table Value Description sIPFromIP where range ban start.sIPToIP where range ban end.sReasonReason or nil when ban don't have reason.sByNick of operator who create ban or or nil when ban don't have it. iExpireTimeSeconds from 1.1.1970 or nil when ban is perm ban. text/html 2013-04-06T13:08:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:reguser_table&rev=1365253710&do=diff Registered user table Value Description sNickReg user nick.sPasswordReg user password or nil when password hashing is enabled.iProfileReg user profile. text/html 2015-07-24T19:46:14+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:setting_bools_ids&rev=1437767174&do=diff Setting booleans identificators Identificator Description SetMan.tBooleans.AntiMoGloAnti MoGlo descriptionSetMan.tBooleans.AutoStartHub autostartSetMan.tBooleans.RedirectAllRedirect all connecting usersSetMan.tBooleans.RedirectWhenHubFullRedirect users when hub is full text/html 2017-04-02T10:26:10+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:setting_numbers_ids&rev=1491128770&do=diff Setting numbers identificators Identificator Description SetMan.tNumbers.MaxUsersMax users limit.SetMan.tNumbers.MinShareLimitMin share limit. Max 9999.SetMan.tNumbers.MinShareUnitsMin share units. 0 = B, 1 = kB, 2 = MB, 3 = GB, 4 = TB. Max 4.SetMan.tNumbers.MaxShareLimit text/html 2015-06-10T06:42:28+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:setting_strings_ids&rev=1433918548&do=diff Setting strings identificators Identificator Description SetMan.tStrings.HubNameHub name. Min length 1, max 256.SetMan.tStrings.AdminNickAdmin nick. Min length 1, max 64, $ is not allowed.SetMan.tStrings.HubAddressHub address. Min length 1, max 256. text/html 2012-10-14T04:58:37+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:user_data_ids&rev=1350190717&do=diff User data identificators Identificator Description 0sMode1sMyInfoString2sDescription3sTag4sConnection5sEmail6sClient7sClientVersion8sVersion9bConnected10bActive11bOperator12bUserCommand13bQuickList14bSuspiciousTag15iProfile16iShareSize17iHubs18iNormalHubs text/html 2012-10-14T04:59:50+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:user_info_ids&rev=1350190790&do=diff User info identificators Identificator Description 0DescriptionShort1DescriptionLong2TagShort3TagLong4ConnectionShort5ConnectionLong6EmailShort7EmailLong8ShareSizeShort9ShareSizeLong text/html 2014-06-20T20:36:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://wiki.ptokax.org/doku.php?id=luaapi:user_table&rev=1403296591&do=diff User table Value Description sNickUser nick.sIPUser ip address.uptrMemory address to original user data structure, for internal PtokaX use. Don't modify it, else user functions will not work.iProfileUser profile. ---------- Data available after Core.GetUserAllData or Core.GetUserData call: