ServerConfig Interface Reference

Public Member Functions
void	~ServerConfig ()
proto external string	GetName ()
	Returns currently set name in the config.
proto external void	SetName (string value)
	Changes name set in the config.
proto external string	GetDescription ()
	Returns currently set description in the config.
proto external void	SetDescription (string value)
	Changes description set in the config.
proto external string	GetPassword ()
	Returns currently set password in the config.
proto external void	SetPassword (string value)
	Changes password set in the config.
proto external int	GetMaxPlayers ()
	Returns currently set limit for max players in the config.
proto external void	SetMaxPlayers (int value)
	Changes the limit for max players set in the config.
proto external int	GetPort ()
	Returns currently set limit for max players in the config.
proto external void	SetPort (int value)
	Changes the limit for max players set in the config.
proto external EServerPlatformFlags	GetPlatforms ()
	Returns currently allowed platforms in the server config.
proto external void	SetPlatforms (EServerPlatformFlags value)
	Changes allowed platforms in the server config.
proto external bool	GetVisible ()
	Returns current value for the visibility in server browser.
proto external void	SetVisible (bool value)
	Changes the visibility in server browser.
proto external bool	GetBattlEye ()
	Returns current value for enabled sate of the BattlEye.
proto external void	SetBattlEye (bool value)
	Changes the enabled sate of the BattlEye.

Static Public Attributes
Constants
Populated by the engine.
static const bool	DEFAULT_BATTLEYE
	Default enabled state of BattlEye (Anti-Cheat) protection.
static const bool	DEFAULT_VISIBLE
	Default visibility state of the server in server browser.
static const EServerPlatformFlags	DEFAULT_PLATFORMS
	Default platform compatibility configuration.
static const int	DEFAULT_MAX_PLAYERS
	Default max player connection capacity.
static const int	MIN_MAX_PLAYERS
	Minimum limit of value for max player connection capacity.
static const int	MAX_MAX_PLAYERS
	Maximum limit of value for max player connection capacity.
static const int	DEFAULT_PORT
	Default port for connecting to the server replication.

Constructor & Destructor Documentation

~ServerConfig()

void ServerConfig.~ServerConfig

(

)

Member Function Documentation

GetBattlEye()

proto external bool ServerConfig.GetBattlEye

(

)

Returns current value for enabled sate of the BattlEye.

GetDescription()

proto external string ServerConfig.GetDescription

(

)

Returns currently set description in the config.

GetMaxPlayers()

proto external int ServerConfig.GetMaxPlayers

(

)

Returns currently set limit for max players in the config.

GetName()

proto external string ServerConfig.GetName

(

)

Returns currently set name in the config.

GetPassword()

proto external string ServerConfig.GetPassword

(

)

Returns currently set password in the config.

GetPlatforms()

proto external EServerPlatformFlags ServerConfig.GetPlatforms

(

)

Returns currently allowed platforms in the server config.

GetPort()

proto external int ServerConfig.GetPort

(

)

Returns currently set limit for max players in the config.

GetVisible()

proto external bool ServerConfig.GetVisible

(

)

Returns current value for the visibility in server browser.

SetBattlEye()

proto external void ServerConfig.SetBattlEye

(

bool

value

)

Changes the enabled sate of the BattlEye.

SetDescription()

proto external void ServerConfig.SetDescription

(

string

value

)

Changes description set in the config.

SetMaxPlayers()

proto external void ServerConfig.SetMaxPlayers

(

int

value

)

Changes the limit for max players set in the config.

SetName()

proto external void ServerConfig.SetName

(

string

value

)

Changes name set in the config.

SetPassword()

proto external void ServerConfig.SetPassword

(

string

value

)

Changes password set in the config.

SetPlatforms()

proto external void ServerConfig.SetPlatforms

(

EServerPlatformFlags

value

)

Changes allowed platforms in the server config.

SetPort()

proto external void ServerConfig.SetPort

(

int

value

)

Changes the limit for max players set in the config.

SetVisible()

proto external void ServerConfig.SetVisible

(

bool

value

)

Changes the visibility in server browser.

Member Data Documentation

DEFAULT_BATTLEYE

const bool ServerConfig.DEFAULT_BATTLEYE

static

Default enabled state of BattlEye (Anti-Cheat) protection.

ServerConfig.DEFAULT_BATTLEYE = true

DEFAULT_MAX_PLAYERS

const int ServerConfig.DEFAULT_MAX_PLAYERS

static

Default max player connection capacity.

ServerConfig.DEFAULT_MAX_PLAYERS = 64

DEFAULT_PLATFORMS

const EServerPlatformFlags ServerConfig.DEFAULT_PLATFORMS

static

Default platform compatibility configuration.

ServerConfig.DEFAULT_PLATFORMS = platform of the application

DEFAULT_PORT

const int ServerConfig.DEFAULT_PORT

static

Default port for connecting to the server replication.

ServerConfig.DEFAULT_MAX_PLAYERS = 64

DEFAULT_VISIBLE

const bool ServerConfig.DEFAULT_VISIBLE

static

Default visibility state of the server in server browser.

ServerConfig.DEFAULT_VISIBLE = true

MAX_MAX_PLAYERS

const int ServerConfig.MAX_MAX_PLAYERS

static

Maximum limit of value for max player connection capacity.

ServerConfig.MAX_MAX_PLAYERS = 128

MIN_MAX_PLAYERS

const int ServerConfig.MIN_MAX_PLAYERS

static

Minimum limit of value for max player connection capacity.

ServerConfig.MIN_MAX_PLAYERS = 1

---

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

• GameLib/generated/online/server/config/ServerConfig.c