@wayward/types 2.11.1-beta.dev.20211230.1 → 2.11.1-beta.dev.20220102.1

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

@@ -17,7 +17,7 @@ import { Delay, SkillType } from "game/entity/IHuman";
 import type { TurnType } from "game/entity/player/IPlayer";
 import type Player from "game/entity/player/Player";
 import type { IGameEvents, IPlayOptions, ISynchronizeState } from "game/IGame";
-import { SaveType, TickFlag, TurnMode } from "game/IGame";
+import { SaveType, TickFlag, TurnMode, PauseSource } from "game/IGame";
 import type Island from "game/island/Island";
 import IslandManager from "game/island/IslandManager";
 import type { MultiplayerLoadingDescription } from "game/meta/Loading";
@@ -59,7 +59,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     readonly interval = 16.6666;
     slot: number | undefined;
     absoluteTime: number;
-    paused: boolean;
+    paused: Set<PauseSource>;
     playing: boolean;
     nextTickTime: number | undefined;
     lastTickTime: number | undefined;
@@ -82,6 +82,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     private gameOptionsCached?;
     private synchronizeStateId;
     protected stringTokenizer: StringTokenizer | undefined;
+    get isPaused(): boolean;
     initializeRenderer(): void;
     globalSlotReady(): void;
     /**
@@ -96,7 +97,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     resetWebGL(): void;
     setGlContextSize(width: number, height: number): void;
     resizeRenderer(): void;
-    setPaused(paused: boolean, showChatMessage?: boolean): void;
+    setPaused(pause: boolean, source: PauseSource): void;
     gameLogicLoop: () => void;
     isSimulatedOrRealTimeMode(): boolean;
     getTurnMode(): TurnMode;
@@ -165,7 +166,8 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
      * This method should be able to be called multiple times in a row and nothing unexpected should occur.
      * @param saveType Saves the game with the specified save type. Set to false to not save. Defaults to BackToMainMenu.
      * @param shouldDisconnect Marks if the game should disconnect from multiplayer. Defaults to true.
+     * @param hasDisconnected Marks if the game just disconnected from multiplayer. Defaults to false.
      */
-    reset(saveType?: SaveType | false, shouldDisconnect?: boolean): Promise<void>;
+    reset(saveType?: SaveType | false, shouldDisconnect?: boolean, hasDisconnected?: boolean): Promise<void>;
     fastForwardIsland(island: Island, ticks: number, multiplayerLoadingDescription?: MultiplayerLoadingDescription): Promise<void>;
 }

package/definitions/game/game/IGame.d.ts

@@ -205,6 +205,18 @@ export declare enum CreationId {
     Item = 4,
     TileEvent = 5
 }
+export declare enum PauseSource {
+    /**
+     * Used for pauses that the player will be able to turn on / off / override
+     */
+    Generic = 0,
+    IslandLoad = 1,
+    Mod = 2,
+    PlayerMoveToIsland = 3,
+    SyncGameState = 4,
+    WebGlContextLost = 5,
+    MultiplayerConnect = 6
+}
 /**
  * For items and terrain that can decay, the temperature range that controls the rate of decay.
  * If not provided for items, they will always decays no matter the temperature.

package/definitions/game/game/island/Island.d.ts

@@ -86,6 +86,11 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     loadCount: number;
     seeds: ISeeds;
     readonly seededRandom: Random<SeededGenerator>;
+    /**
+     * Random for milestone modifiers. You should only use the one in the default island
+     * todo: remove since this is no longer used
+     */
+    readonly seededMilestoneModifiersRandom: Random<SeededGenerator>;
     /**
      * Set of players on this island
      */
@@ -196,7 +201,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
      * @param z The z coord to get the closest player.
      * @param canSee If set to true, check if the player can see the x/y/z coords. Defaults to false.
      */
-    getNearestPlayer(x: number, y: number, z?: number, canSee?: boolean, includeConnecting?: boolean): {
+    getNearestPlayer(x: number, y: number, z?: number, canSee?: boolean, includeGhosts?: boolean, includeConnecting?: boolean): {
         player?: Player;
         distance?: number;
     };

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

@@ -74,31 +74,32 @@ export declare enum MultiplayerSyncCheck {
     Merchant = 36,
     MilestoneSeed = 37,
     Misc = 38,
-    MoveToTile = 39,
-    PenaltyFieldHashCode = 40,
-    PlaceOnTile = 41,
-    PlayerManager = 42,
-    PlayerPositions = 43,
-    Players = 44,
-    PlayerSetup = 45,
-    Random = 46,
-    Reputation = 47,
-    Seed = 48,
-    SeededGenerator = 49,
-    SkillGain = 50,
-    StaminaChanges = 51,
-    StatChange = 52,
-    Stats = 53,
-    StatusChange = 54,
-    StatusEffect = 55,
-    SyncChecks = 56,
-    TemperatureManager = 57,
-    Temporary = 58,
-    Tick = 59,
-    TileEvent = 60,
-    Time = 61,
-    UpdateDirection = 62,
-    Weight = 63
+    Modifier = 39,
+    MoveToTile = 40,
+    PenaltyFieldHashCode = 41,
+    PlaceOnTile = 42,
+    PlayerManager = 43,
+    PlayerPositions = 44,
+    Players = 45,
+    PlayerSetup = 46,
+    Random = 47,
+    Reputation = 48,
+    Seed = 49,
+    SeededGenerator = 50,
+    SkillGain = 51,
+    StaminaChanges = 52,
+    StatChange = 53,
+    Stats = 54,
+    StatusChange = 55,
+    StatusEffect = 56,
+    SyncChecks = 57,
+    TemperatureManager = 58,
+    Temporary = 59,
+    Tick = 60,
+    TileEvent = 61,
+    Time = 62,
+    UpdateDirection = 63,
+    Weight = 64
 }
 export declare const maxPlayers = 32;
 export declare const packetTickRate = 16;

package/definitions/game/multiplayer/networking/Connection.d.ts

@@ -47,7 +47,6 @@ export declare abstract class Connection implements IConnection {
     sendKeepAlive(): void;
     getState(): ConnectionState;
     setState(state: ConnectionState): void;
-    serializePacket(packet: IPacket): ArrayBuffer;
     /**
      * Queues a packet to be sent soon
      * Note: packets are serialized when queued
@@ -56,7 +55,7 @@ export declare abstract class Connection implements IConnection {
     /**
      * Queues data to be sent soon
      */
-    protected queuePacketData(data: ArrayBuffer): void;
+    protected queuePacketData(data: ArrayBuffer, packetNumber?: number): void;
     /**
      * Clears queued packets
      */
@@ -73,6 +72,7 @@ export declare abstract class Connection implements IConnection {
      * Sends queued data to the connection w/ flow control
      */
     private _processQueuedData;
+    private _serializePacket;
     abstract readonly maxMessageSize: number;
     abstract isConnected(): boolean;
     protected abstract onClosing(): void;

package/definitions/game/multiplayer/networking/IConnection.d.ts

@@ -69,5 +69,6 @@ export interface IConnection {
 export interface IQueuedData {
     data: ArrayBuffer;
     byteOffset: number;
+    packetNumber?: number;
     retries?: number;
 }

package/definitions/game/multiplayer/packets/IPacket.d.ts

@@ -31,8 +31,8 @@ export interface IPacket<T = any> {
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): T;
-    processData(dataView: DataView): void;
-    preSerialize(): void;
+    processSerializedData(dataView: DataView): void;
+    serializeData(): void;
 }
 export declare enum NetworkPropertyType {
     Bool = 0,

package/definitions/game/multiplayer/packets/Packet.d.ts

@@ -22,8 +22,8 @@ export declare abstract class Packet<T = void> extends IndexedPacket implements
     isAllowedWhenPaused(): boolean;
     getSynchronizationCheckData(): ISynchronizationCheckData;
     getArrayBuffer(id?: number): ArrayBuffer;
-    preSerialize(): number;
-    processData(dataView: DataView): void;
+    serializeData(): number;
+    processSerializedData(dataView: DataView): void;
     abstract process(): T;
     send(exclude?: PacketTarget): void;
     sendTo(to: PacketTarget, force?: boolean): void;

package/definitions/game/multiplayer/packets/client/PausePacket.d.ts

@@ -8,10 +8,11 @@
  * 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 { PauseSource } from "game/IGame";
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class PausePacket extends ClientPacket {
     paused: boolean;
-    showChatMessage: boolean;
+    pauseSource: PauseSource;
     getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/utilities/random/Random.d.ts

@@ -132,7 +132,6 @@ export declare module RandomReference {
 export declare function getRandom(randomInstance: RandomInstance, islandId?: IslandId): Random<SeededGenerator>;
 export declare function createSeededRandom(seed?: number, addMultiplayerSyncChecks?: boolean): Random<SeededGenerator>;
 export declare const mapGenRandom: Random<SeededGenerator>;
-export declare const randomMilestoneModifiers: Random<SeededGenerator>;
 export declare const generalRandom: Random<{
     get: () => number;
 }>;

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

@@ -23,7 +23,7 @@ export default class ApplicationDom {
     clickIfVisibleElement(selector: string): Promise<WebdriverIO.Element | undefined>;
     getVisibleElements(selector: string): Promise<WebdriverIO.Element[] | undefined>;
     getVisibleAndClickableElement(selector: string): Promise<WebdriverIO.Element | undefined>;
-    waitForVisibleThenClick(selector: string, timeout?: number, indent?: boolean): Promise<void>;
+    waitForVisibleThenClick(selector: string, timeout?: number, indent?: boolean, clickOnce?: boolean): Promise<void>;
     waitForVisibleElements(selector: string, timeout?: number): Promise<WebdriverIO.Element[]>;
     waitForNotVisible(selector: string, timeout?: number): Promise<void>;
     waitUntil(executor: () => Promise<boolean>, options: webdriverio.WaitUntilOptions): Promise<true | void>;

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

@@ -12,8 +12,7 @@
 import type { Stat } from "../../game/game/entity/IStats";
 import { Direction } from "../../game/utilities/math/Direction";
 import type { Random, SeededGenerator } from "../../game/utilities/random/Random";
-import type { INewGameOptions } from "../interfaces";
-import { GameMode } from "../interfaces";
+import type { IDedicatedServerGameOptions, IJoinServerOptions, INewGameOptions } from "../interfaces";
 import type { IslandId } from "../../game/game/island/IIsland";
 import ApplicationDom from "./applicationDom";
 import ApplicationLogger from "./applicationLogger";
@@ -27,11 +26,14 @@ export default class ApplicationInteractions {
     constructor(additionalArgs: string[], random: Random<SeededGenerator>);
     waitForInitialStartup(expectedInitialScreen: "title" | "mp_gameplay_modifiers"): Promise<void>;
     waitUntilLoadingIsFinished(expectedMultiplayerMenu?: boolean): Promise<void>;
-    playDedicatedServer(gameMode?: GameMode): Promise<void>;
+    playDedicatedServer(options: IDedicatedServerGameOptions): Promise<void>;
     playNewGame(options: INewGameOptions): Promise<void>;
+    private setupCommonOptions;
+    unlockMilestoneModifiers(): Promise<void>;
     playImportedGame(savePath: string): Promise<void>;
     playContinueGame(): Promise<void>;
     quitGame(): Promise<void>;
+    clickOptions(): Promise<void>;
     clickNewGame(): Promise<void>;
     clickLoadGame(): Promise<void>;
     clickConfirm(): Promise<void>;
@@ -41,7 +43,11 @@ export default class ApplicationInteractions {
     clickJoinServer(): Promise<void>;
     clickDailyChallenge(): Promise<void>;
     clickBack(timeout?: number): Promise<void>;
-    clickButton(name: string, timeout?: number): Promise<void>;
+    clickButton(name: string, options?: Partial<{
+        force: boolean;
+        clickOnce: boolean;
+        timeout: number;
+    }>): Promise<void>;
     clickYesIfVisible(): Promise<boolean>;
     clickButtonIfVisible(name: string): Promise<boolean>;
     clickUnpauseIconIfVisible(): Promise<void>;
@@ -61,8 +67,7 @@ export default class ApplicationInteractions {
     waitForGameEndScreen(isWinner: boolean): Promise<void>;
     returnToTitleScreen(): Promise<void>;
     getServerGameCode(): Promise<string>;
-    joinMultiplayerServer(gameCode: string): Promise<void>;
-    joinMultiplayerDedicatedServer(gameCode: string): Promise<void>;
+    joinMultiplayerServer(gameCode: string, options: IJoinServerOptions, isDedicatedServer: boolean): Promise<void>;
     pauseGame(): Promise<void>;
     unpauseGame(): Promise<void>;
     moveToIslandId(islandId: IslandId): Promise<void>;
@@ -80,7 +85,10 @@ export default class ApplicationInteractions {
     isOverlayVisible(): Promise<WebdriverIO.Element[] | undefined>;
     waitUntilTitleScreenIsVisible(): Promise<void>;
     waitUntilGameEndMenuIsVisible(): Promise<void>;
-    waitForVisibleButtonThenClick(name: string, timeout?: number): Promise<void>;
+    waitForVisibleButtonThenClick(name: string, options?: Partial<{
+        clickOnce: boolean;
+        timeout: number;
+    }>): Promise<void>;
     increaseStat(stat: Stat, value: number): Promise<void>;
     randomInput(count: number): Promise<void>;
     pressKey(key: string, modifier?: string): Promise<void>;

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

@@ -10,7 +10,7 @@
  */
 import type Player from "../../game/game/entity/player/Player";
 import { Direction } from "../../game/utilities/math/Direction";
-import type { GameMode } from "../interfaces";
+import type { IJoinServerOptions, INewGameOptions } from "../interfaces";
 import type { IDifferences } from "../../game/utilities/object/JsonHelper";
 import type Application from "./application";
 import type { ITestState } from "./application";
@@ -62,10 +62,10 @@ export declare class Apps {
     getLog(): string[];
     compileDifferences(client: string | number, differences: IDifferences): string;
     verifyGameStates(): Promise<void>;
-    createMultiplayerGame(gameMode: GameMode): Promise<void>;
+    createMultiplayerGame(options: Omit<INewGameOptions, "playMode">): Promise<void>;
     setClientJoinIsland(x: number, y: number): Promise<void>;
     getServerGameCode(): Promise<string>;
-    joinServer(...apps: Application[]): Promise<void>;
+    joinServer(options: IJoinServerOptions, ...apps: Application[]): Promise<void>;
     leaveServer(...apps: Application[]): Promise<void>;
     returnToTitleScreen(): Promise<void>;
     waitUntilLoadingIsFinished(): Promise<void>;

package/definitions/test/interfaces.d.ts

@@ -8,11 +8,19 @@
  * 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 interface INewGameOptions {
+export interface ICommonGameOptions {
     gameMode: GameMode;
+    seed?: string | number;
+    enableAllMilestoneModifiers?: boolean;
+}
+export interface INewGameOptions extends ICommonGameOptions {
     playMode: GamePlayMode;
     reuseCharacter?: boolean;
-    seed?: string | number;
+}
+export declare type IDedicatedServerGameOptions = ICommonGameOptions;
+export interface IJoinServerOptions {
+    joinProgrammatically: boolean;
+    enableAllMilestoneModifiers?: boolean;
 }
 export declare enum GameMode {
     Hardcore = "Hardcore Mode",

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.11.1-beta.dev.20211230.1",
+	"version": "2.11.1-beta.dev.20220102.1",
 	"license": "MIT",
 	"repository": {
 		"type": "git",
@@ -14,11 +14,11 @@
 		"watch": "tsc --build"
 	},
 	"dependencies": {
+		"@types/fs-extra": "^9.0.13",
+		"@types/node": "^17.0.5",
 		"@wayward/goodstream": "0.7.1"
 	},
 	"devDependencies": {
-		"@wayward/game": "^1.0.0",
-		"@types/node": "^17.0.5",
-		"@types/fs-extra": "^9.0.13"
+		"@wayward/game": "^1.0.0"
 	}
 }

package/tsconfig.mod.base.json

@@ -12,7 +12,8 @@
         "removeComments": true,
         "strict": true,
         "strictPropertyInitialization": false,
-        "moduleResolution": "node",
+        // classic is required for auto imports to use the shortest path in vscode
+        "moduleResolution": "classic",
         "paths": {
             "*": [
                 "node_modules/@wayward/types/definitions/game/*"
@@ -22,6 +23,15 @@
             ],
             "@hosts/*": [
                 "node_modules/@wayward/types/definitions/hosts/*"
+            ],
+            // required when using classic module resolution
+            "@wayward/goodstream": [
+                "node_modules/@wayward/goodstream/Stream",
+                "node_modules/@wayward/types/node_modules/@wayward/goodstream/Stream"
+            ],
+            "@wayward/goodstream/*": [
+                "node_modules/@wayward/goodstream/*",
+                "node_modules/@wayward/types/node_modules/@wayward/goodstream/*"
             ]
         },
         "types": [],