Class ConfiguredResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TConfigSection, 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 an async event handler for the cancelable TEvent generic parameter(s).
public abstract class ConfiguredResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TConfigSection, TEvent1, TEvent2, TEvent3, TEvent4> : ResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3, TEvent4>, IResoniteMonkey, ICancelableAsyncEventHandler<TEvent1>, ICancelableAsyncEventHandler<TEvent2>, ICancelableAsyncEventHandler<TEvent3>, ICancelableAsyncEventHandler<TEvent4>, IPrioritizable, IConfiguredMonkey<TConfigSection>, IConfiguredMonkey, IMonkey, IRun, IShutdown, IComparable<IMonkey>, INestedIdentifiable<Mod>, INestedIdentifiable, IIdentifiable, IAuthorable, IDisplayable where TMonkey : ConfiguredResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TConfigSection, TEvent1, TEvent2, TEvent3, TEvent4>, new() where TConfigSection : ConfigSection, new() where TEvent1 : CancelableAsyncEvent where TEvent2 : CancelableAsyncEvent where TEvent3 : CancelableAsyncEvent where TEvent4 : CancelableAsyncEvent
Type Parameters
TMonkeyThe type of the actual patcher.
TConfigSectionThe type of the config section to load.
TEvent1The first CancelableAsyncEvent type to handle.
TEvent2The second CancelableAsyncEvent type to handle.
TEvent3The third CancelableAsyncEvent type to handle.
TEvent4The fourth CancelableAsyncEvent type to handle.
- Inheritance
-
MonkeyBase<TMonkey>Monkey<TMonkey>ResoniteMonkey<TMonkey>ResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TEvent1>ResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2>ResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3>ResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TEvent1, TEvent2, TEvent3, TEvent4>ConfiguredResoniteCancelableAsyncEventHandlerMonkey<TMonkey, TConfigSection, TEvent1, TEvent2, TEvent3, TEvent4>
- Implements
-
ICancelableAsyncEventHandler<TEvent1>ICancelableAsyncEventHandler<TEvent2>ICancelableAsyncEventHandler<TEvent3>ICancelableAsyncEventHandler<TEvent4>IConfiguredMonkey<TConfigSection>
- 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
ConfiguredResoniteCancelableAsyncEventHandlerMonkey()
protected ConfiguredResoniteCancelableAsyncEventHandlerMonkey()
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
trueif 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().
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.