@wayward/types 2.11.1-beta.dev.20211231.1 → 2.11.1-beta.dev.20220103.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";
@@ -25,6 +25,8 @@ import type { Milestone } from "game/milestones/IMilestone";
 import type { IGameOptions } from "game/options/IGameOptions";
 import { GameMode } from "game/options/IGameOptions";
 import type { ChallengeModifiersCollection } from "game/options/modifiers/challenge/ChallengeModifiers";
+import type { GameplayModifiersCollection } from "game/options/modifiers/GameplayModifiersManager";
+import type MilestoneModifier from "game/options/modifiers/milestone/MilestoneModifier";
 import ReferenceManager from "game/reference/ReferenceManager";
 import TimeManager from "game/time/TimeManager";
 import VotingManager from "game/VotingManager";
@@ -59,7 +61,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;
@@ -70,7 +72,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     mapSizeSq: number;
     readonly itemStylesheetHandler: ItemStylesheetHandler | undefined;
     readonly voting: VotingManager;
-    readonly milestonesCollection: import("./options/modifiers/GameplayModifiersManager").GameplayModifiersCollection<import("./options/modifiers/milestone/MilestoneModifier").default, Milestone, import("./options/modifiers/milestone/MilestoneModifier").MilestoneModifierInstance, []>;
+    milestonesCollection?: GameplayModifiersCollection<MilestoneModifier, Milestone>;
     challengeCollection?: ChallengeModifiersCollection;
     debugRenderer: ITextureDebugRenderer | undefined;
     webGlContext: WebGlContext | undefined;
@@ -82,6 +84,8 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     private gameOptionsCached?;
     private synchronizeStateId;
     protected stringTokenizer: StringTokenizer | undefined;
+    toString(): string;
+    get isPaused(): boolean;
     initializeRenderer(): void;
     globalSlotReady(): void;
     /**
@@ -96,7 +100,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;

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

@@ -105,6 +105,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     modifiersCollection?: IslandModifiersCollection;
     details?: IIslandDetails;
     constructor(position?: IVector2, seed?: number);
+    toString(): string;
     private registerMemoryLeakDetector;
     preSerializeObject(serializer: ISerializer): void;
     onUnserialized(): void;
@@ -201,7 +202,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/game/options/modifiers/GameplayModifiersManager.d.ts

@@ -10,6 +10,7 @@
  */
 import type GameplayModifier from "game/options/modifiers/GameplayModifier";
 import type { GameplayModifierInstance, GetModifierId, GetModifierInstance, GetModifierInstanceArgs } from "game/options/modifiers/GameplayModifier";
+import type { StringableObject } from "utilities/object/Objects";
 export default abstract class GameplayModifiersManager<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number>, any[]>, ID extends GetModifierId<MODIFIER> = GetModifierId<MODIFIER>, INSTANCE_ARGS extends GetModifierInstanceArgs<MODIFIER> = GetModifierInstanceArgs<MODIFIER>> {
     private readonly enumObject;
     private readonly classes;
@@ -26,8 +27,8 @@ export declare class GameplayModifiersCollection<MODIFIER extends GameplayModifi
     protected readonly args: INSTANCE_ARGS;
     constructor(manager: GameplayModifiersManager<MODIFIER>, ...args: INSTANCE_ARGS);
     hasAny(): boolean;
-    initialize(id: ID): INSTANCE | undefined;
-    uninitialize(): void;
+    initialize(source: StringableObject, ids: Iterable<ID>): INSTANCE[];
+    uninitialize(source: StringableObject): void;
     options(): import("@wayward/goodstream").default<import("../IGameOptions").IGameOptionsPartial>;
     initialized(): IterableIterator<ID>;
 }

package/definitions/game/game/options/modifiers/challenge/ChallengeModifiers.d.ts

@@ -15,6 +15,7 @@ import type Tooltip from "ui/tooltip/Tooltip";
 export declare const EXCLUSIVE_MODIFIERS: Challenge[][];
 declare class ChallengeModifiersManager extends GameplayModifiersManager<ChallengeModifier> {
     constructor();
+    toString(): string;
     createCollection(seed?: number): ChallengeModifiersCollection;
 }
 declare const _default: ChallengeModifiersManager;

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/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/Log.d.ts

@@ -26,61 +26,62 @@ export declare enum LogSource {
     FileDataStorage = 13,
     FlowFieldManager = 14,
     Game = 15,
-    GarbageCollection = 16,
-    HookManager = 17,
-    IndexedDBDataStorage = 18,
-    Input = 19,
-    InputManager = 20,
-    InterModRegistryManager = 21,
-    Island = 22,
-    ItemManager = 23,
-    ItemReference = 24,
-    ItemStylesheet = 25,
-    Languages = 26,
-    Loading = 27,
-    LocalStorageDataStorage = 28,
-    MapGen = 29,
-    Matchmaking = 30,
-    MatchmakingServer = 31,
-    MemoryLeakDetector = 32,
-    Message = 33,
-    Mod = 34,
-    Mods = 35,
-    Multiplayer = 36,
-    NPC = 37,
-    NPCManager = 38,
-    OldUi = 39,
-    Packet = 40,
-    Player = 41,
-    PlayerManager = 42,
-    Prompts = 43,
-    Reflow = 44,
-    Renderer = 45,
-    ReplayManager = 46,
-    ResourceLoader = 47,
-    SaveManager = 48,
-    Serializer = 49,
-    Shaders = 50,
-    SoundEffect = 51,
-    SpritePack = 52,
-    SshCommandManager = 53,
-    SshServer = 54,
-    Steamworks = 55,
-    StringTokenizer = 56,
-    TemperatureManager = 57,
-    TileEventManager = 58,
-    TileUpdate = 59,
-    Timer = 60,
-    Trello = 61,
-    Ui = 62,
-    Utilities = 63,
-    WebAssembly = 64,
-    WebGlContext = 65,
-    WebRTCConnection = 66,
-    WebSocketConnection = 67,
-    World = 68,
-    WorldLayerRenderer = 69,
-    WorldRenderer = 70
+    GameplayModifier = 16,
+    GarbageCollection = 17,
+    HookManager = 18,
+    IndexedDBDataStorage = 19,
+    Input = 20,
+    InputManager = 21,
+    InterModRegistryManager = 22,
+    Island = 23,
+    ItemManager = 24,
+    ItemReference = 25,
+    ItemStylesheet = 26,
+    Languages = 27,
+    Loading = 28,
+    LocalStorageDataStorage = 29,
+    MapGen = 30,
+    Matchmaking = 31,
+    MatchmakingServer = 32,
+    MemoryLeakDetector = 33,
+    Message = 34,
+    Mod = 35,
+    Mods = 36,
+    Multiplayer = 37,
+    NPC = 38,
+    NPCManager = 39,
+    OldUi = 40,
+    Packet = 41,
+    Player = 42,
+    PlayerManager = 43,
+    Prompts = 44,
+    Reflow = 45,
+    Renderer = 46,
+    ReplayManager = 47,
+    ResourceLoader = 48,
+    SaveManager = 49,
+    Serializer = 50,
+    Shaders = 51,
+    SoundEffect = 52,
+    SpritePack = 53,
+    SshCommandManager = 54,
+    SshServer = 55,
+    Steamworks = 56,
+    StringTokenizer = 57,
+    TemperatureManager = 58,
+    TileEventManager = 59,
+    TileUpdate = 60,
+    Timer = 61,
+    Trello = 62,
+    Ui = 63,
+    Utilities = 64,
+    WebAssembly = 65,
+    WebGlContext = 66,
+    WebRTCConnection = 67,
+    WebSocketConnection = 68,
+    World = 69,
+    WorldLayerRenderer = 70,
+    WorldRenderer = 71
 }
 export declare enum LogLineType {
     Debug = 0,

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

@@ -12,7 +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 { IDedicatedServerGameOptions, INewGameOptions } 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";
@@ -67,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>;

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 { INewGameOptions } 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";
@@ -65,12 +65,13 @@ export declare class Apps {
     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>;
     randomInput(count: number): Promise<void>;
     moveToTowardsIsland(app: Application, direction: Direction.Cardinal, recoverStats?: boolean): Promise<void>;
+    recoverStats(app: Application): Promise<void>;
     moveAndVerifyTicks(app: Application, direction: Direction.Cardinal): Promise<void>;
     waitForClientConsistency(): Promise<void>;
     sailToCivilization(winnerApp: Application): Promise<void>;

package/definitions/test/interfaces.d.ts

@@ -18,6 +18,10 @@ export interface INewGameOptions extends ICommonGameOptions {
     reuseCharacter?: boolean;
 }
 export declare type IDedicatedServerGameOptions = ICommonGameOptions;
+export interface IJoinServerOptions {
+    joinProgrammatically: boolean;
+    enableAllMilestoneModifiers?: boolean;
+}
 export declare enum GameMode {
     Hardcore = "Hardcore Mode",
     Casual = "Casual 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.20211231.1",
+	"version": "2.11.1-beta.dev.20220103.1",
 	"license": "MIT",
 	"repository": {
 		"type": "git",

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": [],