@wayward/types 2.11.0-beta.dev.20211202.1 → 2.11.0-beta.dev.20211205.2

package/definitions/game/renderer/Renderer.d.ts

@@ -21,7 +21,7 @@ export default class Renderer extends EventEmitter.Host<IRendererEvents> {
     readonly id: number;
     readonly worldRenderer: WorldRenderer;
     private fadeInTime;
-    private thumbnailResolve?;
+    private thumbnailResolve;
     private ambientLightLevelCache;
     private updateRendering;
     private animationTimer;

package/definitions/game/save/serializer/Serializer.d.ts

@@ -14,6 +14,7 @@ import StringTokenizer from "save/serializer/StringTokenizer";
 export default class Serializer implements ISerializer {
     private readonly options;
     private readonly stringTokenizer?;
+    static convertStringToUint8Array(data: string): Uint8Array;
     private static array;
     private static usingArray;
     private static readonly savedObjectCache;

package/definitions/game/ui/input/InputManager.d.ts

@@ -110,7 +110,14 @@ declare class InputManager extends EventEmitter.Host<IInputManagerEvents> {
      */
     extractModifiers(evt: Event): Set<Modifier> | undefined;
     getCatalyst(evt: Event): InputCatalyst | undefined;
+    /**
+     * @param disabler Each `disableUntil` call should be given a unique `disabler`,
+     * as this system uses the timing from the latest `disableUntil` call
+     */
     disableUntil(until: number | Promise<any>, disabler: string): void;
+    /**
+     * @param disabler Each `disable` call should be given a unique `disabler`
+     */
     disable(disabler: string): boolean;
     enable(disabler: string): void;
     isDisabled(): boolean;

package/definitions/game/ui/old/screens/InGameScreen.d.ts

@@ -165,7 +165,7 @@ export default class InGameScreen extends BaseScreen {
     setQuickSlotByContextAction(quickSlot: number, action: IContextMenuAction): void;
     addItemToFreeQuickSlot(itemId: number): boolean;
     clearQuickSlot(quickSlot: number, internal?: boolean): void;
-    removeItemFromQuickSlot(itemId?: number, skipSync?: boolean): void;
+    removeItemFromQuickSlot(quickSlot: number, itemId?: number, skipSync?: boolean): void;
     setItemQuickslot(item: Item, quickSlot: number | undefined): void;
     updateQuickSlotItem(quickSlot: number): boolean;
     onUpdateQuickSlotsOrEquips(): void;

package/definitions/game/ui/screen/Screen.d.ts

@@ -31,13 +31,14 @@ export default abstract class Screen extends Component {
     log: Log;
     private contextMenu?;
     private mouse;
-    get background(): Background;
-    set background(background: Background);
     readonly menus: MenuManager;
     dialogs: DialogManager;
     visibleDialogs: IDialogStates;
     constructor(type: ScreenId);
     remove(): this;
+    getBackground(): Background;
+    setBackground(background: Background): this;
+    removeBackground(): this;
     /**
      * Remove the context menu from this element
      */

package/definitions/game/ui/screen/screens/game/InspectionsTooltipHandler.d.ts

@@ -21,7 +21,7 @@ export default abstract class InspectionsTooltipHandler<INSPECTIONS_LIST extends
         showExtraInfo?: Text;
     } | undefined;
     private lastMousePosition?;
-    initializeTooltip(tooltip: Tooltip): Tooltip | undefined;
+    initializeTooltip(tooltip: Tooltip): Promise<void>;
     remove(): void;
     protected abstract initializeInspections(): INSPECTIONS_LIST | undefined;
     protected onUpdateTooltipPosition(position: Vector2): void;

package/definitions/game/ui/screen/screens/game/component/CanvasDialog.d.ts

@@ -80,6 +80,7 @@ export default class CanvasDialog extends Dialog {
     protected buttonSurface: Component<HTMLElement>;
     protected drawer: Component<HTMLElement>;
     constructor(id: DialogId);
+    protected onCanvasDialogRemove(): void;
     setZoomLevels(levels: Iterable<number>): this;
     get isHovering(): boolean;
     getMousePosition(): Vector2;
@@ -99,6 +100,7 @@ export default class CanvasDialog extends Dialog {
     private dragStart;
     private drag;
     private dragEnd;
+    private removeDragEventListeners;
     protected onCanvasClick(): void;
     private getAbsoluteMousePosition;
     protected rotateClockwise(): void;

package/definitions/game/ui/screen/screens/game/component/GameDetails.d.ts

@@ -26,6 +26,7 @@ export declare class GameDetails extends Component implements IGameIconsHost, IG
     readonly gameModifiers: GameModifiers;
     readonly gameIcons: GameIcons;
     questsWrapper?: Component;
+    private refreshGameIconsTimeout?;
     private steamworksFriends;
     constructor(island: Island);
     lockHidden(): this;

package/definitions/game/ui/screen/screens/game/component/InspectionsList.d.ts

@@ -12,9 +12,11 @@ import type { Events, IEventEmitter } from "event/EventEmitter";
 import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
 import type { InspectType } from "game/inspection/IInspection";
 import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
+import type Inspection from "game/inspection/Inspection";
 import type InspectionsHandler from "game/inspection/InspectionsHandler";
 import Component from "ui/component/Component";
 import type { TranslationGenerator } from "ui/component/IComponent";
+import type HashSet from "utilities/collection/set/HashSet";
 export interface ITileInspectionsEvents extends Events<Component> {
     refreshed(isValid?: boolean): any;
     updateInspectTypeFilter(): any;
@@ -26,6 +28,7 @@ export default abstract class InspectionsList<INSPECTIONS_HANDLER extends Inspec
     private readonly paragraphInspectionsInvalid;
     private inspectTypeFilter;
     protected inspectionsHandler?: InspectionsHandler;
+    protected inspectionsHandlerUpdatedInspectionsCallback?: (_: any, inspectType: InspectType, inspections: HashSet<Inspection<any>>, oldInspections: HashSet<Inspection<any>> | undefined) => Promise<void>;
     private displayLevel;
     private refreshingId?;
     private readonly inspectTypeWrappers;
@@ -38,6 +41,7 @@ export default abstract class InspectionsList<INSPECTIONS_HANDLER extends Inspec
     protected abstract initializeInspections(): INSPECTIONS_HANDLER | undefined;
     isValid?(): boolean;
     protected getInvalidTranslation?(): TranslationGenerator | undefined;
+    private deregisterInspectionsHandler;
     private refreshInspectionsOfType;
     private initializeTooltipSection;
 }

package/definitions/game/ui/screen/screens/game/static/Messages.d.ts

@@ -75,6 +75,7 @@ export default class Messages extends QuadrantComponent {
     onReadNote(player: Player, id: number): void;
     onFocusChat(): boolean;
     getDefaultFilterName(filter: MessageFilterDefault): string;
+    protected onAppend(): void;
     protected onChangeQuadrant(): void;
     /**
      * Event handler for when the text in the chat box should be sent as a message.

package/definitions/game/ui/screen/screens/menu/MenuManager.d.ts

@@ -8,11 +8,17 @@
  * 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";
 import type Screen from "ui/screen/Screen";
 import { MenuId } from "ui/screen/screens/menu/component/IMenu";
 import Menu from "ui/screen/screens/menu/component/Menu";
 import type { MenuById } from "ui/screen/screens/menu/MenuMap";
-export default class MenuManager {
+export interface IMenuManagerEvents {
+    init(menu: Menu): any;
+    show(menu: Menu): any;
+    hide(menu: Menu): any;
+}
+export default class MenuManager extends EventEmitter.Host<IMenuManagerEvents> {
     allowNoMenus: boolean;
     all: Record<number, Menu>;
     chain: Menu[];
@@ -39,4 +45,8 @@ export default class MenuManager {
      * Sets the given menu to be the new top menu. (Removes super-menus, keeps sub-menus)
      */
     setTop(menu: Menu): this;
+    /**
+     * Returns a promise that resolves when the given screen is shown.
+     */
+    await<MENU extends MenuId>(menuId: MENU): Promise<MenuById[MENU]>;
 }

package/definitions/game/ui/tooltip/TooltipManager.d.ts

@@ -18,7 +18,7 @@ export default class TooltipManager {
     private current;
     private readonly disablers;
     constructor();
-    show(host: HTMLElement): Tooltip | undefined;
+    show(host: HTMLElement, initialize?: (tooltip: Tooltip) => any): Tooltip | undefined;
     hide(host?: HTMLElement | undefined): void;
     /**
      * Disables tooltips.

package/definitions/game/utilities/Log.d.ts

@@ -69,16 +69,17 @@ export declare enum LogSource {
     TemperatureManager = 56,
     TileEventManager = 57,
     TileUpdate = 58,
-    Trello = 59,
-    Ui = 60,
-    Utilities = 61,
-    WebAssembly = 62,
-    WebGlContext = 63,
-    WebRTCConnection = 64,
-    WebSocketConnection = 65,
-    World = 66,
-    WorldLayerRenderer = 67,
-    WorldRenderer = 68
+    Timer = 59,
+    Trello = 60,
+    Ui = 61,
+    Utilities = 62,
+    WebAssembly = 63,
+    WebGlContext = 64,
+    WebRTCConnection = 65,
+    WebSocketConnection = 66,
+    World = 67,
+    WorldLayerRenderer = 68,
+    WorldRenderer = 69
 }
 export declare enum LogLineType {
     Debug = 0,

package/definitions/game/utilities/Timer.d.ts

@@ -0,0 +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
+ */
+/// <reference types="node" />
+import { ExpectedLifetime } from "utilities/memory/ILifetime";
+declare module Timer {
+    function apply(): void;
+    function printActiveTimers(expectedLifetime: ExpectedLifetime): void;
+    /**
+     * Creates a timeout with the provided expected lifetime
+     */
+    function createTimeout(callback: (...args: any[]) => void, ms: number, expectedLifetime: ExpectedLifetime): NodeJS.Timer;
+    /**
+     * Creates an interval with the provided expected lifetime
+     */
+    function createInterval(callback: (...args: any[]) => void, ms: number, expectedLifetime: ExpectedLifetime): NodeJS.Timer;
+}
+export default Timer;

package/definitions/game/utilities/memory/ILifetime.d.ts

@@ -0,0 +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 declare enum ExpectedLifetime {
+    /**
+     * should always exist
+     */
+    Always = 0,
+    /**
+     * should only exist while playing the game
+     */
+    WhilePlaying = 1
+}

package/definitions/game/utilities/memory/IMemoryLeakDetector.d.ts

@@ -8,12 +8,7 @@
  * 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 ExpectedLifetime {
-    /**
-     * Object should only exist while playing the game
-     */
-    WhilePlaying = 0
-}
+import { ExpectedLifetime } from "utilities/memory/ILifetime";
 export declare const SYMBOL_MEMORY_LEAK_DETECTOR_PROPERTIES: unique symbol;
 export declare const SYMBOL_MEMORY_LEAK_DETECTOR_EXPECTED_LIFETIME: unique symbol;
 export declare function DetectMemoryLeaks(expectedLifetime?: ExpectedLifetime): PropertyDecorator;

package/definitions/game/utilities/memory/MemoryLeakDetector.d.ts

@@ -8,7 +8,7 @@
  * 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 { ExpectedLifetime } from "utilities/memory/IMemoryLeakDetector";
+import { ExpectedLifetime } from "utilities/memory/ILifetime";
 declare class MemoryLeakDetector {
     private surpressLogs;
     private nextObjectId;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.11.0-beta.dev.20211202.1",
+	"version": "2.11.0-beta.dev.20211205.2",
 	"license": "MIT",
 	"repository": {
 		"type": "git",

package/tsconfig.mod.base.json

@@ -31,7 +31,8 @@
             "DOM.Iterable",
             "ScriptHost",
             "ES2019",
-            "ES2020.String"
+            "ES2020.String",
+            "ES2021.WeakRef"
         ]
     }
 }