Class MonkeyTogglesConfigSection

Namespace

MonkeyLoader.Meta

Assembly

MonkeyLoader.dll

Specifies the toggles for the Monkeys of a Mod which support disabling.

public sealed class MonkeyTogglesConfigSection : ExpandoConfigSection, INestedIdentifiable<Config>, INestedIdentifiable, IIdentifiableOwner<ConfigSection, IDefiningConfigKey>, IIdentifiableOwner<IDefiningConfigKey>, IIdentifiable, IPrioritizable

Inheritance

object

ConfigSection

ExpandoConfigSection

MonkeyTogglesConfigSection

Implements

INestedIdentifiable<Config>

INestedIdentifiable

IIdentifiableOwner<ConfigSection, IDefiningConfigKey>

IIdentifiableOwner<IDefiningConfigKey>

IIdentifiable

IPrioritizable

Inherited Members

ExpandoConfigSection.CreateDefiningKey<T>(ITypedConfigKey<T>, string, Func<T>, bool, Predicate<T>)

ExpandoConfigSection.GetOrCreateDefiningKey<T>(ITypedConfigKey<T>, string, Func<T>, bool, Predicate<T>)

ExpandoConfigSection.TryGetOrCreateDefiningKey<T>(ITypedConfigKey<T>, out IDefiningConfigKey<T>, string, Func<T>, bool, Predicate<T>)

ConfigSection.Config

ConfigSection.FullId

ConfigSection.HasChanges

ConfigSection.Keys

ConfigSection.Name

ConfigSection.Priority

ConfigSection.Saveable

ConfigSection.Equals(object)

ConfigSection.GetDefinedKey(IConfigKey)

ConfigSection.GetDefinedKey<T>(IDefiningConfigKey<T>)

ConfigSection.GetHashCode()

ConfigSection.OnItemChanged(IConfigKeyChangedEventArgs)

ConfigSection.Reset()

ConfigSection.TryGetDefinedKey<T>(ITypedConfigKey<T>, out IDefiningConfigKey<T>)

ConfigSection.TryGetDefinedKey(IConfigKey, out IDefiningConfigKey)

ConfigSection.ItemChanged

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IdentifiableExtensions.FindNearestParent<TParentIdentifiable>(IIdentifiable)

IdentifiableExtensions.FindNearestParent<TParentIdentifiable>(IIdentifiable, Predicate<TParentIdentifiable>)

IdentifiableExtensions.TryFindNearestParent<TParentIdentifiable>(IIdentifiable, Predicate<TParentIdentifiable>, out TParentIdentifiable?)

IdentifiableExtensions.TryFindNearestParent<TParentIdentifiable>(IIdentifiable, out TParentIdentifiable?)

IdentifiableExtensions.Get<TOwner, TIdentifiable>(IIdentifiableOwner<TOwner, TIdentifiable>)

IdentifiableExtensions.TryGet<TOwner, TIdentifiable>(IIdentifiableOwner<TOwner, TIdentifiable>)

IdentifiableExtensions.Get<TIdentifiable>(IIdentifiableOwner<TIdentifiable>)

IdentifiableExtensions.TryGet<TIdentifiable>(IIdentifiableOwner<TIdentifiable>)

Properties

Description

Gets a description of the config items found in this section.

public override string Description { get; }

Property Value

string

Id

Gets the mod-unique identifier of this section.

public override string Id { get; }

Property Value

string

InternalAccessOnly

Gets whether only the owning mod should have access to this config item.

public override bool InternalAccessOnly { get; }

Property Value

bool

Remarks

By default: false.

Mod

Gets the Mod that these toggles are for.

public Mod Mod { get; }

Property Value

Mod

Version

Gets the semantic version for this config section.
This is used to check if the defined and saved configs are compatible.

public override Version Version { get; }

Property Value

Version

Methods

GetTemplateKey(IMonkey)

Creates a template key for the toggle of the given (early) monkey.

public static ITypedConfigKey<bool> GetTemplateKey(IMonkey monkey)

Parameters

monkey IMonkey

The (early) monkey to create a template key for.

Returns

ITypedConfigKey<bool>

The template key for the toggle of the (early) monkey.

GetToggle(IMonkey)

Gets or creates the toggle config item for the given (early) monkey.

public IDefiningConfigKey<bool> GetToggle(IMonkey monkey)

Parameters

monkey IMonkey

The (early) monkey to get the key for. Must belong to the same Mod and support being disabled.

Returns

IDefiningConfigKey<bool>

The toggle config item for the given (early) monkey.

Exceptions

ArgumentNullException

When the monkey is null.

ArgumentException

When the monkey is from another Mod or doesn't support being disabled.