Class defaultAbstract

Hierarchy

Constructors

constructor

Properties

event index registerEventHandlersOnPreLoad

Accessors

log name path prefix version

Methods

getIndex getLog getName getPath getPrefix getRegistryName getVersion initializeGlobalData initializeSaveData loadFile onInitialize onLoad onUninitialize onUninitialized onUnload registerEventHandlers

Constructors

constructor

Properties

Readonly event

event: IEventEmitter<default, IModEvents> = ...

Readonly index

index: number

Protected registerEventHandlersOnPreLoad

registerEventHandlersOnPreLoad: boolean = true

Accessors

log

  • get log(): default

  • Returns default

name

  • get name(): string

  • Returns string

path

  • get path(): string

  • Returns string

prefix

  • get prefix(): string

  • The prefix for this mod used in registrations. Example: A mod named Debug Tools would be ModDebugTools

    Returns string

version

  • get version(): string

  • Returns string

Methods

getIndex

  • Deprecated

    Use the index property

    Returns number

getLog

getName

  • Returns the name of this mod.

    Deprecated

    Use the name property

    Returns string

getPath

  • Deprecated

    Use the path property

    Returns string

getPrefix

  • Returns the prefix for this mod used in registrations. Example: A mod named Debug Tools would be ModDebugTools

    Deprecated

    Use the prefix property

    Returns string

getRegistryName

  • Returns the full registry name for the given registration name, concatenating the mod registration prefix. Example: A mod named Debug Tools registering Cool Thingy would be ModDebugToolsCoolThingy

    Parameters

    • name: string

    Returns string

getVersion

  • Deprecated

    Use the version property

    Returns string

initializeGlobalData

  • Called when the global data for this mod is retrieved from a field decorated with @Mod.globalData.

    Returns

    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.

    Parameters

    • data: any

      Any existing data, or undefined

    Returns any

initializeSaveData

  • Called when the save data for this mod is retrieved from a field decorated with @Mod.saveData.

    Returns

    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.

    Parameters

    • data: any

      Any existing data, or undefined

    Returns any

loadFile

  • Parameters

    • file: string

    Returns Promise<undefined | string>

onInitialize

  • Called when the mod is initialized (when it's enabled via the Mod Manager)

    Returns void

onLoad

  • Called when the mod is loaded. This will be called after a player starts a game (ran before resources & the world are setup)

    Returns void

onUninitialize

  • Called before the mod is uninitialized (when it's disabled via the Mod Manager)

    Returns void

onUninitialized

  • Called after the mod is uninitialized

    Returns void

onUnload

  • Called when the mod is unloaded

    Returns void

Protected registerEventHandlers

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

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc