Description

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

Data Structures
class	ServerScriptClass

class	StreamRegister

Enumerations
enum	ServerType

enum	broadcastType

enum	serverSayType

enum	CurlStatusType

enum	authType

Variables
	TO_ALL = -1

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 20 of file rornet.h.

◆ broadcastType

enum Script2Server::broadcastType

This is returned by the playerChat()/streamAdded() callback and determines how the message is treated;
order: least restrictive to most restrictive!

Enumerator
BROADCAST_AUTO	Do not edit the publishmode (for scripts only)
BROADCAST_ALL	broadcast to all clients including sender
BROADCAST_NORMAL	broadcast to all clients except sender
BROADCAST_AUTHED	broadcast to authed users (bots)
BROADCAST_BLOCK	no broadcast

Definition at line 31 of file globals.h.

◆ CurlStatusType

enum Script2Server::CurlStatusType

Used with `curlStatus()` callback.

Enumerator
CURL_STATUS_INVALID	Should never be reported.
CURL_STATUS_START	New CURL request started, n1/n2 both 0.
CURL_STATUS_PROGRESS	Download in progress, n1 = bytes downloaded, n2 = total bytes.
CURL_STATUS_SUCCESS	CURL request finished, n1 = CURL return code, n2 = HTTP result code, message = received payload.
CURL_STATUS_FAILURE	CURL request finished, n1 = CURL return code, n2 = HTTP result code, message = CURL error string.

Definition at line 56 of file globals.h.

◆ serverSayType

enum Script2Server::serverSayType

Use with server.say() to specify who said it.

Enumerator
FROM_SERVER
FROM_HOST
FROM_MOTD
FROM_RULES

Definition at line 45 of file globals.h.

◆ ServerType

enum Script2Server::ServerType

The server configuration, use server.get_serverMode().

Enumerator
SERVER_LAN
SERVER_INET
SERVER_AUTO

Definition at line 21 of file globals.h.

Variable Documentation

◆ TO_ALL

Script2Server::TO_ALL = -1

constant for functions that receive an uid for sending something

Definition at line 40 of file globals.h.