Script2Server Namespace Reference

Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation. More...

Data Structures
class	ServerScriptClass
	A global server object. More...
class	StreamRegister
	Binding of RoRnet::StreamRegister class. More...

Enumerations
enum	serverSayType { FROM_SERVER = 0, FROM_HOST, FROM_MOTD, FROM_RULES }
	This is used to define who says it, when the server says something. More...
enum	authType {   AUTH_NONE = 0, AUTH_ADMIN = BITMASK(1), AUTH_RANKED = BITMASK(2), AUTH_MOD = BITMASK(3),   AUTH_BOT = BITMASK(4), AUTH_BANNED = BITMASK(5) }
	Binding of RoRnet::UserAuth. More...

Variables
enum Script2Server::serverSayType	BROADCAST_AUTO = -1
	This is returned by the playerChat()/streamAdded() callback and determines how the message is treated. More...
enum Script2Server::serverSayType	BROADCAST_ALL = -1
	broadcast to all clients including sender More...
enum Script2Server::serverSayType	BROADCAST_NORMAL = -1
	broadcast to all clients except sender More...
enum Script2Server::serverSayType	BROADCAST_AUTHED = -1
	broadcast to authed users (bots) More...
enum Script2Server::serverSayType	BROADCAST_BLOCK = -1
	< no broadcast More...

Detailed Description

Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.

Enumeration Type Documentation

authType

enum Script2Server::authType

Binding of RoRnet::UserAuth.

Enumerator
AUTH_NONE	no authentication
AUTH_ADMIN	admin on the server
AUTH_RANKED	ranked status
AUTH_MOD	moderator status
AUTH_BOT	bot status
AUTH_BANNED	banned

Definition at line 16 of file rornet.h.

serverSayType

enum Script2Server::serverSayType

This is used to define who says it, when the server says something.

Enumerator
FROM_SERVER
FROM_HOST
FROM_MOTD
FROM_RULES

Definition at line 16 of file globals.h.

Variable Documentation

BROADCAST_ALL

enum Script2Server::serverSayType Script2Server::BROADCAST_ALL = -1

broadcast to all clients including sender

BROADCAST_AUTHED

enum Script2Server::serverSayType Script2Server::BROADCAST_AUTHED = -1

broadcast to authed users (bots)

BROADCAST_AUTO

enum Script2Server::serverSayType Script2Server::BROADCAST_AUTO = -1

This is returned by the playerChat()/streamAdded() callback and determines how the message is treated.

Do not edit the publishmode (for scripts only)

BROADCAST_BLOCK

enum Script2Server::serverSayType Script2Server::BROADCAST_BLOCK = -1

< no broadcast

BROADCAST_NORMAL

enum Script2Server::serverSayType Script2Server::BROADCAST_NORMAL = -1

broadcast to all clients except sender