Class ResoniteEventSourceMonkey<TMonkey, TEvent>

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.
Specifically, to act as an event source for TEvents.

public abstract class ResoniteEventSourceMonkey<TMonkey, TEvent> : ResoniteMonkey<TMonkey>, IResoniteMonkey, IMonkey, IRun, IShutdown, IComparable<IMonkey>, INestedIdentifiable<Mod>, INestedIdentifiable, IIdentifiable, IAuthorable, IDisplayable, IEventSource<TEvent> where TMonkey : ResoniteEventSourceMonkey<TMonkey, TEvent>, new() where TEvent : SyncEvent

Type Parameters

TMonkey

The type of the actual patcher.

TEvent

The SyncEvent type to dispatch.

Inheritance

object

MonkeyBase

MonkeyBase<TMonkey>

Monkey<TMonkey>

ResoniteMonkey<TMonkey>

ResoniteEventSourceMonkey<TMonkey, TEvent>

Implements

IResoniteMonkey

IMonkey

IRun

IShutdown

IComparable<IMonkey>

INestedIdentifiable<Mod>

INestedIdentifiable

IIdentifiable

IAuthorable

IDisplayable

IEventSource<TEvent>

Derived

ConfiguredResoniteEventSourceMonkey<TMonkey, TConfigSection, TEvent>

ConfiguredResoniteEventSourceMonkey<TMonkey, TConfigSection, TEvent1, TEvent2>

ResoniteEventSourceMonkey<TMonkey, TEvent1, TEvent2>

Inherited Members

ResoniteMonkey<TMonkey>.EngineInitFailed

ResoniteMonkey<TMonkey>.EngineInitRan

ResoniteMonkey<TMonkey>.EngineReadyFailed

ResoniteMonkey<TMonkey>.EngineReadyRan

ResoniteMonkey<TMonkey>.OnEngineInit()

ResoniteMonkey<TMonkey>.OnEngineShutdownRequested(string)

ResoniteMonkey<TMonkey>.OnLoaded()

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.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

ResoniteEventSourceMonkey()

Allows creating only a single TMonkey instance.

protected ResoniteEventSourceMonkey()

Methods

Dispatch(TEvent)

Dispatches the TEvent with the given data.

protected static void Dispatch(TEvent eventData)

Parameters

eventData TEvent

The event data to dispatch.

OnEngineReady()

Override this method to be called when the FrooxEngine.Engine is ready.
This is the primary method for patching used by Resonite Mods as basic facilities of the game are ready to use, while most other code hasn't been run yet.
Return true if patching was successful.

protected override bool OnEngineReady()

Returns

bool

Whether the patching was successful.

Remarks

Override OnLoaded() to patch before anything is initialized, but strongly consider also overriding this method if you do that.
Otherwise your patches will be applied twice, if you're using [HarmonyPatchCategory(nameof(MyPatcher))] attributes.

By default: Registers this Monkey as an event source and applies the Harmony patches of the category with this patcher's type's name.
Easy to apply by using [HarmonyPatchCategory(nameof(MyPatcher))] attribute.

OnShutdown(bool)

Lets this monkey cleanup and shutdown.

protected override bool OnShutdown(bool applicationExiting)

Parameters

applicationExiting bool

Whether the shutdown was caused by the application exiting.

Returns

bool

true if it ran successfully; otherwise, false.

Remarks

By default: Unregisters this monkey as an event source for TEvents and removes all Harmony patches done using this Monkey's Harmony instance, if not exiting, and returns true.