Script2Server::ServerScriptClass Class Reference

A global server object. More...

#include <ServerScriptClass.h>

Public Member Functions
Server state
void	Log (const string &in)
int	getNumClients ()
int	getTime ()
int	getStartTime ()
User management
void	say (const string &in, int uid, int type)
void	kick (int kuid, const string &in)
void	ban (int buid, const string &in)
bool	unban (int buid)
int	cmd (int uid, string cmd)
	Runs an AngelScript code snippet on a client. More...
string	getUserName (int uid)
void	setUserName (int uid, const string &in)
string	getUserAuth (int uid)
int	getUserAuthRaw (int uid)
void	setUserAuthRaw (int uid, int)
int	getUserColourNum (int uid)
void	setUserColourNum (int uid, int)
void	broadcastUserInfo (int)
string	getUserToken (int uid)
string	getUserVersion (int uid)
string	getUserIPAddress (int uid)
Script management
void	setCallback (const string &in, const string &in, ?&in)
void	deleteCallback (const string &in, const string &in, ?&in)
void	throwException (const string &in)
Config file values
uint	get_maxClients ()
string	get_serverName ()
string	get_IPAddr ()
uint	get_listenPort ()
int	get_serverMode ()
string	get_owner ()
string	get_website ()
string	get_ircServ ()
string	get_voipServ ()
string	getServerTerrain ()
Version info
string	get_version ()
	Returns build date, for example "Feb 13 2023". More...
string	get_asVersion ()
	Returns ANGELSCRIPT_VERSION_STRING, for example "2.29.2". More...
string	get_protocolVersion ()
	Returns RORNET_VERSION, for example "RoRnet_2.44". More...
Utils
int	rangeRandomInt (int, int)
void	curlRequestAsync (string url, string displayname)
	Launches a background task, use `curlStatus` callback to monitor progress and receive result. More...

Detailed Description

A global server object.

Definition at line 20 of file ServerScriptClass.h.

Member Function Documentation

ban()

void Script2Server::ServerScriptClass::ban	(	int	buid,
		const string &	in
	)

broadcastUserInfo()

void Script2Server::ServerScriptClass::broadcastUserInfo

(

int

)

cmd()

int Script2Server::ServerScriptClass::cmd	(	int	uid,
		string	cmd
	)

Runs an AngelScript code snippet on a client.

!

curlRequestAsync()

void Script2Server::ServerScriptClass::curlRequestAsync	(	string	url,
		string	displayname
	)

Launches a background task, use `curlStatus` callback to monitor progress and receive result.

Parameters

displayname

The "correlation ID" - the label passed to the callback to identify the transfer.

deleteCallback()

void Script2Server::ServerScriptClass::deleteCallback	(	const string &	in,
		const string &	in,
		?&	in
	)

get_asVersion()

string Script2Server::ServerScriptClass::get_asVersion

(

)

Returns ANGELSCRIPT_VERSION_STRING, for example "2.29.2".

get_IPAddr()

string Script2Server::ServerScriptClass::get_IPAddr

(

)

get_ircServ()

string Script2Server::ServerScriptClass::get_ircServ

(

)

get_listenPort()

uint Script2Server::ServerScriptClass::get_listenPort

(

)

get_maxClients()

uint Script2Server::ServerScriptClass::get_maxClients

(

)

get_owner()

string Script2Server::ServerScriptClass::get_owner

(

)

get_protocolVersion()

string Script2Server::ServerScriptClass::get_protocolVersion

(

)

Returns RORNET_VERSION, for example "RoRnet_2.44".

get_serverMode()

int Script2Server::ServerScriptClass::get_serverMode

(

)

Returns

Script2Server::ServerType

get_serverName()

string Script2Server::ServerScriptClass::get_serverName

(

)

get_version()

string Script2Server::ServerScriptClass::get_version

(

)

Returns build date, for example "Feb 13 2023".

get_voipServ()

string Script2Server::ServerScriptClass::get_voipServ

(

)

get_website()

string Script2Server::ServerScriptClass::get_website

(

)

getNumClients()

int Script2Server::ServerScriptClass::getNumClients

(

)

getServerTerrain()

string Script2Server::ServerScriptClass::getServerTerrain

(

)

getStartTime()

int Script2Server::ServerScriptClass::getStartTime

(

)

getTime()

int Script2Server::ServerScriptClass::getTime

(

)

getUserAuth()

string Script2Server::ServerScriptClass::getUserAuth

(

int

uid

)

getUserAuthRaw()

int Script2Server::ServerScriptClass::getUserAuthRaw

(

int

uid

)

getUserColourNum()

int Script2Server::ServerScriptClass::getUserColourNum

(

int

uid

)

getUserIPAddress()

string Script2Server::ServerScriptClass::getUserIPAddress

(

int

uid

)

getUserName()

string Script2Server::ServerScriptClass::getUserName

(

int

uid

)

getUserToken()

string Script2Server::ServerScriptClass::getUserToken

(

int

uid

)

getUserVersion()

string Script2Server::ServerScriptClass::getUserVersion

(

int

uid

)

kick()

void Script2Server::ServerScriptClass::kick	(	int	kuid,
		const string &	in
	)

Log()

void Script2Server::ServerScriptClass::Log

(

const string &

in

)

rangeRandomInt()

int Script2Server::ServerScriptClass::rangeRandomInt	(	int	,
		int
	)

say()

void Script2Server::ServerScriptClass::say	(	const string &	in,
		int	uid,
		int	type
	)

Parameters

type	Script2Server::serverSayType

setCallback()

void Script2Server::ServerScriptClass::setCallback	(	const string &	in,
		const string &	in,
		?&	in
	)

setUserAuthRaw()

void Script2Server::ServerScriptClass::setUserAuthRaw	(	int	uid,
		int
	)

setUserColourNum()

void Script2Server::ServerScriptClass::setUserColourNum	(	int	uid,
		int
	)

setUserName()

void Script2Server::ServerScriptClass::setUserName	(	int	uid,
		const string &	in
	)

throwException()

void Script2Server::ServerScriptClass::throwException

(

const string &

in

)

unban()

bool Script2Server::ServerScriptClass::unban

(

int

buid

)

---

The documentation for this class was generated from the following file:

• doc/angelscript/Script2Server/ServerScriptClass.h