@wayward/types 2.11.5-beta.dev.20220324.1 → 2.11.6-beta

package/definitions/game/utilities/collection/map/PriorityMap.d.ts

@@ -1,45 +1,45 @@
-/*!
- * 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
- */
-/**
- * Used for ordering a list of items by "priority". Higher priorities come before lower priorities.
- */
-export declare class PriorityMap<T> {
-    static streamAll<T extends Iterable<any>>(...lists: Array<PriorityMap<T>>): import("@wayward/goodstream").default<T>;
-    private readonly priorities;
-    private readonly map;
-    get size(): number;
-    getOrDefault(priority: number): T | undefined;
-    getOrDefault(priority: number, orDefault: (priority: number) => T, assign?: boolean): T;
-    getOrDefault(priority: number, orDefault?: (priority: number) => T, assign?: boolean): T | undefined;
-    delete(priority: number): boolean;
-    /**
-     * Retains the entries from this set that match the given predicate function, any other entries will be deleted.
-     * @param predicate A predicate that takes a key and a value, and returns a value which will be checked for truthiness.
-     * @returns whether any entries remain.
-     */
-    retainWhere(predicate: (val: T, key: number) => any): boolean;
-    /**
-     * If this map contains the given key, checks whether the entry matches the given predicate.
-     * If it does, it is kept. If not, it's deleted.
-     * @param predicate A predicate that takes a key and a value, and returns a value which will be checked for truthiness.
-     * @returns whether any entries remain in this map.
-     */
-    retainWhere(key: number, predicate: (val: T, key: number) => any): boolean;
-    /**
-     * Returns an iterator of the items in this list.
-     */
-    stream(direction?: PriorityListStreamDirection): import("@wayward/goodstream").default<T>;
-    getInternalMap(): Record<number, T>;
-}
-export declare enum PriorityListStreamDirection {
-    HighestToLowest = -1,
-    LowestToHighest = 1
-}
+/*!
+ * 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
+ */
+/**
+ * Used for ordering a list of items by "priority". Higher priorities come before lower priorities.
+ */
+export declare class PriorityMap<T> {
+    static streamAll<T extends Iterable<any>>(...lists: Array<PriorityMap<T>>): import("@wayward/goodstream").default<T>;
+    private readonly priorities;
+    private readonly map;
+    get size(): number;
+    getOrDefault(priority: number): T | undefined;
+    getOrDefault(priority: number, orDefault: (priority: number) => T, assign?: boolean): T;
+    getOrDefault(priority: number, orDefault?: (priority: number) => T, assign?: boolean): T | undefined;
+    delete(priority: number): boolean;
+    /**
+     * Retains the entries from this set that match the given predicate function, any other entries will be deleted.
+     * @param predicate A predicate that takes a key and a value, and returns a value which will be checked for truthiness.
+     * @returns whether any entries remain.
+     */
+    retainWhere(predicate: (val: T, key: number) => any): boolean;
+    /**
+     * If this map contains the given key, checks whether the entry matches the given predicate.
+     * If it does, it is kept. If not, it's deleted.
+     * @param predicate A predicate that takes a key and a value, and returns a value which will be checked for truthiness.
+     * @returns whether any entries remain in this map.
+     */
+    retainWhere(key: number, predicate: (val: T, key: number) => any): boolean;
+    /**
+     * Returns an iterator of the items in this list.
+     */
+    stream(direction?: PriorityListStreamDirection): import("@wayward/goodstream").default<T>;
+    getInternalMap(): Record<number, T>;
+}
+export declare enum PriorityListStreamDirection {
+    HighestToLowest = -1,
+    LowestToHighest = 1
+}

package/definitions/game/utilities/collection/map/StackMap.d.ts

@@ -1,15 +1,15 @@
-/*!
- * 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 default class StackMap<K, V> extends Map<K, V> {
-    private readonly maxSize;
-    constructor(entries?: ReadonlyArray<readonly [K, V]> | null, maxSize?: number);
-    set(key: K, value: V): this;
-}
+/*!
+ * 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 default class StackMap<K, V> extends Map<K, V> {
+    private readonly maxSize;
+    constructor(entries?: ReadonlyArray<readonly [K, V]> | null, maxSize?: number);
+    set(key: K, value: V): this;
+}

package/definitions/game/utilities/collection/queue/PriorityQueue.d.ts

@@ -1,25 +1,25 @@
-/*!
- * 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 PriorityQueueType {
-    LowestToHighest = 0,
-    HighestToLowest = 1
-}
-export default class PriorityQueue<T> {
-    readonly type: PriorityQueueType;
-    private head;
-    private length;
-    constructor(type: PriorityQueueType);
-    getLength(): number;
-    isEmpty(): boolean;
-    push(data: T, priority: number): void;
-    pop(): T | undefined;
-    entries(): IterableIterator<T>;
-}
+/*!
+ * 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 PriorityQueueType {
+    LowestToHighest = 0,
+    HighestToLowest = 1
+}
+export default class PriorityQueue<T> {
+    readonly type: PriorityQueueType;
+    private head;
+    private length;
+    constructor(type: PriorityQueueType);
+    getLength(): number;
+    isEmpty(): boolean;
+    push(data: T, priority: number): void;
+    pop(): T | undefined;
+    entries(): IterableIterator<T>;
+}

package/definitions/game/utilities/collection/queue/Queue.d.ts

@@ -1,20 +1,20 @@
-/*!
- * 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 default class Queue<T> {
-    private queue;
-    private offset;
-    constructor(initial?: T[]);
-    getLength(): number;
-    isEmpty(): boolean;
-    enqueue(value: T): void;
-    dequeue(): T | undefined;
-    isInQueue(item: T, equals?: (item1: T, item2: T) => boolean): boolean;
-}
+/*!
+ * 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 default class Queue<T> {
+    private queue;
+    private offset;
+    constructor(initial?: T[]);
+    getLength(): number;
+    isEmpty(): boolean;
+    enqueue(value: T): void;
+    dequeue(): T | undefined;
+    isInQueue(item: T, equals?: (item1: T, item2: T) => boolean): boolean;
+}

package/definitions/game/utilities/collection/set/HashSet.d.ts

@@ -1,45 +1,45 @@
-/*!
- * 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 default class HashSet<T> {
-    private readonly hash;
-    private readonly internalMap;
-    get size(): number;
-    constructor(hash: (value: T) => string);
-    add(...values: T[]): this;
-    addAll(...valuesIterables: Array<Iterable<T> | Falsy>): this;
-    /**
-     * Adds the given values to the set, first removing any values that share the same hashes.
-     */
-    replace(...values: T[]): this;
-    /**
-     * Adds the given values to the set, first removing any values that share the same hashes.
-     */
-    replaceAll(...valuesIterables: Array<Iterable<T> | Falsy>): this;
-    remove(...values: T[]): boolean;
-    removeAll(...valuesIterables: Array<Iterable<T> | Falsy>): boolean;
-    toggle(has: boolean, ...values: T[]): this;
-    toggleAll(has: boolean, ...valuesIterables: Array<Iterable<T> | Falsy>): this;
-    has(...values: T[]): boolean;
-    hasAll(...valuesIterables: Array<Iterable<T> | Falsy>): boolean;
-    clear(): this;
-    keys(): IterableIterator<string>;
-    values(): IterableIterator<T>;
-    entries(): IterableIterator<[string, T]>;
-    keyStream(): import("@wayward/goodstream").default<string>;
-    valueStream(): import("@wayward/goodstream").default<T>;
-    entryStream(): T extends T ? import("@wayward/goodstream").default<[string, T]> : never;
-    forEach(consumer: (value: T, key: string) => any): void;
-    [Symbol.iterator](): IterableIterator<T>;
-    toArray(): T[];
-    retainNot(value: T): boolean;
-    get(hash: string): T | undefined;
-    intersects(set: HashSet<T>): boolean;
-}
+/*!
+ * 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 default class HashSet<T> {
+    private readonly hash;
+    private readonly internalMap;
+    get size(): number;
+    constructor(hash: (value: T) => string);
+    add(...values: T[]): this;
+    addAll(...valuesIterables: Array<Iterable<T> | Falsy>): this;
+    /**
+     * Adds the given values to the set, first removing any values that share the same hashes.
+     */
+    replace(...values: T[]): this;
+    /**
+     * Adds the given values to the set, first removing any values that share the same hashes.
+     */
+    replaceAll(...valuesIterables: Array<Iterable<T> | Falsy>): this;
+    remove(...values: T[]): boolean;
+    removeAll(...valuesIterables: Array<Iterable<T> | Falsy>): boolean;
+    toggle(has: boolean, ...values: T[]): this;
+    toggleAll(has: boolean, ...valuesIterables: Array<Iterable<T> | Falsy>): this;
+    has(...values: T[]): boolean;
+    hasAll(...valuesIterables: Array<Iterable<T> | Falsy>): boolean;
+    clear(): this;
+    keys(): IterableIterator<string>;
+    values(): IterableIterator<T>;
+    entries(): IterableIterator<[string, T]>;
+    keyStream(): import("@wayward/goodstream").default<string>;
+    valueStream(): import("@wayward/goodstream").default<T>;
+    entryStream(): T extends T ? import("@wayward/goodstream").default<[string, T]> : never;
+    forEach(consumer: (value: T, key: string) => any): void;
+    [Symbol.iterator](): IterableIterator<T>;
+    toArray(): T[];
+    retainNot(value: T): boolean;
+    get(hash: string): T | undefined;
+    intersects(set: HashSet<T>): boolean;
+}

package/definitions/game/utilities/collection/sort/Sorter.d.ts

@@ -1,43 +1,43 @@
-/*!
- * 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
- */
-declare type EntryMapper<T = any, R = any, A extends any[] = any[]> = (v: T, ...args: A) => R;
-declare type SortFallback<T = any, R = any, A extends any[] = any[]> = (a: T, b: T, valueA: R, valueB: R, ...args: A) => number;
-export interface ISorter<T, R> {
-    (a: T, b: T): number;
-    /**
-     * Sets this sort to be reversed
-     */
-    setReverse(): this;
-    /**
-     * Sets whether this sort should be reversed
-     */
-    setReverse(reverse: boolean): this;
-    /**
-     * Sets a fallback sorter for when two items are in the same position
-     */
-    addFallback<A extends any[]>(fallback?: SortFallback<T, R, A>, ...args: A): this;
-    /**
-     * Sets a custom sorter to override the default sort functionality
-     *
-     * Note: When a custom sorter is used, fallbacks registered in `setFallback` will not be.
-     */
-    setSorter<A extends any[]>(sorter?: SortFallback<T, R, A>, ...args: A): this;
-    /**
-     * Sets a custom entry mapper, which takes an item to sort and returns a string or number representing its "sort value",
-     * which is what is *actually* compared.
-     *
-     * These values are cached by the sorter
-     */
-    setMapper<A extends any[]>(mapper: EntryMapper<T, R, A>, ...args: A): this;
-}
-export default function <T extends string | number>(): ISorter<T, T>;
-export default function <T, R, A extends any[]>(mapper?: EntryMapper<T, R, A>, ...args: A): ISorter<T, R>;
-export {};
+/*!
+ * 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
+ */
+declare type EntryMapper<T = any, R = any, A extends any[] = any[]> = (v: T, ...args: A) => R;
+declare type SortFallback<T = any, R = any, A extends any[] = any[]> = (a: T, b: T, valueA: R, valueB: R, ...args: A) => number;
+export interface ISorter<T, R> {
+    (a: T, b: T): number;
+    /**
+     * Sets this sort to be reversed
+     */
+    setReverse(): this;
+    /**
+     * Sets whether this sort should be reversed
+     */
+    setReverse(reverse: boolean): this;
+    /**
+     * Sets a fallback sorter for when two items are in the same position
+     */
+    addFallback<A extends any[]>(fallback?: SortFallback<T, R, A>, ...args: A): this;
+    /**
+     * Sets a custom sorter to override the default sort functionality
+     *
+     * Note: When a custom sorter is used, fallbacks registered in `setFallback` will not be.
+     */
+    setSorter<A extends any[]>(sorter?: SortFallback<T, R, A>, ...args: A): this;
+    /**
+     * Sets a custom entry mapper, which takes an item to sort and returns a string or number representing its "sort value",
+     * which is what is *actually* compared.
+     *
+     * These values are cached by the sorter
+     */
+    setMapper<A extends any[]>(mapper: EntryMapper<T, R, A>, ...args: A): this;
+}
+export default function <T extends string | number>(): ISorter<T, T>;
+export default function <T, R, A extends any[]>(mapper?: EntryMapper<T, R, A>, ...args: A): ISorter<T, R>;
+export {};

package/definitions/game/utilities/dependency/DependencyManager.d.ts

@@ -1,21 +1,21 @@
-/*!
- * 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 EventEmitter from "event/EventEmitter";
-export interface IRequireFunction {
-    <T>(module: string): Promise<T>;
-    <T extends any[]>(...modules: string[]): Promise<T>;
-}
-export interface IDependencyManagerEvents {
-    acquire(require: IRequireFunction): Promise<any>;
-}
-export default class DependencyManager extends EventEmitter.Host<IDependencyManagerEvents> {
-    acquireDependencies(): Promise<void>;
-}
+/*!
+ * 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 EventEmitter from "event/EventEmitter";
+export interface IRequireFunction {
+    <T>(module: string): Promise<T>;
+    <T extends any[]>(...modules: string[]): Promise<T>;
+}
+export interface IDependencyManagerEvents {
+    acquire(require: IRequireFunction): Promise<any>;
+}
+export default class DependencyManager extends EventEmitter.Host<IDependencyManagerEvents> {
+    acquireDependencies(): Promise<void>;
+}

package/definitions/game/utilities/dev/Performance2.d.ts

@@ -1,18 +1,18 @@
-/*!
- * 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 default class Performance2 {
-    private readonly fns;
-    private _args;
-    args(...args: any[]): this;
-    eachArgs(generator: () => any[]): this;
-    add(fn: AnyFunction): this;
-    compare(count?: number): void;
-}
+/*!
+ * 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 default class Performance2 {
+    private readonly fns;
+    private _args;
+    args(...args: any[]): this;
+    eachArgs(generator: () => any[]): this;
+    add(fn: AnyFunction): this;
+    compare(count?: number): void;
+}

package/definitions/game/utilities/dev/Reflection.d.ts

@@ -1,57 +1,57 @@
-/*!
- * 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
- */
-/**
- * Access the instance of this console utility with the global variable `Reflection`.
- * For information on using the utility, see the method JSDocs.
- *
- * Note: Reflection is intended to be used exclusively as a console utility, its operations aren't particularly performant,
- * so there are no types for the instance exposed.
- */
-export default class Reflection {
-    private readonly definedModules;
-    /**
-     * On failure, whether or not the log should include each "did you mean" result's "closeness" to what argument was given.
-     * Defaults to not display.
-     */
-    showCloseness: boolean;
-    /**
-     * On failure, the number of "did you mean" results that should be displayed.
-     * Defaults to 4.
-     */
-    maxCloseMatches: number;
-    private lastQueryCloseMatches;
-    /**
-     * The list of previous "did you mean" matches for the last failed query. Also stored in the global variable `$r`.
-     */
-    get lastQuery(): readonly any[];
-    constructor(definedModules: Record<string, any>);
-    /**
-     * Retrieves a module given its name.
-     * @param name The name of the module. This can be the full path, or it can be just the module name itself.
-     * If there are two modules with the same name, but different paths, you will have to use the full path to access either.
-     */
-    module(name: string): any;
-    /**
-     * Retrieves an export from any module given its name.
-     * @param name The name of the export. Default exports for modules can be retrieved with the module name.
-     * Note: If multiple exports match the name, retrieval will fail. In that case, use the overload to provide the `which` parameter.
-     */
-    export(name: string): any;
-    /**
-     * Retrieves an export from any module given its name.
-     * @param name The name of the export. Default exports for modules can be retrieved with the module name.
-     * @param which A number, the index of the export in the list of exports matching the given name, sorted by how "close" each export's name is.
-     * Note: For exports where only one matches, the discriminator `which` parameter is unnecessary.
-     */
-    export(name: string, which: number): any;
-    private warn;
-    private setLastQueryCloseMatches;
-}
+/*!
+ * 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
+ */
+/**
+ * Access the instance of this console utility with the global variable `Reflection`.
+ * For information on using the utility, see the method JSDocs.
+ *
+ * Note: Reflection is intended to be used exclusively as a console utility, its operations aren't particularly performant,
+ * so there are no types for the instance exposed.
+ */
+export default class Reflection {
+    private readonly definedModules;
+    /**
+     * On failure, whether or not the log should include each "did you mean" result's "closeness" to what argument was given.
+     * Defaults to not display.
+     */
+    showCloseness: boolean;
+    /**
+     * On failure, the number of "did you mean" results that should be displayed.
+     * Defaults to 4.
+     */
+    maxCloseMatches: number;
+    private lastQueryCloseMatches;
+    /**
+     * The list of previous "did you mean" matches for the last failed query. Also stored in the global variable `$r`.
+     */
+    get lastQuery(): readonly any[];
+    constructor(definedModules: Record<string, any>);
+    /**
+     * Retrieves a module given its name.
+     * @param name The name of the module. This can be the full path, or it can be just the module name itself.
+     * If there are two modules with the same name, but different paths, you will have to use the full path to access either.
+     */
+    module(name: string): any;
+    /**
+     * Retrieves an export from any module given its name.
+     * @param name The name of the export. Default exports for modules can be retrieved with the module name.
+     * Note: If multiple exports match the name, retrieval will fail. In that case, use the overload to provide the `which` parameter.
+     */
+    export(name: string): any;
+    /**
+     * Retrieves an export from any module given its name.
+     * @param name The name of the export. Default exports for modules can be retrieved with the module name.
+     * @param which A number, the index of the export in the list of exports matching the given name, sorted by how "close" each export's name is.
+     * Note: For exports where only one matches, the discriminator `which` parameter is unnecessary.
+     */
+    export(name: string, which: number): any;
+    private warn;
+    private setLastQueryCloseMatches;
+}