Dawn of Light - Class documentation 2900
This is the Dawn of Light project
DOL.GS.GameServerConfiguration Class Reference

This is the game server configuration. More...

List of all members.

Public Member Functions

 GameServerConfiguration ()
 Constructs a server configuration with default values.

Protected Member Functions

override void LoadFromConfig (ConfigElement root)
 Loads the config values from a specific config element.
override void SaveToConfig (ConfigElement root)
 Saves the values into a specific config element.

Protected Attributes

string m_rootDirectory
 holds the server root directory
string m_logConfigFile
 Holds the log configuration file path.
string m_regionConfigFile
 Holds the log configuration file path.
string m_zoneConfigFile
 Holds the log configuration file path.
string m_scriptCompilationTarget
 Name of the scripts compilation target.
string m_scriptAssemblies
 The assemblies to include when compiling the scripts.
bool m_autoAccountCreation
 True if the server shall automatically create accounts.
eGameServerType m_serverType
 The game server type.
string m_ServerName
 The game server name.
string m_ServerNameShort
 The short server name, shown in /loc command.
int m_cpuCount
 The count of server cpu.
int m_maxClientCount
 The max client count.
IPEndPoint m_udpOutEndpoint
 The endpoint to send UDP packets from.
string m_gmActionsLoggerName
 The logger name where to log the gm+ commandos.
string m_cheatLoggerName
 The logger name where to log cheat attempts.
string m_invalidNamesFile = ""
 The file name of the invalid names file.
string m_dbConnectionString
 The path to the XML database folder.
ConnectionType m_dbType
 Type database type.
bool m_autoSave
 True if the server shall autosave the db.
int m_saveInterval
 The auto save interval in minutes.

Properties

string RootDirectory [get, set]
 Gets or sets the root directory of the server.
string LogConfigFile [get, set]
 Gets or sets the log configuration file of this server.
string RegionConfigFile [get, set]
 Gets or sets the region configuration file of this server.
string ZoneConfigFile [get, set]
 Gets or sets the zone configuration file of this server.
string ScriptCompilationTarget [get, set]
 Gets or sets the script compilation target.
string ScriptAssemblies [get, set]
 Gets or sets the script assemblies to be included in the script compilation.
bool AutoAccountCreation [get, set]
 Gets or sets the auto account creation flag.
eGameServerType ServerType [get, set]
 Gets or sets the server type.
string ServerName [get, set]
 Gets or sets the server name.
string ServerNameShort [get, set]
 Gets or sets the short server name.
string GMActionsLoggerName [get, set]
 Gets or sets the GM action logger name.
string CheatLoggerName [get, set]
 Gets or sets the cheat logger name.
string InvalidNamesFile [get, set]
 Gets or sets the invalid name filename.
string DBConnectionString [get, set]
 Gets or sets the xml database path.
ConnectionType DBType [get, set]
 Gets or sets the DB type.
bool AutoSave [get, set]
 Gets or sets the autosave flag.
int SaveInterval [get, set]
 Gets or sets the autosave interval.
int CpuCount [get, set]
 Gets or sets the server cpu count.
int MaxClientCount [get, set]
 Gets or sets the max cout of clients allowed.
IPEndPoint UDPOutEndpoint [get, set]
 Gets or sets UDP address and port to send UDP packets from. If

null

then Socket decides where to bind.

int CPUUse [get, set]

Detailed Description

This is the game server configuration.


Constructor & Destructor Documentation

DOL.GS.GameServerConfiguration.GameServerConfiguration ( )

Constructs a server configuration with default values.


Member Function Documentation

override void DOL.GS.GameServerConfiguration.LoadFromConfig ( ConfigElement  root) [protected]

Loads the config values from a specific config element.

Parameters:
rootthe root config element
override void DOL.GS.GameServerConfiguration.SaveToConfig ( ConfigElement  root) [protected]

Saves the values into a specific config element.

Parameters:
rootthe root config element

Member Data Documentation

True if the server shall automatically create accounts.

True if the server shall autosave the db.

The logger name where to log cheat attempts.

The count of server cpu.

The path to the XML database folder.

ConnectionType DOL.GS.GameServerConfiguration.m_dbType [protected]

Type database type.

The logger name where to log the gm+ commandos.

The file name of the invalid names file.

Holds the log configuration file path.

The max client count.

Holds the log configuration file path.

holds the server root directory

The auto save interval in minutes.

The assemblies to include when compiling the scripts.

Name of the scripts compilation target.

The game server name.

The short server name, shown in /loc command.

eGameServerType DOL.GS.GameServerConfiguration.m_serverType [protected]

The game server type.

The endpoint to send UDP packets from.

Holds the log configuration file path.


Property Documentation

bool DOL.GS.GameServerConfiguration.AutoAccountCreation [get, set]

Gets or sets the auto account creation flag.

bool DOL.GS.GameServerConfiguration.AutoSave [get, set]

Gets or sets the autosave flag.

string DOL.GS.GameServerConfiguration.CheatLoggerName [get, set]

Gets or sets the cheat logger name.

int DOL.GS.GameServerConfiguration.CpuCount [get, set]

Gets or sets the server cpu count.

string DOL.GS.GameServerConfiguration.DBConnectionString [get, set]

Gets or sets the xml database path.

ConnectionType DOL.GS.GameServerConfiguration.DBType [get, set]

Gets or sets the DB type.

string DOL.GS.GameServerConfiguration.GMActionsLoggerName [get, set]

Gets or sets the GM action logger name.

string DOL.GS.GameServerConfiguration.InvalidNamesFile [get, set]

Gets or sets the invalid name filename.

string DOL.GS.GameServerConfiguration.LogConfigFile [get, set]

Gets or sets the log configuration file of this server.

int DOL.GS.GameServerConfiguration.MaxClientCount [get, set]

Gets or sets the max cout of clients allowed.

string DOL.GS.GameServerConfiguration.RegionConfigFile [get, set]

Gets or sets the region configuration file of this server.

string DOL.GS.GameServerConfiguration.RootDirectory [get, set]

Gets or sets the root directory of the server.

int DOL.GS.GameServerConfiguration.SaveInterval [get, set]

Gets or sets the autosave interval.

string DOL.GS.GameServerConfiguration.ScriptAssemblies [get, set]

Gets or sets the script assemblies to be included in the script compilation.

string DOL.GS.GameServerConfiguration.ScriptCompilationTarget [get, set]

Gets or sets the script compilation target.

string DOL.GS.GameServerConfiguration.ServerName [get, set]

Gets or sets the server name.

string DOL.GS.GameServerConfiguration.ServerNameShort [get, set]

Gets or sets the short server name.

eGameServerType DOL.GS.GameServerConfiguration.ServerType [get, set]

Gets or sets the server type.

IPEndPoint DOL.GS.GameServerConfiguration.UDPOutEndpoint [get, set]

Gets or sets UDP address and port to send UDP packets from. If

null

then Socket decides where to bind.

string DOL.GS.GameServerConfiguration.ZoneConfigFile [get, set]

Gets or sets the zone configuration file of this server.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events