@wayward/types 2.13.0-beta.dev.20230430.2 → 2.13.0-beta.dev.20230501.1

package/definitions/game/game/entity/npc/NPC.d.ts

@@ -26,7 +26,7 @@ import { TileUpdateType } from "game/IGame";
 import type { IContainer, ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
 import type Tile from "game/tile/Tile";
-import Message from "language/dictionary/Message";
+import type TranslationImpl from "language/impl/TranslationImpl";
 import Translation from "language/Translation";
 export interface INPCEvents extends Events<Human> {
     /**
@@ -116,7 +116,7 @@ export default abstract class NPC extends Human<NPCType> {
     /**
      * @param timeSinceLastChat The time it's been since the human last chatted with this NPC, or false if it's the first time.
      */
-    getGreeting(human: Human, timeSinceLastChat: number | false): Message | undefined;
+    getGreeting(human: Human, timeSinceLastChat: number | false): TranslationImpl | undefined;
     getDefaultInteraction(): number | undefined;
     isAlreadyInteracting(human: Human, interactType?: number): boolean;
     canInteract(human: Human, interactType?: number): IActionUsable | IActionNotUsable;
@@ -134,7 +134,7 @@ export default abstract class NPC extends Human<NPCType> {
      * Sets the default weightCapacity of an NPC (based on their equipment and starting items).
      */
     generateWeightCapacity(): void;
-    getName(asKnownBy?: Human): import("../../../language/impl/TranslationImpl").default;
+    getName(asKnownBy?: Human): TranslationImpl;
     /**
      * The name of the npc - called when created
      */

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

@@ -18,7 +18,7 @@ import NPC from "game/entity/npc/NPC";
 import type { IContainer } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
-import Message from "language/dictionary/Message";
+import type TranslationImpl from "language/impl/TranslationImpl";
 export interface IMerchantBuyPrice {
     base: number;
     bonus: number;
@@ -40,7 +40,7 @@ export default class MerchantNPC extends NPC {
     getPublicContainer(): IContainer | undefined;
     getSellPrice(human: Human, item: Item): number | undefined;
     getBuyPrice(human: Human, item: Item): IMerchantBuyPrice | undefined;
-    getGreeting(human: Human, timeSinceLastChat: number | false): Message | undefined;
+    getGreeting(human: Human, timeSinceLastChat: number | false): TranslationImpl | undefined;
     canInteract(human: Human): IActionUsable | IActionNotUsable;
     interact(action: IActionHandlerApi<Human>, interactType?: number | undefined): void;
     /**
@@ -48,7 +48,7 @@ export default class MerchantNPC extends NPC {
      */
     closeContainerDialogs(): void;
     protected getReputationChangeOnDeath(): number;
-    protected getDefaultName(): import("../../../../language/impl/TranslationImpl").default;
+    protected getDefaultName(): TranslationImpl;
     protected initializeStats(): void;
     protected getDefaultEquipment(equipType: EquipType): Item | ItemType | undefined;
     protected getDefaultInventory(): Array<Item | ItemType>;

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

@@ -21,7 +21,7 @@ import type { IContainer } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
 import type Tile from "game/tile/Tile";
-import Message from "language/dictionary/Message";
+import type TranslationImpl from "language/impl/TranslationImpl";
 import type { IVector2 } from "utilities/math/IVector";
 interface IShipTarget {
     islandId: IslandId;
@@ -33,7 +33,7 @@ export default class ShipperNPC extends NPC {
     constructor(options?: INPCConstructorOptions);
     spawn(): void;
     getActions(): ActionType[] | undefined;
-    getGreeting(human: Human, timeSinceLastChat: number | false): Message | undefined;
+    getGreeting(human: Human, timeSinceLastChat: number | false): TranslationImpl | undefined;
     getDefaultInteraction(): number | undefined;
     canInteract(human: Human, interactType: number): IActionUsable | IActionNotUsable;
     interact(action: IActionHandlerApi<Human>, interactType: ShipperNPCInteractType): void;
@@ -44,7 +44,7 @@ export default class ShipperNPC extends NPC {
     canSailTo(x: number, y: number): boolean;
     getPublicContainer(): IContainer | undefined;
     protected getReputationChangeOnDeath(): number;
-    protected getDefaultName(): import("../../../../language/impl/TranslationImpl").default;
+    protected getDefaultName(): TranslationImpl;
     protected initializeStats(): void;
     protected getDefaultEquipment(equipType: EquipType): Item | ItemType | undefined;
     protected getDefaultInventory(): Array<Item | ItemType>;

package/definitions/game/game/inspection/InfoProvider.d.ts

@@ -163,7 +163,7 @@ export declare class SimpleInfoProvider extends InfoProvider {
     private childComponentClass;
     private validWhen?;
     constructor(...translations: Array<TranslationGenerator | InfoProvider>);
-    get(): (import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | (() => import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../utilities/string/Interpolator").IStringSection[] | import("../../language/dictionary/UiTranslation").default | undefined) | InfoProvider)[];
+    get(): (import("../../language/impl/TranslationImpl").default | import("../../language/ITranslation").ISerializedTranslation | import("../../language/dictionary/UiTranslation").default | (() => import("../../language/impl/TranslationImpl").default | import("../../language/ITranslation").ISerializedTranslation | import("../../utilities/string/Interpolator").IStringSection[] | import("../../language/dictionary/UiTranslation").default | undefined) | InfoProvider)[];
     add(...translations: Array<TranslationGenerator | InfoProvider | Falsy>): this;
     onlyIfHasContents(): this | undefined;
     addInfoGetter(provider: () => InfoProvider | undefined): this;

package/definitions/game/language/Translation.d.ts

@@ -153,7 +153,7 @@ declare module Translation {
         translation?(translation: TranslationImpl | ISerializedTranslation): any;
         argument?(argument: TranslationArg): TranslationArg;
     }
-    function upgrade(translation: ISerializedTranslation, id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: ITranslationUpgrader): ISerializedTranslation | TranslationImpl;
+    function upgrade(translation: ISerializedTranslation, id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: ITranslationUpgrader): TranslationImpl | ISerializedTranslation;
     function upgradeTranslationArgument(argument: TranslationArg, id: string, dictionary: Dictionary, entry: number, upgrader?: ITranslationUpgrader): TranslationArg;
 }
 export default Translation;

package/definitions/game/multiplayer/IMultiplayer.d.ts

@@ -12,8 +12,9 @@ import { LobbyType } from "@hosts/shared/interfaces";
 import type { ICharacter } from "game/entity/IHuman";
 import type { PlayerState } from "game/entity/player/IPlayer";
 import type Player from "game/entity/player/Player";
-import type { ISynchronizeState } from "game/IGame";
+import type { ISynchronizeState, PauseSource } from "game/IGame";
 import { TurnMode } from "game/IGame";
+import type { Load } from "game/meta/Loading";
 import type { Milestone } from "game/milestones/IMilestone";
 import type { GameMode, IGameOptions } from "game/options/IGameOptions";
 import type { IMatchmakingInfo } from "multiplayer/matchmaking/IMatchmaking";
@@ -213,3 +214,15 @@ export interface IJoinServerOptions {
     automaticallyRetry: boolean;
     enableSteamNetworkConnections: boolean;
 }
+export interface IMultiplayerRunSafelyOptions {
+    isSynced: boolean;
+    pauseGame?: PauseSource;
+    pauseIncomingPacketProcessing?: boolean;
+    showLoadingScreen?: {
+        load: Load;
+        args?: any[];
+        excludeTargets?: PacketTarget;
+        disableDelayAfter?: boolean;
+        hostInitiatesHide?: boolean;
+    };
+}

package/definitions/game/multiplayer/Multiplayer.d.ts

@@ -11,7 +11,7 @@
 import EventEmitter from "event/EventEmitter";
 import Player from "game/entity/player/Player";
 import type Island from "game/island/Island";
-import type { IJoinServerOptions, IMultiplayerEvents, IMultiplayerOptions, PacketTarget, ServerInfo } from "multiplayer/IMultiplayer";
+import type { IJoinServerOptions, IMultiplayerEvents, IMultiplayerOptions, IMultiplayerRunSafelyOptions, PacketTarget, ServerInfo } from "multiplayer/IMultiplayer";
 import { DisconnectReason, JoinServerRetryReason, MultiplayerSyncCheck, MultiplayerSyncCheckLevel, UnableToJoinReason } from "multiplayer/IMultiplayer";
 import type { IMatchmakingInfo } from "multiplayer/matchmaking/IMatchmaking";
 import type { IConnection } from "multiplayer/networking/IConnection";
@@ -146,10 +146,14 @@ export default class Multiplayer extends EventEmitter.Host<IMultiplayerEvents> {
     markCurrentProcessingPacket(packetId: number, processing: boolean): void;
     clearSyncPacketWaiting(packet: IPacket, wait: number): void;
     clearSyncPacketsWaiting(waitId?: string): void;
-    pauseIncomingPacketProcessing(pause: boolean, clearQueue?: boolean): void;
+    private pauseIncomingPacketProcessing;
+    /**
+     * Execute an async function while applying some temporary state changes
+     */
+    runSafely<T = void>(executor: () => Promise<T>, options: IMultiplayerRunSafelyOptions): Promise<T>;
     updatePlayerId(oldPid: number, newPid: number): void;
     suppressSyncChecks(suppress: boolean): void;
-    syncGameState(): void;
+    syncGameState(): Promise<void>;
     isKeepAliveTimeoutPaused(): boolean;
     pauseKeepAliveTimeouts(): void;
     resumeKeepAliveTimeouts(): void;

package/definitions/game/multiplayer/packets/server/ConnectPacket.d.ts

@@ -16,5 +16,5 @@ export default class ConnectPacket extends ServerPacket {
     getDebugInfo(): string;
     getAllowedStates(): ConnectionState;
     isAllowedWhenPaused(): boolean;
-    process(): void;
+    process(): Promise<void>;
 }

package/definitions/game/ui/screen/screens/game/dialog/BookDialog.d.ts

@@ -16,7 +16,7 @@ export default class BookDialog extends Dialog {
     private book?;
     private readonly text;
     constructor();
-    getName(): import("../../../../../language/ITranslation").ISerializedTranslation | import("../../../../../language/impl/TranslationImpl").default | import("../../../../../language/dictionary/UiTranslation").default | undefined;
+    getName(): import("../../../../../language/impl/TranslationImpl").default | import("../../../../../language/ITranslation").ISerializedTranslation | import("../../../../../language/dictionary/UiTranslation").default | undefined;
     openBook(item: Item): void;
     private getText;
     protected onInventoryItemRemove(_: any, itemOrItems: Item | Item[]): void;

package/package.json

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