@wayward/types 2.13.0-beta.dev.20230511.1 → 2.13.0-beta.dev.20230512.1

package/definitions/game/game/Game.d.ts

@@ -165,7 +165,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     updateGameOptions(gameOptions: IGameOptions): void;
     initializeGameOptions(seed: string | number, mode?: GameMode, options?: IGameOptions, milestoneModifiers?: Set<Milestone>): void;
     initializeModifiers(): void;
-    getMovementTime(delay: Delay | number): IMovementTime;
+    getMovementTime(delay: Delay | number, timestamp?: number): IMovementTime;
     getMovementProgress(timeStamp: number, movementTime: IMovementTime | undefined): number;
     getSynchronizeState(identifier: string): ISynchronizeState;
     synchronizeState(synchronizeState: ISynchronizeState): void;

package/definitions/game/game/entity/npc/npcs/Merchant.d.ts

@@ -53,6 +53,7 @@ export default class MerchantNPC extends NPC {
     protected getDefaultEquipment(equipType: EquipType): Item | ItemType | undefined;
     protected getDefaultInventory(): Array<Item | ItemType>;
     protected getDefaultAiType(): AiType;
+    protected onSpawn(): void;
     private canSpawnItem;
     protected runActions(): boolean;
     get asMerchant(): MerchantNPC;

package/definitions/game/game/entity/player/Player.d.ts

@@ -88,7 +88,14 @@ export default class Player extends Human implements IPreSerializeCallback, IUns
      */
     prompt(type: Prompt, ...args: any[]): Promise<boolean | InterruptChoice>;
     updateActionSlots(slots: number[], data: IActionBarSlotData[], enabled?: boolean): void;
+    /**
+     * Send a packet to the server about the dialog info for the dialog
+     */
     updateDialogInfo(dialogIndex: string | number | undefined): void;
+    /**
+     * Send a packet to the server about the sort info for the container
+     */
+    updateContainerSortInfo(dialogIndex: string | number): void;
     getDialogInfo(dialogIndex: string | number): IDialogInfo | undefined;
     kill(): void;
     respawn(reset: boolean): void;

package/definitions/game/game/mapping/Background.d.ts

@@ -13,7 +13,7 @@ export type CanvasImage = HTMLImageElement | HTMLCanvasElement | ImageBitmap;
 export default class MapBackground {
     private readonly seed?;
     private readonly canvas;
-    constructor(radius: number, seed?: number | undefined);
+    constructor(radius: number, seed?: Uint16Array | undefined);
     render(mapImage: CanvasImage, theme: DrawnMapTheme): Promise<HTMLCanvasElement>;
     private lastTheme?;
     private renderBackground;

package/definitions/game/game/mapping/Obfuscation.d.ts

@@ -13,7 +13,7 @@ import type { DrawnMapTheme } from "game/mapping/IMapRender";
 export default class Obfuscation {
     private readonly seed?;
     private readonly canvas;
-    constructor(radius: number, seed?: number | undefined);
+    constructor(radius: number, seed?: Uint16Array | undefined);
     obfuscate(mapImage: CanvasImage, obfuscation: number, theme: DrawnMapTheme): Promise<HTMLCanvasElement>;
     private render;
 }

package/definitions/game/game/milestones/IMilestone.d.ts

@@ -59,7 +59,8 @@ export declare enum Milestone {
     Murderer = 47,
     Retailer = 48,
     Masochist = 49,
-    Versatile = 50
+    Versatile = 50,
+    InternalStatDiscovery = 51
 }
 export type ExcludeInternalMilestones<MILESTONE extends Milestone> = PickValueKeys<typeof Milestone, MILESTONE> extends `Internal${string}` ? never : MILESTONE;
 export declare enum MilestoneVisibility {

package/definitions/game/game/milestones/MilestoneDefinition.d.ts

@@ -66,4 +66,6 @@ export default class MilestoneDefinition {
     setNotDisabledByMods(): this;
     unlockedHandler?: (tellPlayer: () => void) => any;
     onUnlocked(handler: (tellPlayer: () => void) => any): this;
+    progressHandler?: (newData?: string | number) => any;
+    onProgress(handler: (newData?: string | number) => any): this;
 }

package/definitions/game/game/milestones/MilestoneManager.d.ts

@@ -20,7 +20,7 @@ export interface IMilestoneEvents {
      * @param value The new value for this milestone
      * @param max The max value for this milestone
      */
-    update(milestone: Milestone, value: number, max: number): void;
+    update(milestone: Milestone, value: number, max: number, newData?: string | number): void;
 }
 export declare class MilestoneManager extends EventEmitter.Host<IMilestoneEvents> {
     private readonly game;

package/definitions/game/multiplayer/packets/server/{UpdateDialogInfoPacket.d.ts → UpdateUiInfoPacket.d.ts}

@@ -9,10 +9,17 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import PlayerTargetedServerPacket from "multiplayer/packets/PlayerTargetedServerPacket";
-import type { IDialogInfo } from "ui/old/IOldUi";
-export default class UpdateDialogInfoPacket extends PlayerTargetedServerPacket {
+import type { IContainerSortInfo, IDialogInfo } from "ui/old/IOldUi";
+export declare enum UpdateUiInfoPacketType {
+    DialogInfo = 0,
+    DialogContainerInfo = 1,
+    ContainerSortInfo = 2
+}
+export default class UpdateUiInfoPacket extends PlayerTargetedServerPacket {
+    type: UpdateUiInfoPacketType;
     index: string | number;
     info: IDialogInfo;
+    containerSortInfo: IContainerSortInfo;
     getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;

package/definitions/game/renderer/fieldOfView/FieldOfView.d.ts

@@ -48,7 +48,7 @@ export default class FieldOfView extends EventEmitter.Host<IFieldOfViewEvents> {
     texLight: WebGLTexture | undefined;
     texLightOld: WebGLTexture | undefined;
     private seed;
-    private transitionFinishTime;
+    private transitionMovementTime;
     private readonly transitioningExploredMap;
     private lastComputedIslandId;
     static initializePrograms(webGlContext: WebGlContext): Promise<void>;

package/definitions/game/ui/component/Text.d.ts

@@ -12,6 +12,7 @@ import type { Events, IEventEmitter } from "event/EventEmitter";
 import type { EmitterOrBus, Event, Handler } from "event/EventManager";
 import type { IIcon } from "game/inspection/InfoProvider";
 import UiTranslation from "language/dictionary/UiTranslation";
+import type { TranslationArg } from "language/ITranslation";
 import type { IBindingsSection } from "language/segment/BindSegment";
 import type { IColorSection } from "language/segment/ColorSegment";
 import type { IHeadingSection } from "language/segment/HeadingSegment";
@@ -25,9 +26,9 @@ import type { IInput, Modifier } from "ui/input/IInput";
 import type Tooltip from "ui/tooltip/Tooltip";
 import type { IReferenceSection, ISegment, IStringSection } from "utilities/string/Interpolator";
 export default class Text extends Component {
-    static resolve(translation: TranslationGenerator | undefined, additionalSegments?: ISegment[], ...args: any[]): IStringSection[];
+    static resolve(translation: TranslationGenerator | undefined, additionalSegments?: ISegment[], ...args: TranslationArg[]): IStringSection[];
     private static areIdenticalSections;
-    static toString(translation: TranslationGenerator | undefined, additionalSegments?: ISegment[]): string;
+    static toString(translation: TranslationGenerator | undefined, additionalSegments?: ISegment[], ...args: TranslationArg[]): string;
     private segments;
     private text?;
     private args?;

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

@@ -10,6 +10,7 @@
  */
 import type Doodad from "game/doodad/Doodad";
 import type NPC from "game/entity/npc/NPC";
+import type NPCManager from "game/entity/npc/NPCManager";
 import type { ContainerReference, DisplayableItemType, IContainer, IDismantleComponent } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";
 import type { IMoveItemOptions } from "game/item/IItemManager";
@@ -162,6 +163,7 @@ export default class InGameScreen extends BaseScreen {
     completeAddingMultipleItemsToContainer(container: IContainer, itemsToSync?: Item[]): void;
     onContainerItemAdd(itemManager: ItemManager, itemsAdded: Item[], container: IContainer, options?: IMoveItemOptions, customOptions?: IOldUiContainerItemAdd): void;
     protected onContainerItemRemove(itemManager: ItemManager, itemsRemoved: Item[], containerRemovedFrom?: IContainer): void;
+    protected onNpcRemove(npcManager: NPCManager, npc: NPC): void;
     refreshContainerName(container: IContainer, nestedUpdate?: boolean): void;
     getInventoryItemsInOrder(): any[];
     saveItemOrder(containerElement: JQuery, activeSort?: boolean): void;

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

@@ -49,7 +49,9 @@ export default class GameScreen extends Screen {
     private readonly gameCanvas;
     private readonly effects;
     private readonly placeholders;
-    private readonly islandIntroWrapper;
+    private readonly popupOverlayWrapper;
+    private islandIntroPopupOverlay?;
+    private readonly pausedPopupOverlay;
     private readonly buttonRespawn;
     constructor();
     getQuadrantComponents(): import("@wayward/goodstream").default<QuadrantComponent>;
@@ -57,6 +59,8 @@ export default class GameScreen extends Screen {
     getQuadrantContainer(): Component<HTMLElement>;
     isMouseWithin(): Component<HTMLElement> | undefined;
     mouseStartWasWithin(api: IBindHandlerApi): boolean | undefined;
+    private readonly cinematicModeReasons;
+    toggleCinematicMode(enabled: boolean, reason: string): this;
     onGameStart(game: Game, _isLoadingSave: boolean, _playedCount: number): void;
     onLoadedOnIsland(player: Player, island: Island): void;
     private showIslandIntro;

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

@@ -13,28 +13,25 @@ import type Island from "game/island/Island";
 import Component from "ui/component/Component";
 import type { IGameIconsHost, IGameModifiersHost } from "ui/component/GameIcons";
 import GameIcons, { GameModifiers } from "ui/component/GameIcons";
-import { Heading } from "ui/component/Text";
+import PopupOverlay from "ui/screen/screens/game/component/PopupOverlay";
 import type { IGameOptionsIcon } from "ui/screen/screens/menu/menus/pause/GameOptionsIcons";
 import { GameOptionsIcon } from "ui/screen/screens/menu/menus/pause/GameOptionsIcons";
 import type Tooltip from "ui/tooltip/Tooltip";
-export declare class GameDetails extends Component implements IGameIconsHost, IGameModifiersHost {
+export declare class GameDetails extends PopupOverlay implements IGameIconsHost, IGameModifiersHost {
     get difficulty(): import("../../../../../game/options/IGameOptions").GameMode;
     get pvp(): boolean;
     get mods(): [string, import("ui/util/Misc").ModLoadability][];
     get friends(): ISteamFriend[];
-    islandName: IslandName;
     readonly gameModifiers: GameModifiers;
     readonly gameIcons: GameIcons;
     questsWrapper?: Component;
     private refreshGameIconsTimeout?;
     private steamworksFriends;
     constructor(island: Island);
-    lockHidden(): this;
-    show(): this;
     setHasLabels(hasLabels?: boolean): this;
     setHasQuests(hasQuests?: boolean): this;
     hasIcons(): boolean;
-    refresh(): void;
+    refresh(): this;
     getOptionsIconTooltipHandler(icon: GameOptionsIcon, description: IGameOptionsIcon): ((tooltip: Tooltip) => any) | undefined;
     getOptionsIcons(): [GameOptionsIcon, IGameOptionsIcon][];
     getChallengeModifiers(): import("../../../../../game/options/modifiers/challenge/IChallenge").Challenge[];
@@ -43,7 +40,3 @@ export declare class GameDetails extends Component implements IGameIconsHost, IG
     protected refreshGameIcons(): void;
     private refreshQuests;
 }
-export declare class IslandName extends Heading {
-    constructor();
-    setIsland(island: Island): void;
-}

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

@@ -0,0 +1,31 @@
+/*!
+ * 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 Component from "ui/component/Component";
+import type { TranslationGenerator } from "ui/component/IComponent";
+export declare enum PopupOverlayClasses {
+    Main = "popup-overlay",
+    Title = "popup-overlay-title",
+    TitleWord = "popup-overlay-title-word",
+    TitleChar = "popup-overlay-title-char"
+}
+export default class PopupOverlay extends Component {
+    title?: PopupOverlayTitle;
+    constructor();
+    private translation?;
+    setTitle(title: TranslationGenerator | string): this;
+    refresh(): this;
+    lockHidden(): this;
+    show(): this;
+}
+export declare class PopupOverlayTitle extends Component {
+    constructor();
+    setText(text: string): void;
+}

package/definitions/game/ui/screen/screens/game/static/stats/IStatDisplayDescription.d.ts

@@ -10,7 +10,7 @@
  */
 import type { IHasImagePath } from "game/IObject";
 import type EntityWithStats from "game/entity/EntityWithStats";
-import type { IStat, StatDisplayType } from "game/entity/IStats";
+import type { IStat, IStatBase, StatDisplayType } from "game/entity/IStats";
 import type { Reference } from "game/reference/IReferenceManager";
 import type { IModdable } from "mod/ModRegistry";
 import type Component from "ui/component/Component";
@@ -60,3 +60,28 @@ export interface IStatDisplayDescription extends IModdable, IHasImagePath<string
     subscribeCalculateEquipmentStats?: true;
 }
 export declare const STAT_DEFAULT_DISPLAY_ORDER = 100;
+export interface IStatInfo extends Partial<IStatBase> {
+    value: number;
+    percent: number;
+    oldValue?: number;
+}
+/**
+ * Returns a `IStatDescription["onChange"]` handler that will check a predicate and run the handler with the result of that predicate.
+ * @param predicate A function that takes an `IStatInfo` object and returns whether it "matches".
+ * @param handler A function that takes whether the info matches, the `statElement`, the entity, and the `IStatInfo` object and "handles" it.
+ */
+export declare function when(predicate: (info: IStatInfo, entity: EntityWithStats) => boolean, handler: (matched: boolean, statElement: Component, entity: EntityWithStats, info: IStatInfo) => any): (statElement: Component, entity: EntityWithStats, stat: IStat, oldValue?: number) => void;
+/**
+ * Returns a `when()` handler that will toggle classes on a `statElement` based on whether the `predicate` matched.
+ */
+export declare function toggleClasses(...classes: string[]): (matched: boolean, statElement: Component) => void;
+/**
+ * Returns a `when()` handler that will discover a stat when the `predicate` matches.
+ */
+export declare function discover(matched: boolean, statElement: Component, entity: EntityWithStats, stat: IStatInfo): void;
+/**
+ * Shakes the stat element if `shouldShake` is true, otherwise removes the `shake` class.
+ *
+ * When adding the `shake` class, removes it after 250 ms.
+ */
+export declare function shake(shouldShake: boolean, statElement: Component): Promise<void>;

package/definitions/game/ui/screen/screens/game/static/stats/Reputation.d.ts

@@ -8,6 +8,6 @@
  * 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 { IStatDisplayDescription } from "ui/screen/screens/game/static/stats/IStatDisplayDescription";
+import { type IStatDisplayDescription } from "ui/screen/screens/game/static/stats/IStatDisplayDescription";
 declare const reputation: IStatDisplayDescription;
 export default reputation;

package/definitions/game/ui/screen/screens/game/static/stats/StatDisplayDescriptions.d.ts

@@ -8,30 +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 type EntityWithStats from "game/entity/EntityWithStats";
-import type { IStat, IStatBase } from "game/entity/IStats";
 import { Stat } from "game/entity/IStats";
-import type Component from "ui/component/Component";
-import type { IStatDisplayDescription } from "ui/screen/screens/game/static/stats/IStatDisplayDescription";
+import { discover, shake, toggleClasses, when, type IStatDisplayDescription } from "ui/screen/screens/game/static/stats/IStatDisplayDescription";
+export { discover, shake, toggleClasses, when };
 export declare const statDisplayDescriptions: Map<Stat, IStatDisplayDescription>;
-export interface IStatInfo extends Partial<IStatBase> {
-    value: number;
-    percent: number;
-    oldValue?: number;
-}
-/**
- * Returns a `IStatDescription["onChange"]` handler that will check a predicate and run the handler with the result of that predicate.
- * @param predicate A function that takes an `IStatInfo` object and returns whether it "matches".
- * @param handler A function that takes whether the info matches, the `statElement`, the entity, and the `IStatInfo` object and "handles" it.
- */
-export declare function when(predicate: (info: IStatInfo) => boolean, handler: (matched: boolean, statElement: Component, entity: EntityWithStats, info: IStatInfo) => any): (statElement: Component, entity: EntityWithStats, stat: IStat, oldValue?: number) => void;
-/**
- * Returns a `when()` handler that will toggle classes on a `statElement` based on whether the `predicate` matched.
- */
-export declare function toggleClasses(...classes: string[]): (matched: boolean, statElement: Component) => void;
-/**
- * Shakes the stat element if `shouldShake` is true, otherwise removes the `shake` class.
- *
- * When adding the `shake` class, removes it after 250 ms.
- */
-export declare function shake(shouldShake: boolean, statElement: Component): Promise<void>;

package/definitions/game/ui/screen/screens/game/static/stats/component/Stat.d.ts

@@ -45,7 +45,8 @@ export declare abstract class StatComponent extends Component {
      * Returns the display priority for this stat.
      */
     getDisplayOrder(): number;
-    abstract getDisplayElement(): Text;
+    abstract getTextElement(): Text;
+    abstract getDisplayElement(): Component;
     /**
      * Returns the generic string representation of this stat.
      */
@@ -76,7 +77,8 @@ export declare class Statbar extends StatComponent {
     private readonly bar;
     private readonly text;
     constructor(entity: EntityWithStats, stat: Stat, noEvents?: true);
-    getDisplayElement(): Text;
+    getTextElement(): Text;
+    getDisplayElement(): Component<HTMLElement>;
     getGenericStatValue(stat: IStatMax): IStringSection[];
     /**
      * Overrides the superclass method of the same name. Calls the superclass method, then updates the CSS
@@ -88,6 +90,7 @@ export declare class Statbar extends StatComponent {
 export declare class StatAttribute extends StatComponent {
     private readonly attribute;
     constructor(entity: EntityWithStats, stat: Stat, noEvents?: true);
+    getTextElement(): Text;
     getDisplayElement(): Text;
 }
 export declare class Statbars extends StatsContainer<Statbar> {

package/definitions/test/core/applicationInteractions.d.ts

@@ -9,15 +9,15 @@
  * https://github.com/WaywardGame/types/wiki
  */
 /// <reference types="webdriverio/async" />
-import type { TestRunContext } from "@wayward/test/testRunner";
 import type { IInit } from "@wayward/game/Init";
 import type { Stat } from "@wayward/game/game/entity/IStats";
 import type { IslandId } from "@wayward/game/game/island/IIsland";
 import { Direction } from "@wayward/game/utilities/math/Direction";
 import type { Random } from "@wayward/game/utilities/random/Random";
-import { ApplicationLogger } from "@wayward/test/core/applicationLogger";
 import { ApplicationDom } from "@wayward/test/core/applicationDom";
-import type { IWaitUntilGameLoadedOptions, IDedicatedServerGameOptions, INewGameOptions, ITestJoinServerOptions } from "@wayward/test/interfaces";
+import { ApplicationLogger } from "@wayward/test/core/applicationLogger";
+import type { IDedicatedServerGameOptions, INewGameOptions, ITestJoinServerOptions, IWaitUntilGameLoadedOptions } from "@wayward/test/interfaces";
+import type { TestRunContext } from "@wayward/test/testRunner";
 export default class ApplicationInteractions {
     protected readonly testContext: TestRunContext;
     readonly appId: string;

package/package.json

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