Table of Contents

Class ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2, TEvent3, TEvent4>

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 a cancelable event source for the TEvent generic parameter(s).

public abstract class ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2, TEvent3, TEvent4> : ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2, TEvent3>, IResoniteMonkey, IMonkey, IRun, IShutdown, IComparable<IMonkey>, INestedIdentifiable<Mod>, INestedIdentifiable, IIdentifiable, IAuthorable, ICancelableEventSource<TEvent1>, ICancelableEventSource<TEvent2>, ICancelableEventSource<TEvent3>, ICancelableEventSource<TEvent4> where TMonkey : ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2, TEvent3, TEvent4>, new() where TEvent1 : CancelableSyncEvent where TEvent2 : CancelableSyncEvent where TEvent3 : CancelableSyncEvent where TEvent4 : CancelableSyncEvent

Type Parameters

TMonkey

The type of the actual patcher.

TEvent1

The first CancelableSyncEvent type to dispatch.

TEvent2

The second CancelableSyncEvent type to dispatch.

TEvent3

The third CancelableSyncEvent type to dispatch.

TEvent4

The fourth CancelableSyncEvent type to dispatch.

Inheritance
MonkeyBase<TMonkey>
Monkey<TMonkey>
ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2>
ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2, TEvent3>
ResoniteCancelableEventSourceMonkey<TMonkey, TEvent1, TEvent2, TEvent3, TEvent4>
Implements
Derived
Inherited Members
Extension Methods

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

ResoniteCancelableEventSourceMonkey()

Allows creating only a single TMonkey instance.

protected ResoniteCancelableEventSourceMonkey()

Methods

Dispatch(TEvent4)

Dispatches the TEvent4 with the given data.

protected static void Dispatch(TEvent4 eventData)

Parameters

eventData TEvent4

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 [HarmonyLib.HarmonyPatchCategory(nameof(MyPatcher))] attributes.

By default: Registers this Monkey as an event source and applies the HarmonyLib.Harmony patches of the category with this patcher's type's name.
Easy to apply by using [HarmonyLib.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 HarmonyLib.Harmony patches done using this Monkey's Harmony instance, if not exiting, and returns true.

Edit this page