Class ConfigKeyDefaultConstant<T>

Namespace

MonkeyLoader.Configuration

Assembly

MonkeyLoader.dll

Implements a component that provides a default value for IDefiningConfigKey<T>s by using a provided unmanaged value.

public sealed class ConfigKeyDefaultConstant<T> : IConfigKeyDefault<T>, IConfigKeyComponent<IDefiningConfigKey<T>>, IComponent<IDefiningConfigKey<T>> where T : unmanaged

Type Parameters

T

The type of the config item's value.

Inheritance

object

ConfigKeyDefaultConstant<T>

Implements

IConfigKeyDefault<T>

IConfigKeyComponent<IDefiningConfigKey<T>>

IComponent<IDefiningConfigKey<T>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConfigKeyDefaultConstant(T)

Creates an IConfigKeyDefault<T> component that uses the provided unmanaged value as the default value.

public ConfigKeyDefaultConstant(T value)

Parameters

value T

The constant value to use as a default.

Methods

GetDefault()

Creates a new instance of the default value for the inner type T of the config key.

public T GetDefault()

Returns

T

The new default value.

Initialize(IDefiningConfigKey<T>)

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<T> entity)

Parameters

entity IDefiningConfigKey<T>

The entity this component was added to.

Exceptions

InvalidOperationException

When the state of the given entity is invalid.