Interface IMyConfigDedicated

Describes dedicated server configuration (mods interface)

Namespace: VRage.Game.ModAPI

Assembly: VRage.Game.dll

Syntax

public interface IMyConfigDedicated

Properties

Administrators

Gets or sets administrators It may contain ids in 2 different formats: First - steamId.ToString() Second - starts with STEAM_0:

Declaration

List<string> Administrators { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

AsteroidAmount

Not used

Declaration

int AsteroidAmount { get; set; }

Property Value

Type	Description
System.Int32

AutodetectDependencies

Gets or sets if game should automatically add dependency mods in mods list

Declaration

bool AutodetectDependencies { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

You need save and restart server to apply changes

AutoRestartEnabled

Gets or sets whether auto restart is enabled

Declaration

bool AutoRestartEnabled { get; set; }

Property Value

Type	Description
System.Boolean

AutoRestatTimeInMin

Gets or sets auto restart time in minutes

Declaration

int AutoRestatTimeInMin { get; set; }

Property Value

Type	Description
System.Int32

AutoUpdateBranchPassword

Gets or sets password of steam version branch

Declaration

string AutoUpdateBranchPassword { get; set; }

Property Value

Type	Description
System.String

AutoUpdateCheckIntervalInMin

Gets or sets how often game checks if new version is available

Declaration

int AutoUpdateCheckIntervalInMin { get; set; }

Property Value

Type	Description
System.Int32

AutoUpdateEnabled

Gets or sets if game auto update enabled

Declaration

bool AutoUpdateEnabled { get; set; }

Property Value

Type	Description
System.Boolean

AutoUpdateRestartDelayInMin

Gets or sets time before restart after new update found

Declaration

int AutoUpdateRestartDelayInMin { get; set; }

Property Value

Type	Description
System.Int32

AutoUpdateSteamBranch

Gets or sets name of steam version branch

Declaration

string AutoUpdateSteamBranch { get; set; }

Property Value

Type	Description
System.String

Banned

Gets or sets Banned players. SteamId and Xbox live ids

Declaration

List<ulong> Banned { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.UInt64>

ChatAntiSpamEnabled

Gets or sets whether chat anti spam is enabled

Declaration

bool ChatAntiSpamEnabled { get; set; }

Property Value

Type	Description
System.Boolean

ConsoleCompatibility

Not used

Declaration

bool ConsoleCompatibility { get; set; }

Property Value

Type	Description
System.Boolean

CrossPlatform

Declaration

bool CrossPlatform { get; set; }

Property Value

Type	Description
System.Boolean

DedicatedId

Id of a dedicated server

Declaration

long DedicatedId { get; set; }

Property Value

Type	Description
System.Int64

GroupID

Steam group id, that blocking access to player not from this group.

Declaration

ulong GroupID { get; set; }

Property Value

Type	Description
System.UInt64

Remarks

You need save and restart server to apply changes

IgnoreLastSession

Setting that is used server start. When it is true, it should not load previous server launch world

Declaration

bool IgnoreLastSession { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

You need save and restart server to apply changes

IP

Gets or sets server IP

Declaration

string IP { get; set; }

Property Value

Type	Description
System.String

Remarks

You need save and restart server to apply changes

LoadWorld

Gets current world load path or sets next server start load path

Declaration

string LoadWorld { get; set; }

Property Value

Type	Description
System.String

ManualActionChatMessage

Not used

Declaration

string ManualActionChatMessage { get; set; }

Property Value

Type	Description
System.String

ManualActionDelay

Not used

Declaration

int ManualActionDelay { get; set; }

Property Value

Type	Description
System.Int32

MessageOfTheDay

Shows Gui Popup for players

Declaration

string MessageOfTheDay { get; set; }

Property Value

Type	Description
System.String

MessageOfTheDayUrl

Shows Gui Popup for players but in web browser

Declaration

string MessageOfTheDayUrl { get; set; }

Property Value

Type	Description
System.String

NetworkParameters

Not used

Declaration

List<string> NetworkParameters { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

NetworkType

Not used

Declaration

string NetworkType { get; set; }

Property Value

Type	Description
System.String

PauseGameWhenEmpty

Pause game when zero players on servers

Declaration

bool PauseGameWhenEmpty { get; set; }

Property Value

Type	Description
System.Boolean

Plugins

Gets or sets server plugins. List contains file paths to dlls

Declaration

List<string> Plugins { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Remarks

You need save and restart server to apply changes

PremadeCheckpointPath

When IgnoreLastSession is true and LoadWorld is null or empty, or failed - game would be start new world from PremadeCheckpointPath

Declaration

string PremadeCheckpointPath { get; set; }

Property Value

Type	Description
System.String

RemoteApiEnabled

Gets or sets if remote api enabled

Declaration

bool RemoteApiEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

You need save and restart server to apply changes

RemoteApiIP

Gets or sets remote API IP

Declaration

string RemoteApiIP { get; set; }

Property Value

Type	Description
System.String

Remarks

You need save and restart server to apply changes

RemoteApiPort

Gets or sets remote api port

Declaration

int RemoteApiPort { get; set; }

Property Value

Type	Description
System.Int32

Remarks

You need save and restart server to apply changes

RemoteSecurityKey

Gets or sets remote api password

Declaration

string RemoteSecurityKey { get; set; }

Property Value

Type	Description
System.String

Remarks

You need save and restart server to apply changes

Reserved

Gets or sets reserved players (player can join server even if it is full). SteamId and Xbox live ids

Declaration

List<ulong> Reserved { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.UInt64>

RestartSave

Gets or sets if game should save on server stop

Declaration

bool RestartSave { get; set; }

Property Value

Type	Description
System.Boolean

SameMessageTimeout

Gets or sets the timeout for the same message, it cannot be sent again sooner than this (seconds)

Declaration

int SameMessageTimeout { get; set; }

Property Value

Type	Description
System.Int32

SaveChatToLog

Gets or sets if game should automatically add dependency mods in mods list

Declaration

bool SaveChatToLog { get; set; }

Property Value

Type	Description
System.Boolean

ServerDescription

Gets or sets server description

Declaration

string ServerDescription { get; set; }

Property Value

Type	Description
System.String

ServerName

Gets or sets server name

Declaration

string ServerName { get; set; }

Property Value

Type	Description
System.String

ServerPasswordHash

Gets or sets server password hash

Declaration

string ServerPasswordHash { get; set; }

Property Value

Type	Description
System.String

Remarks

You need save and restart server to apply changes

ServerPasswordSalt

Gets or sets server password hash

Declaration

string ServerPasswordSalt { get; set; }

Property Value

Type	Description
System.String

Remarks

You need save and restart server to apply changes

ServerPort

Gets or sets server connection port 27016 - default

Declaration

int ServerPort { get; set; }

Property Value

Type	Description
System.Int32

SessionSettings

Gets or sets (but that doesn't change anything) session settings

Declaration

MyObjectBuilder_SessionSettings SessionSettings { get; set; }

Property Value

Type	Description
MyObjectBuilder_SessionSettings

SpamMessagesTime

Gets or sets the time threshold for spam. If elapsed time between messages is less they are considered spam (seconds)

Declaration

float SpamMessagesTime { get; set; }

Property Value

Type	Description
System.Single

SpamMessagesTimeout

If player is considered a spammer based on SpamMessagesTime they cannot send any messages for the duration of this timeout (seconds)

Declaration

int SpamMessagesTimeout { get; set; }

Property Value

Type	Description
System.Int32

SteamPort

Gets or sets steam port

Declaration

int SteamPort { get; set; }

Property Value

Type	Description
System.Int32

VerboseNetworkLogging

Not used

Declaration

bool VerboseNetworkLogging { get; set; }

Property Value

Type	Description
System.Boolean

WatcherInterval

Not used

Declaration

float WatcherInterval { get; set; }

Property Value

Type	Description
System.Single

WatcherSimulationSpeedMinimum

Not used

Declaration

float WatcherSimulationSpeedMinimum { get; set; }

Property Value

Type	Description
System.Single

WorldName

Gets or sets world name. Doesn't change world name in client find server gui when setted.

Declaration

string WorldName { get; set; }

Property Value

Type	Description
System.String

Methods

GenerateRemoteSecurityKey()

Gets remote api password

Declaration

void GenerateRemoteSecurityKey()

Remarks

You need save and restart server to apply changes

GetFilePath()

Gets where settings file is located

Declaration

string GetFilePath()

Returns

Type	Description
System.String	File path

Load(String)

Load settings from file

Declaration

void Load(string path = null)

Parameters

Type	Name	Description
System.String	path

Save(String)

Saves game.

Declaration

void Save(string path = null)

Parameters

Type	Name	Description
System.String	path	When not null will save to provided folder

SetPassword(String)

Used to set new password for server

Declaration

void SetPassword(string password)

Parameters

Type	Name	Description
System.String	password

Remarks

You need save and restart server to apply changes