Class ConfiguredResoniteMonkey<TMonkey, TConfigSection>

Namespace

MonkeyLoader.Resonite

Assembly

MonkeyLoader.Resonite.Integration.dll

Represents the base class for patchers that run after Resonite's assemblies have been loaded and that hook into the game's lifecycle, while using a TConfigSection ConfigSection.

public abstract class ConfiguredResoniteMonkey<TMonkey, TConfigSection> : ResoniteMonkey<TMonkey>, IResoniteMonkey, IConfiguredMonkey<TConfigSection>, IConfiguredMonkey, IMonkey, IRun, IShutdown, IComparable<IMonkey>, INestedIdentifiable<Mod>, INestedIdentifiable, IIdentifiable, IAuthorable, IDisplayable where TMonkey : ConfiguredResoniteMonkey<TMonkey, TConfigSection>, new() where TConfigSection : ConfigSection, new()

Type Parameters

TMonkey

The type of the actual patcher.

TConfigSection

The type of the config section to load.

Inheritance

object

MonkeyBase

MonkeyBase<TMonkey>

Monkey<TMonkey>

ResoniteMonkey<TMonkey>

ConfiguredResoniteMonkey<TMonkey, TConfigSection>

Implements

IResoniteMonkey

IConfiguredMonkey<TConfigSection>

IConfiguredMonkey

IMonkey

IRun

IShutdown

IComparable<IMonkey>

INestedIdentifiable<Mod>

INestedIdentifiable

IIdentifiable

IAuthorable

IDisplayable

Inherited Members

ResoniteMonkey<TMonkey>.EngineInitFailed

ResoniteMonkey<TMonkey>.EngineInitRan

ResoniteMonkey<TMonkey>.EngineReadyFailed

ResoniteMonkey<TMonkey>.EngineReadyRan

ResoniteMonkey<TMonkey>.OnEngineInit()

ResoniteMonkey<TMonkey>.OnEngineReady()

ResoniteMonkey<TMonkey>.OnEngineShutdownRequested(string)

Monkey<TMonkey>.Run()

Monkey<TMonkey>.LogPatches()

MonkeyBase<TMonkey>.Config

MonkeyBase<TMonkey>.Enabled

MonkeyBase<TMonkey>.Harmony

MonkeyBase<TMonkey>.Instance

MonkeyBase<TMonkey>.Logger

MonkeyBase<TMonkey>.Mod

MonkeyBase.CompareTo(IMonkey)

MonkeyBase.HasAuthor(string)

MonkeyBase.Shutdown(bool)

MonkeyBase.ToString()

MonkeyBase.GetFeaturePatches()

MonkeyBase.OnComputeDefaultEnabledState()

MonkeyBase.OnDisabled()

MonkeyBase.OnEnabled()

MonkeyBase.OnShutdown(bool)

MonkeyBase.ThrowIfRan()

MonkeyBase.AssemblyName

MonkeyBase.Authors

MonkeyBase.CanBeDisabled

MonkeyBase.Description

MonkeyBase.EnabledToggle

MonkeyBase.Failed

MonkeyBase.FeaturePatches

MonkeyBase.FullId

MonkeyBase.HasDescription

MonkeyBase.Id

MonkeyBase.Name

MonkeyBase.Ran

MonkeyBase.ShutdownFailed

MonkeyBase.ShutdownRan

MonkeyBase.Type

MonkeyBase.ShutdownDone

MonkeyBase.ShuttingDown

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LocaleExtensions.GetLocaleKey(IIdentifiable, string)

LocaleExtensions.GetLocaleString(IIdentifiable, string, bool, Dictionary<string, object>?)

LocaleExtensions.GetLocaleString(IIdentifiable, string, string?, bool, Dictionary<string, object>?)

LocaleExtensions.GetLocaleString(IIdentifiable, string, string, object)

LocaleExtensions.GetLocaleString(IIdentifiable, string, string, string, object)

LocaleExtensions.GetLocaleString(IIdentifiable, string, string, params (string, object)[])

LocaleExtensions.GetLocaleString(IIdentifiable, string, params (string, object)[])

LocaleExtensions.GetMessageInCurrent(IIdentifiable, string)

LocaleExtensions.GetMessageInFallback(IIdentifiable, string)

LocaleExtensions.GetMessageInLocale(IIdentifiable, string, LocaleResource)

Remarks

Game assemblies and their types can be directly referenced from these.
Contains useful overridable methods that are hooked to different points in the game's lifecycle.

Constructors

ConfiguredResoniteMonkey()

Allows creating only a single TMonkey instance.

protected ConfiguredResoniteMonkey()

Properties

ConfigSection

Gets the loaded config section for this patcher after it has been run.

public static TConfigSection ConfigSection { get; }

Property Value

TConfigSection

Methods

OnLoaded()

Called right after the game tooling packs and all the game's assemblies have been loaded.
Use this to apply any patching and return true if it was successful.

protected override bool OnLoaded()

Returns

bool

true if it ran successfully; otherwise, false.

Remarks

Override this method if you need to patch something involved in the initialization of the game.
For ResoniteMonkeys, the default behavior ofOnLoaded() is moved to OnEngineReady().

Strongly consider also overriding OnEngineReady() if you override this method.
Otherwise your patches will be applied twice, if you're using [HarmonyPatchCategory(nameof(MyPatcher))] attributes.

By default: Loads this patcher's TConfigSection ConfigSection and returns true.