Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Dependencies.ISettings Interface Reference

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

Public Member Functions

Get< T > (string key, T def)
 Gets a setting by key. If it doesn't exist, return the default More...
 
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

bool pluginbase.Dependencies.ISettings.Contains ( string  key)

Checks whether we contain an extended setting of key

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

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

Parameters
keyKey.
defDefault value
Template Parameters
TThe 1st type parameter.
T pluginbase.Dependencies.ISettings.Get< T > ( string  key)

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

Parameters
keyKey.
Template Parameters
TThe 1st type parameter.

Property Documentation

string pluginbase.Dependencies.ISettings.EnvironmentName
get

Gets the internal name of the active environment

The name of the environment.

string pluginbase.Dependencies.ISettings.GameControllerName
get

Gets the internal name of the game controller

The name of the game controller.

int pluginbase.Dependencies.ISettings.Seed
get

Gets the seed of the game

The seed.

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: