Class ConfigManager

Used to handle plugin configs.

Inheritance

System.Object

ConfigManager

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Exiled.Loader

Assembly: Exiled.Loader.dll

Syntax

public static class ConfigManager

Methods

| Improve this Doc View Source

Clear()

Clears the configs.

Declaration

public static bool Clear()

Returns

Type	Description
System.Boolean	Returns a value indicating whether configs have been cleared successfully or not.

| Improve this Doc View Source

LoadConfig(IPlugin<IConfig>, Dictionary<String, Object>)

Loads the config of a plugin using the distribution.

Declaration

public static IConfig LoadConfig(this IPlugin<IConfig> plugin, Dictionary<string, object> rawConfigs = null)

Parameters

Type	Name	Description
IPlugin<IConfig>	plugin	The plugin which config will be loaded.
System.Collections.Generic.Dictionary<System.String, System.Object>	rawConfigs	The raw configs to detect if the plugin already has generated configs.

Returns

Type	Description
IConfig	The IConfig of the plugin.

| Improve this Doc View Source

LoadDefaultConfig(IPlugin<IConfig>, Dictionary<String, Object>)

Loads the config of a plugin using the default distribution.

Declaration

public static IConfig LoadDefaultConfig(this IPlugin<IConfig> plugin, Dictionary<string, object> rawConfigs)

Parameters

Type	Name	Description
IPlugin<IConfig>	plugin	The plugin which config will be loaded.
System.Collections.Generic.Dictionary<System.String, System.Object>	rawConfigs	The raw configs to detect if the plugin already has generated configs.

Returns

Type	Description
IConfig	The IConfig of the plugin.

| Improve this Doc View Source

LoadSeparatedConfig(IPlugin<IConfig>)

Loads the config of a plugin using the separated distribution.

Declaration

public static IConfig LoadSeparatedConfig(this IPlugin<IConfig> plugin)

Parameters

Type	Name	Description
IPlugin<IConfig>	plugin	The plugin which its config will be loaded.

Returns

Type	Description
IConfig	The IConfig of the plugin.

| Improve this Doc View Source

LoadSorted(String)

Loads all the plugin configs.

Declaration

public static SortedDictionary<string, IConfig> LoadSorted(string rawConfigs)

Parameters

Type	Name	Description
System.String	rawConfigs	The raw configs to be loaded.

Returns

Type	Description
System.Collections.Generic.SortedDictionary<System.String, IConfig>	Returns a dictionary of loaded configs.

| Improve this Doc View Source

Read()

Read all plugin configs.

Declaration

public static string Read()

Returns

Type	Description
System.String	Returns the read configs.

| Improve this Doc View Source

Reload()

Reads, loads, and saves plugin configs.

Declaration

public static bool Reload()

Returns

Type	Description
System.Boolean	Returns a value indicating if the reloading process has been completed successfully or not.

| Improve this Doc View Source

ReloadRemoteAdmin()

Reloads RemoteAdmin configs.

Declaration

public static void ReloadRemoteAdmin()

| Improve this Doc View Source

Save(SortedDictionary<String, IConfig>)

Saves plugin configs.

Declaration

public static bool Save(SortedDictionary<string, IConfig> configs)

Parameters

Type	Name	Description
System.Collections.Generic.SortedDictionary<System.String, IConfig>	configs	The configs to be saved.

Returns

Type	Description
System.Boolean	Returns a value indicating whether the configs have been saved successfully or not.

| Improve this Doc View Source

SaveDefaultConfig(String)

Saves default distribution configs.

Declaration

public static bool SaveDefaultConfig(string configs)

Parameters

Type	Name	Description
System.String	configs	The configs to be saved, already serialized in yaml format.

Returns

Type	Description
System.Boolean	Returns a value indicating whether the configs have been saved successfully or not.

| Improve this Doc View Source

SaveSeparatedConfig(String, String)

Saves separated distribution plugin configs.

Declaration

public static bool SaveSeparatedConfig(this string pluginPrefix, string configs)

Parameters

Type	Name	Description
System.String	pluginPrefix	The prefix of the plugin which its config is going to be saved.
System.String	configs	The configs to be saved, already serialized in yaml format.

Returns

Type	Description
System.Boolean	Returns a value indicating whether the configs have been saved successfully or not.