@wayward/types 2.11.6-beta.dev.20220502.1 → 2.12.0-beta

package/definitions/game/mod/BaseMod.d.ts

@@ -1,167 +1,168 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-import type { Events } from "event/EventEmitter";
-import EventEmitter from "event/EventEmitter";
-import type { IModEvents } from "mod/IMod";
-import type { ModRegistration } from "mod/ModRegistry";
-import { SYMBOL_MOD_REGISTRATIONS } from "mod/ModRegistry";
-import type Log from "utilities/Log";
-export declare enum ModRegistrationTime {
-    Inherit = 0,
-    Setup = 1,
-    Initialize = 2,
-    Load = 3
-}
-export interface IRegistry {
-    [SYMBOL_MOD_REGISTRATIONS]: ModRegistration[];
-}
-export declare abstract class BaseMod extends EventEmitter.Host<IModEvents> {
-    private readonly index;
-    private allocatedEnums;
-    private registeredPackets;
-    private readonly subRegistries;
-    private subscribedHandlers;
-    constructor(index: number);
-    getIndex(): number;
-    /**
-     * Returns the name of this mod.
-     */
-    getName(): string;
-    /**
-     * Returns the prefix for this mod used in registrations. Example: A mod named `Debug Tools` would be `ModDebugTools`
-     */
-    getPrefix(): string;
-    /**
-     * 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`
-     */
-    getRegistryName(name: string): string;
-    getLog(): Log;
-    getPath(): string;
-    loadFile(file: string): Promise<string | undefined>;
-    /**
-     * Called when the save data for this mod is retrieved from a field decorated with `@Mod.saveData`.
-     * @param data Any existing data, or `undefined`
-     * @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.
-     */
-    initializeSaveData(data: any): any;
-    /**
-     * Called when the global data for this mod is retrieved from a field decorated with `@Mod.globalData`.
-     * @param data Any existing data, or `undefined`
-     * @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.
-     */
-    initializeGlobalData(data: any): any;
-    /**
-     * 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*.
-     */
-    protected registerEventHandlers(...untilEvents: Array<keyof Events<this>>): void;
-    private deregisterEventHandlers;
-    /**
-     * Event handler for `ModEvent.Unallocate`.
-     */
-    private onUnallocate;
-    /**
-     * Event handler for `ModEvent.PreInitialize`.
-     *
-     * Handles registration of fields decorated with ` @Register.thing`, which occur at `ModRegistrationTime.Initialize`
-     */
-    private onBeforeInitialize;
-    /**
-     * Event handler for `ModEvent.PreLoad`.
-     *
-     * Handles registration of fields decorated with ` @Register.thing`, which occur at `ModRegistrationTime.Load`
-     */
-    private onBeforeLoad;
-    /**
-     * All mods by default are `IRegistry`s, and any fields decorated with ` @Register.registry(Class)` are constructed as `IRegistry`s.
-     *
-     * This method goes through all the "registrations" stored in `[SYMBOL_MOD_REGISTRATIONS]` on the registry (these are added by the
-     * ` @Register.thing` decorators) and actually registers them with the game.
-     *
-     * Since registrations can reference other registrations, each registration is mapped to a promise, which will resolve when it's
-     * completely registered (all registrations it depends upon are registered, and then it itself is registered).
-     *
-     * @param initializationStage There are three times in which registrations actually happen:
-     * 	1. `ModRegistrationTime.Initialize` — When the mod is enabled, or the game starts, if the mod is already enabled
-     * 	2. `ModRegistrationTime.Load` — When a world is loaded
-     * 	3. `ModRegistrationTime.Setup` — When the mod is set up
-     *
-     * Registrations which will only be used in saves are registered in `ModRegistrationTime.Load`.
-     * Registrations which need to be noted always, whether or not the mod is enabled (such as languages) are registered in `ModRegistrationTime.Setup`.
-     * All other registrations are registered in `ModRegistrationTime.Initialize`.
-     *
-     * This method will only initialize the registrations for the given time.
-     *
-     * @param registry The `IRegistry` to initialize.
-     *
-     * @returns When all registrations are complete.
-     */
-    private initializeRegistry;
-    /**
-     * Registers a registration in a registry. Wow™
-     *
-     * @param registry The `IRegistry` that the registration is from.
-     * @param registration A `ModRegistration` — This is a type alias for any possible interface that extends `IBaseRegistration`.
-     *
-     * ------
-     * 1. The registration is validated with `validateRegistration`. This is an asynchronous operation that replaces any references to
-     * other registrations with their values, once they are registered. See `validateRegistration` for more details.
-     * 2. The name of the registration is generated: `Mod<modname><registration.name (in pascal case, with all non-letters removed)>`
-     * 3. If the registration contains a `description` field, sets the `modIndex` property in the description to this mod's index.
-     * 4. If the registration is not "basic", IE: it needs to do something besides allocate an enum, it will have an entry in a switch
-     * block for its `registration.type`. If it doesn't, by default it just allocates the enum using `registrationTypeToEnumMap`.
-     */
-    private register;
-    /**
-     * All `@Register.thing` decorators that take arguments can reference other registrations via `Registry<Mod, Thing>().get("name")`.
-     * On the type side, that method returns `Thing`, but internally, a `Registry.Registered` instance is returned.
-     *
-     * @param registry The `IRegistry` that this registration is a part of.
-     * @param registration An `IModRegistration`, or an object descendant in an `IModRegistration`. This object will be looped through,
-     * and any values in it which are instances of `Registry.Registered` are asynchronously replaced with their registered values.
-     */
-    private validateRegistration;
-    /**
-     * @param registry The registry to get a property value from.
-     * @param property The property to get the value of.
-     */
-    private getRegistrationPropertyValue;
-    /**
-     * Resolves any promises waiting for this property (created by `getRegistrationId`) with the given value, then sets the property on
-     * the registry to the given value.
-     * @param registry The registry to set a property of.
-     * @param property The property to set the value of.
-     * @param value The value to set the property to.
-     */
-    private setRegistrationPropertyValue;
-    /**
-     * Allocates an enum for this mod.
-     * @param id The enum type.
-     * @param name The name of the enumeration value.
-     * @param objectValue An object to register with the enum. For example, all values in the creature enumeration have a corresponding
-     * `description` object.
-     * @param onAllocate A callback for when the enum has been allocated.
-     * @param onUnallocate A callback for when the enum has been unallocated.
-     */
-    private allocateEnum;
-    private addTerrainResource;
-}
-export default BaseMod;
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type { Events } from "event/EventEmitter";
+import EventEmitter from "event/EventEmitter";
+import type { IModEvents } from "mod/IMod";
+import type { ModRegistration } from "mod/ModRegistry";
+import { SYMBOL_MOD_REGISTRATIONS } from "mod/ModRegistry";
+import type Log from "utilities/Log";
+export declare enum ModRegistrationTime {
+    Inherit = 0,
+    Setup = 1,
+    Initialize = 2,
+    Load = 3
+}
+export interface IRegistry {
+    [SYMBOL_MOD_REGISTRATIONS]: ModRegistration[];
+}
+export declare abstract class BaseMod extends EventEmitter.Host<IModEvents> {
+    private readonly index;
+    private allocatedEnums;
+    private registeredPackets;
+    private readonly subRegistries;
+    private subscribedHandlers;
+    constructor(index: number);
+    getIndex(): number;
+    /**
+     * Returns the name of this mod.
+     */
+    getName(): string;
+    /**
+     * Returns the prefix for this mod used in registrations. Example: A mod named `Debug Tools` would be `ModDebugTools`
+     */
+    getPrefix(): string;
+    /**
+     * 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`
+     */
+    getRegistryName(name: string): string;
+    getLog(): Log;
+    getPath(): string;
+    getVersion(): string;
+    loadFile(file: string): Promise<string | undefined>;
+    /**
+     * Called when the save data for this mod is retrieved from a field decorated with `@Mod.saveData`.
+     * @param data Any existing data, or `undefined`
+     * @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.
+     */
+    initializeSaveData(data: any): any;
+    /**
+     * Called when the global data for this mod is retrieved from a field decorated with `@Mod.globalData`.
+     * @param data Any existing data, or `undefined`
+     * @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.
+     */
+    initializeGlobalData(data: any): any;
+    /**
+     * 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*.
+     */
+    protected registerEventHandlers(...untilEvents: Array<keyof Events<this>>): void;
+    private deregisterEventHandlers;
+    /**
+     * Event handler for `ModEvent.Unallocate`.
+     */
+    private onUnallocate;
+    /**
+     * Event handler for `ModEvent.PreInitialize`.
+     *
+     * Handles registration of fields decorated with ` @Register.thing`, which occur at `ModRegistrationTime.Initialize`
+     */
+    private onBeforeInitialize;
+    /**
+     * Event handler for `ModEvent.PreLoad`.
+     *
+     * Handles registration of fields decorated with ` @Register.thing`, which occur at `ModRegistrationTime.Load`
+     */
+    private onBeforeLoad;
+    /**
+     * All mods by default are `IRegistry`s, and any fields decorated with ` @Register.registry(Class)` are constructed as `IRegistry`s.
+     *
+     * This method goes through all the "registrations" stored in `[SYMBOL_MOD_REGISTRATIONS]` on the registry (these are added by the
+     * ` @Register.thing` decorators) and actually registers them with the game.
+     *
+     * Since registrations can reference other registrations, each registration is mapped to a promise, which will resolve when it's
+     * completely registered (all registrations it depends upon are registered, and then it itself is registered).
+     *
+     * @param initializationStage There are three times in which registrations actually happen:
+     * 	1. `ModRegistrationTime.Initialize` — When the mod is enabled, or the game starts, if the mod is already enabled
+     * 	2. `ModRegistrationTime.Load` — When a world is loaded
+     * 	3. `ModRegistrationTime.Setup` — When the mod is set up
+     *
+     * Registrations which will only be used in saves are registered in `ModRegistrationTime.Load`.
+     * Registrations which need to be noted always, whether or not the mod is enabled (such as languages) are registered in `ModRegistrationTime.Setup`.
+     * All other registrations are registered in `ModRegistrationTime.Initialize`.
+     *
+     * This method will only initialize the registrations for the given time.
+     *
+     * @param registry The `IRegistry` to initialize.
+     *
+     * @returns When all registrations are complete.
+     */
+    private initializeRegistry;
+    /**
+     * Registers a registration in a registry. Wow™
+     *
+     * @param registry The `IRegistry` that the registration is from.
+     * @param registration A `ModRegistration` — This is a type alias for any possible interface that extends `IBaseRegistration`.
+     *
+     * ------
+     * 1. The registration is validated with `validateRegistration`. This is an asynchronous operation that replaces any references to
+     * other registrations with their values, once they are registered. See `validateRegistration` for more details.
+     * 2. The name of the registration is generated: `Mod<modname><registration.name (in pascal case, with all non-letters removed)>`
+     * 3. If the registration contains a `description` field, sets the `modIndex` property in the description to this mod's index.
+     * 4. If the registration is not "basic", IE: it needs to do something besides allocate an enum, it will have an entry in a switch
+     * block for its `registration.type`. If it doesn't, by default it just allocates the enum using `registrationTypeToEnumMap`.
+     */
+    private register;
+    /**
+     * All `@Register.thing` decorators that take arguments can reference other registrations via `Registry<Mod, Thing>().get("name")`.
+     * On the type side, that method returns `Thing`, but internally, a `Registry.Registered` instance is returned.
+     *
+     * @param registry The `IRegistry` that this registration is a part of.
+     * @param registration An `IModRegistration`, or an object descendant in an `IModRegistration`. This object will be looped through,
+     * and any values in it which are instances of `Registry.Registered` are asynchronously replaced with their registered values.
+     */
+    private validateRegistration;
+    /**
+     * @param registry The registry to get a property value from.
+     * @param property The property to get the value of.
+     */
+    private getRegistrationPropertyValue;
+    /**
+     * Resolves any promises waiting for this property (created by `getRegistrationId`) with the given value, then sets the property on
+     * the registry to the given value.
+     * @param registry The registry to set a property of.
+     * @param property The property to set the value of.
+     * @param value The value to set the property to.
+     */
+    private setRegistrationPropertyValue;
+    /**
+     * Allocates an enum for this mod.
+     * @param id The enum type.
+     * @param name The name of the enumeration value.
+     * @param objectValue An object to register with the enum. For example, all values in the creature enumeration have a corresponding
+     * `description` object.
+     * @param onAllocate A callback for when the enum has been allocated.
+     * @param onUnallocate A callback for when the enum has been unallocated.
+     */
+    private allocateEnum;
+    private addTerrainResource;
+}
+export default BaseMod;

package/definitions/game/mod/IMod.d.ts

@@ -1,64 +1,64 @@
-/*!
- * Copyright 2011-2021 Unlok
- * https://www.unlok.ca
- *
- * Credits & Thanks:
- * https://www.unlok.ca/credits-thanks/
- *
- * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
- * https://github.com/WaywardGame/types/wiki
- */
-export declare enum MultiplayerCompatibility {
-    Clientside = "clientside",
-    Serverside = "serverside",
-    Compatible = "compatible",
-    Incompatible = "incompatible"
-}
-export interface IModConfig {
-    readonly name: string;
-    readonly description: string;
-    readonly version: string;
-    readonly author: string;
-    readonly file: string;
-    readonly unloadable?: boolean;
-    readonly tags?: string[];
-    readonly dependencies?: string[];
-    readonly waywardVersion?: string;
-    readonly multiplayer?: MultiplayerCompatibility;
-    readonly languages?: string[];
-    readonly stylesheets?: string[];
-    readonly imageOverrides?: boolean;
-    readonly customizations?: boolean;
-    readonly publishedFileId?: string;
-    readonly allowUnlockingMilestones?: boolean;
-    readonly github?: string;
-    readonly saveGameData?: boolean;
-}
-export interface IModEvents {
-    unload(): any;
-    uninitialize(): any;
-    /**
-     * Asynchronously triggered before a mod is initialized.
-     *
-     * Internally, this is used for mod registrations.
-     */
-    preInitialize(): any;
-    /**
-     * Asynchronously triggered before a mod is loaded (when a world is loaded).
-     *
-     * Internally, this is used for mod registrations.
-     */
-    preLoad(): any;
-    /**
-     * Called after a mod is unloaded. (A world is exited)
-     *
-     * Internally, this is used to clean up some mod registrations.
-     */
-    unallocate(): any;
-    /**
-     * Called when a mod is setup. (Modders — Don't use this, just run code in your constructor.)
-     *
-     * Internally, this is used for some mod registrations.
-     */
-    setup(): any;
-}
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+export declare enum MultiplayerCompatibility {
+    Clientside = "clientside",
+    Serverside = "serverside",
+    Compatible = "compatible",
+    Incompatible = "incompatible"
+}
+export interface IModConfig {
+    readonly name: string;
+    readonly description: string;
+    readonly version: string;
+    readonly author: string;
+    readonly file: string;
+    readonly unloadable?: boolean;
+    readonly tags?: string[];
+    readonly dependencies?: string[];
+    readonly waywardVersion?: string;
+    readonly multiplayer?: MultiplayerCompatibility;
+    readonly languages?: string[];
+    readonly stylesheets?: string[];
+    readonly imageOverrides?: boolean;
+    readonly customizations?: boolean;
+    readonly publishedFileId?: string;
+    readonly allowUnlockingMilestones?: boolean;
+    readonly github?: string;
+    readonly saveGameData?: boolean;
+}
+export interface IModEvents {
+    unload(): any;
+    uninitialize(): any;
+    /**
+     * Asynchronously triggered before a mod is initialized.
+     *
+     * Internally, this is used for mod registrations.
+     */
+    preInitialize(): any;
+    /**
+     * Asynchronously triggered before a mod is loaded (when a world is loaded).
+     *
+     * Internally, this is used for mod registrations.
+     */
+    preLoad(): any;
+    /**
+     * Called after a mod is unloaded. (A world is exited)
+     *
+     * Internally, this is used to clean up some mod registrations.
+     */
+    unallocate(): any;
+    /**
+     * Called when a mod is setup. (Modders — Don't use this, just run code in your constructor.)
+     *
+     * Internally, this is used for some mod registrations.
+     */
+    setup(): any;
+}