pluginbase.Dependencies.ISettings Interface Reference

Dependency that represents settings used when initializing the game Available on client and server More...

Public Member Functions
T	Get< T > (string key, T def)
	Gets a setting by key. If it doesn't exist, return the default More...
T	Get< T > (string key)
	Gets the setting by key. If it doesn't exist, return default(T) More...
bool	Contains (string key)
	Checks whether we contain an extended setting of key More...

Properties
int	Seed [get]
	Gets the seed of the game More...
string	EnvironmentName [get]
	Gets the internal name of the active environment More...
string	WorldGeneratorName [get]
	Gets the internal name of the active world generator More...
string	GameControllerName [get]
	Gets the internal name of the game controller More...

Detailed Description

Dependency that represents settings used when initializing the game Available on client and server

Attribute: Injectable

Member Function Documentation

Contains()

bool pluginbase.Dependencies.ISettings.Contains

(

string

key

)

Checks whether we contain an extended setting of key

Parameters

key

Key.

Get< T >() [1/2]

T pluginbase.Dependencies.ISettings.Get< T >	(	string	key,
		T	def
	)

Gets a setting by key. If it doesn't exist, return the default

Parameters

key	Key.
def	Default value

Template Parameters

T	The 1st type parameter.

Get< T >() [2/2]

T pluginbase.Dependencies.ISettings.Get< T >

(

string

key

)

Gets the setting by key. If it doesn't exist, return default(T)

Parameters

key

Key.

Template Parameters

T	The 1st type parameter.

Property Documentation

EnvironmentName

string pluginbase.Dependencies.ISettings.EnvironmentName

get

Gets the internal name of the active environment

The name of the environment.

GameControllerName

string pluginbase.Dependencies.ISettings.GameControllerName

get

Gets the internal name of the game controller

The name of the game controller.

Seed

int pluginbase.Dependencies.ISettings.Seed

get

Gets the seed of the game

The seed.

WorldGeneratorName

string pluginbase.Dependencies.ISettings.WorldGeneratorName

get

Gets the internal name of the active world generator

The name of the world generator.

---

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

• pluginbase/Dependencies/ISettings.cs