Class ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3>
- 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 async event handler for the TEvent generic parameter(s).
public abstract class ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3> : ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2>, IResoniteMonkey, IMonkey, IRun, IShutdown, IComparable<IMonkey>, INestedIdentifiable<Mod>, INestedIdentifiable, IIdentifiable, IAuthorable, IDisplayable, IAsyncEventHandler<TEvent1>, IAsyncEventHandler<TEvent2>, IAsyncEventHandler<TEvent3>, IPrioritizable where TMonkey : ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3>, new() where TEvent1 : AsyncEvent where TEvent2 : AsyncEvent where TEvent3 : AsyncEventType Parameters
TMonkeyThe type of the actual patcher.
TEvent1The first AsyncEvent type to handle.
TEvent2The second AsyncEvent type to handle.
TEvent3The third AsyncEvent type to handle.
- Inheritance
-
MonkeyBase<TMonkey>Monkey<TMonkey>ResoniteMonkey<TMonkey>ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1>ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2>ResoniteAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3>
- Implements
-
IAsyncEventHandler<TEvent1>IAsyncEventHandler<TEvent2>IAsyncEventHandler<TEvent3>
- 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
ResoniteAsyncEventHandlerMonkey()
Allows creating only a single TMonkey instance.
protected ResoniteAsyncEventHandlerMonkey()Methods
AppliesTo(TEvent3)
Determines whether the given event should be handled by this event handler based on its data.
protected virtual bool AppliesTo(TEvent3 eventData)Parameters
eventDataTEvent3An object containing all the relevant information for the event.
Returns
- bool
trueif this event handler applies to the event; otherwise,false.
Remarks
By default: Returns this monkey's Enabled state.
Handle(TEvent3)
Handles the given event based on its data, if AppliesTo returned true.
protected abstract Task Handle(TEvent3 eventData)Parameters
eventDataTEvent3An object containing all the relevant information for the applicable event.
Returns
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.
Easy to apply by using
[HarmonyPatchCategory(nameof(MyPatcher))] attribute.
OnShutdown(bool)
Lets this monkey cleanup and shutdown.
protected override bool OnShutdown(bool applicationExiting)Parameters
applicationExitingboolWhether the shutdown was caused by the application exiting.
Returns
- bool
trueif it ran successfully; otherwise,false.
Remarks
By default: Unregisters
this monkey as an event handler and removes all Harmony patches done
using this Monkey's Harmony instance,
if not exiting, and returns true.