Class ConfigKeyDescription

Namespace

MonkeyLoader.Configuration

Assembly

MonkeyLoader.dll

Implements a basic description component for IDefiningConfigKeys.

public sealed class ConfigKeyDescription : IConfigKeyDescription, IConfigKeyComponent<IDefiningConfigKey>, IComponent<IDefiningConfigKey>

Inheritance

object

ConfigKeyDescription

Implements

IConfigKeyDescription

IConfigKeyComponent<IDefiningConfigKey>

IComponent<IDefiningConfigKey>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConfigKeyDescription(string)

Creates a new basic description component.

public ConfigKeyDescription(string description)

Parameters

description string

The description of the config key. Must not be just whitespace.

Exceptions

ArgumentException

When the description is just whitespace.

Properties

Description

Gets the description for the config key.

public string Description { get; }

Property Value

string

Methods

Initialize(IDefiningConfigKey)

Initializes this component when it's added to an entity's component list.
This may throw a InvalidOperationException when the state of the given entity is invalid for this component.

public void Initialize(IDefiningConfigKey config)

Parameters

config IDefiningConfigKey

Exceptions

InvalidOperationException

When the state of the given entity is invalid.