Author Topic: Is there somewhere I can find a giant list of functions available?  (Read 1878 times)

0 Members and 1 Guest are viewing this topic.

Offline bytecode

  • Newbie
  • *
  • Posts: 4
  • Karma: +0/-0
I was wondering if there is somewhere that I can find a list of different ptokax specific functions? Things like:

frmHub:GetCurrentShareAmount()

So far I've just been using neat things I find in other scripts, but it'd be really handy to have a list of these available somewhere.

Thanks.

PtokaX forum


Offline Optimus

  • Emperor
  • **
  • Posts: 1 474
  • Karma: +13/-1
(No subject)
« Reply #1 on: 22 October, 2003, 11:59:49 »
You will find more information in the scripting.txt

Here are a few Examples:

frmHub:GetUsersCount()
  returns number of online users

frmHub:GetHubName()
  returns string

frmHub:SetHubName(string)
  string = hub name

frmHub:GetHubDescr()
  returns string

frmHub:SetHubDescr(string)
  string = hub description

frmHub:GetRedirectAddress()
  returns string

frmHub:SetRedirectAddress(string)
  string = hub address (IP or hostname)

frmHub:GetRedirectAll()
  returns 0 or 1

frmHub:SetRedirectAll(number)
  number = 0 or 1

frmHub:GetRedirectFull()
  returns 0 or 1

frmHub:SetRedirectFull(number)
  number = 0 or 1

frmHub:GetRegServer()
  returns string

frmHub:SetRegServer(string)
  string = address of the reg.server (currently only one address is allowed)

frmHub:SetAutoRegister(number)
  number = 0 or 1

frmHub:GetMaxUsers()
  returns number of UserLimit

frmHub:SetMaxUsers(number)
  number = 1 to 2000

frmHub:GetMinShare()
  returns the minshare in bytes

frmHub:SetMinShare(amount, unit)
  amount = number
  unit = number (unit: 0=byte, 1=KByte,2=MByte, 3=GByte)
  sets the minshare

frmHub:GetCurrentShareAmount()
  returns the total share of all users at the moment in bytes

frmHub:GetOpChatName()
  returns the name of the OpChat-Bot

frmHub:GetHubBotName()
  returns the name of the HubBot

frmHub:EnableSearchData(n)
  n = 1 or 0 (1-enable,0-disable)
  enables/disables passing of $Search, $MultiSearch and $SR to current script

frmHub:EnableFullData(n)
  n = 1 or 0 (1-enable,0-disable)
  enables/disables passing of ALL incomming data to current script
  NOTE: may have significant influence on hub's performance. Use it wisely!


There will be even more in the Next Ptokax Release...

Ciao ;)

Offline pHaTTy

  • Forum Legend
  • ***
  • Posts: 1 916
  • Karma: +5/-1
(No subject)
« Reply #2 on: 22 October, 2003, 12:37:52 »
if you look in the ptokax directory, under docs, the scripting.txt, you will find them in there m8 good luck, if you need help, we are all here to help ;)

l8rr,,

-phatty
Resistance is futile!

Offline servaks

  • Double Ace
  • *
  • Posts: 145
  • Karma: +1/-0
(No subject)
« Reply #3 on: 22 October, 2003, 16:40:09 »
Useful for me too..  :rolleyes:

/shipis
My hub is back! (yeeeeeey)

hub.servaks.com


PtokaX forum

(No subject)
« Reply #3 on: 22 October, 2003, 16:40:09 »