Interface IMonkey

Namespace

MonkeyLoader.Meta

Assembly

MonkeyLoader.dll

Defines the interface for all (early) monkeys.

public interface IMonkey : IRun, IShutdown, IComparable<IMonkey>, INestedIdentifiable<Mod>, INestedIdentifiable, IIdentifiable, IAuthorable

Inherited Members

IRun.Failed

IRun.Ran

IRun.Run()

IShutdown.ShutdownFailed

IShutdown.ShutdownRan

IShutdown.Shutdown(bool)

IShutdown.ShutdownDone

IShutdown.ShuttingDown

IComparable<IMonkey>.CompareTo(IMonkey)

INestedIdentifiable<Mod>.Parent

IIdentifiable.FullId

IIdentifiable.Id

IAuthorable.Authors

IAuthorable.HasAuthor(string)

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?)

Properties

AssemblyName

Gets the name of the assembly this monkey is defined in.

AssemblyName AssemblyName { get; }

Property Value

AssemblyName

CanBeDisabled

Gets whether this monkey can be disabled, that is, whether it's permitted to set Enabled to false, and there is an EnabledToggle.

bool CanBeDisabled { get; }

Property Value

bool

true if this monkey respects the MonkeyToggles config.

Config

Gets the Config that this monkey can use to load ConfigSections.

Config Config { get; }

Property Value

Config

Enabled

Gets or sets whether this monkey should currently be active.

bool Enabled { get; set; }

Property Value

bool

Remarks

Can only be set to false if the monkey supports being disabled.

EnabledToggle

Gets the this monkey's toggle if it can be disabled.

IDefiningConfigKey<bool>? EnabledToggle { get; }

Property Value

IDefiningConfigKey<bool>

The toggle config item if this monkey can be disabled; otherwise, null.

FeaturePatches

Gets the impacts this (pre-)patcher has on certain features ordered by descending impact.

IEnumerable<IFeaturePatch> FeaturePatches { get; }

Property Value

IEnumerable<IFeaturePatch>

Harmony

Gets the Harmony instance to be used by this patcher.

Harmony Harmony { get; }

Property Value

Harmony

Logger

Gets the Logger that this monkey can use to log messages to game-specific channels.

Logger Logger { get; }

Property Value

Logger

Mod

Gets the mod that this monkey is a part of.

Mod Mod { get; }

Property Value

Mod

Name

Gets the display name of this monkey.

string Name { get; }

Property Value

string

Type

Gets the runtime type of this monkey.

Type Type { get; }

Property Value

Type