Abstract
Readonly
eventReadonly
modProtected
registerCalled when the global data for this mod is retrieved from a field decorated with @Mod.globalData
.
The data that should be returned. Conventionally, this is an object of some kind. It must be JSON serializable.
This method is meant to be overridden. It is called internally.
Any existing data, or undefined
Called when the save data for this mod is retrieved from a field decorated with @Mod.saveData
.
The data that should be returned. Conventionally, this is an object of some kind. It must be JSON serializable.
This method is meant to be overridden. It is called internally.
Any existing data, or undefined
Protected
registerRegisters event handlers, injections, and bind handlers. This is called on the preLoad
event by default,
and the handlers are deregistered on the unload
event.
If you call this manually before preLoad
, it won't be called on preLoad
and it won't deregister on unload
.
Please note that registering handlers when the mod is initialized means that the handlers will remain registered even when the user is playing on a server that doesn't support the mod.
Rest
...untilEvents: (keyof IModEvents)[]Generated using TypeDoc
The prefix for this mod used in registrations. Example: A mod named
Debug Tools
would beModDebugTools