RigsofRods  2023.09
Soft-body Physics Simulation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ServerScriptClass.h
Go to the documentation of this file.
1 
2  // =================================================== //
3  // THIS IS NOT A C++ HEADER! Only a dummy for Doxygen. //
4  // =================================================== //
5 
6 
15 namespace Script2Server {
16 
21 {
22 public:
23 
26 
29  void Log(const string &in);
30 
33  int getNumClients();
34 
37  int getTime();
38 
41  int getStartTime();
42 
44 
47 
51  void say(const string &in, int uid, int type);
52 
55  void kick(int kuid, const string &in);
56 
59  void ban(int buid, const string &in);
60 
63  bool unban(int buid);
64 
68  int cmd(int uid, string cmd);
69 
72  string getUserName(int uid);
73 
76  void setUserName(int uid, const string &in);
77 
80  string getUserAuth(int uid);
81 
84  int getUserAuthRaw(int uid);
85 
88  void setUserAuthRaw(int uid, int);
89 
92  int getUserColourNum(int uid);
93 
96  void setUserColourNum(int uid, int);
97 
100  void broadcastUserInfo(int);
101 
104  string getUserToken(int uid);
105 
108  string getUserVersion(int uid);
109 
112  string getUserIPAddress(int uid);
113 
115 
118 
121  void setCallback(const string &in, const string &in, ?&in);
122 
125  void deleteCallback(const string &in, const string &in, ?&in);
126 
129  void throwException(const string &in);
130 
132 
135 
138  uint get_maxClients();
139 
142  string get_serverName();
143 
146  string get_IPAddr();
147 
150  uint get_listenPort();
151 
155  int get_serverMode();
156 
159  string get_owner();
160 
163  string get_website();
164 
167  string get_ircServ();
168 
171  string get_voipServ();
172 
175  string getServerTerrain();
176 
178 
181 
184  string get_version();
185 
188  string get_asVersion();
189 
192  string get_protocolVersion();
193 
195 
198 
201  int rangeRandomInt(int, int);
202 
207  void curlRequestAsync(string url, string displayname);
208 
210 
211 };
212 
213 } // namespace Script2Server
214 
Script2Server::ServerScriptClass::get_serverName
string get_serverName()
Script2Server::ServerScriptClass::get_asVersion
string get_asVersion()
Returns ANGELSCRIPT_VERSION_STRING, for example "2.29.2".
Script2Server::ServerScriptClass::getUserAuth
string getUserAuth(int uid)
Script2Server::ServerScriptClass::getTime
int getTime()
Script2Server
Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.
Definition: globals.h:15
Script2Server::ServerScriptClass::get_ircServ
string get_ircServ()
Script2Server::ServerScriptClass::get_IPAddr
string get_IPAddr()
Script2Server::ServerScriptClass::unban
bool unban(int buid)
Script2Server::ServerScriptClass::get_owner
string get_owner()
Script2Server::ServerScriptClass::getUserToken
string getUserToken(int uid)
Script2Server::ServerScriptClass::throwException
void throwException(const string &in)
Script2Server::ServerScriptClass::getUserVersion
string getUserVersion(int uid)
Script2Server::ServerScriptClass
A global server object.
Definition: ServerScriptClass.h:20
Script2Server::ServerScriptClass::getUserColourNum
int getUserColourNum(int uid)
Script2Server::ServerScriptClass::setCallback
void setCallback(const string &in, const string &in, ?&in)
Script2Server::ServerScriptClass::broadcastUserInfo
void broadcastUserInfo(int)
Script2Server::ServerScriptClass::get_version
string get_version()
Returns build date, for example "Feb 13 2023".
Script2Server::ServerScriptClass::rangeRandomInt
int rangeRandomInt(int, int)
Script2Server::ServerScriptClass::get_maxClients
uint get_maxClients()
Script2Server::ServerScriptClass::deleteCallback
void deleteCallback(const string &in, const string &in, ?&in)
Script2Server::ServerScriptClass::curlRequestAsync
void curlRequestAsync(string url, string displayname)
Launches a background task, use `curlStatus` callback to monitor progress and receive result.
Script2Server::ServerScriptClass::get_listenPort
uint get_listenPort()
Script2Server::ServerScriptClass::getUserIPAddress
string getUserIPAddress(int uid)
Script2Server::ServerScriptClass::getStartTime
int getStartTime()
Script2Server::ServerScriptClass::say
void say(const string &in, int uid, int type)
Script2Server::ServerScriptClass::Log
void Log(const string &in)
Script2Server::ServerScriptClass::getNumClients
int getNumClients()
Script2Server::ServerScriptClass::cmd
int cmd(int uid, string cmd)
Runs an AngelScript code snippet on a client.
Script2Server::ServerScriptClass::getUserName
string getUserName(int uid)
Script2Server::ServerScriptClass::setUserAuthRaw
void setUserAuthRaw(int uid, int)
Script2Server::ServerScriptClass::get_voipServ
string get_voipServ()
Script2Server::ServerScriptClass::get_website
string get_website()
Script2Server::ServerScriptClass::getUserAuthRaw
int getUserAuthRaw(int uid)
Script2Server::ServerScriptClass::ban
void ban(int buid, const string &in)
Script2Server::ServerScriptClass::setUserColourNum
void setUserColourNum(int uid, int)
Script2Server::ServerScriptClass::setUserName
void setUserName(int uid, const string &in)
Script2Server::ServerScriptClass::get_serverMode
int get_serverMode()
Script2Server::ServerScriptClass::getServerTerrain
string getServerTerrain()
Script2Server::ServerScriptClass::kick
void kick(int kuid, const string &in)
Script2Server::ServerScriptClass::get_protocolVersion
string get_protocolVersion()
Returns RORNET_VERSION, for example "RoRnet_2.44".