@wayward/types 2.12.3-beta.dev.20230104.1 → 2.13.0-beta

package/definitions/test/util/helpers.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * 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 type { IDifferences } from "@wayward/game/utilities/object/JsonHelper";
+export declare function compileDifferences(client: string | number, differences: IDifferences): string;

package/definitions/test/util/ports.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * 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 function getFreePort(): Promise<number>;

package/definitions/test/util/random.d.ts

@@ -8,5 +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
  */
-export declare function createRandom(): import("../../game/utilities/random/Random").Random<import("../../game/utilities/random/Random").SeededGenerator>;
-export declare function getSeed(): number | undefined;
+import type { Random } from "@wayward/game/utilities/random/Random";
+export declare function createRandom(appId: string): Random;
+export declare function getSeed(): number;

package/package.json

@@ -1,24 +1,24 @@
-{
-	"name": "@wayward/types",
-	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.12.3-beta.dev.20230104.1",
-	"license": "MIT",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/WaywardGame/types.git"
-	},
-	"scripts": {
-		"clean": "rimraf ./definitions ./*.tsbuildinfo",
-		"build": "tsc --build",
-		"build:mods": "tsc --build",
-		"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"
-	}
-}
+{
+	"name": "@wayward/types",
+	"description": "TypeScript declarations for Wayward, used for modding.",
+	"version": "2.13.0-beta",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/WaywardGame/types.git"
+	},
+	"scripts": {
+		"clean": "rimraf ./definitions ./*.tsbuildinfo",
+		"build": "tsc --build",
+		"build:mods": "tsc --build",
+		"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"
+	}
+}

package/tsconfig.json

@@ -1,8 +1,8 @@
-{
-    "files": [],
-    "references": [
-        {
-            "path": "../../src"
-        }
-    ]
+{
+    "files": [],
+    "references": [
+        {
+            "path": "../../src"
+        }
+    ]
 }

package/tsconfig.mod.base.json

@@ -1,45 +1,45 @@
-{
-    "compilerOptions": {
-        "target": "ES2021",
-        "module": "AMD",
-        "composite": true,
-        "experimentalDecorators": true,
-        "forceConsistentCasingInFileNames": true,
-        "inlineSourceMap": true,
-        "noImplicitOverride": true,
-        "noUnusedLocals": true,
-        "preserveConstEnums": true,
-        "removeComments": true,
-        "strict": true,
-        "strictPropertyInitialization": false,
-        // classic is required for auto imports to use the shortest path in vscode
-        "moduleResolution": "classic",
-        "paths": {
-            "*": [
-                "node_modules/@wayward/types/definitions/game/*"
-            ],
-            "@cplusplus/*": [
-                "node_modules/@wayward/types/definitions/cplusplus/*"
-            ],
-            "@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": [],
-        "lib": [
-            "DOM",
-            "DOM.Iterable",
-            "ES2021",
-            "WebWorker.ImportScripts",
-        ]
-    }
+{
+    "compilerOptions": {
+        "target": "ES2021",
+        "module": "AMD",
+        "composite": true,
+        "experimentalDecorators": true,
+        "forceConsistentCasingInFileNames": true,
+        "inlineSourceMap": true,
+        "noImplicitOverride": true,
+        "noUnusedLocals": true,
+        "preserveConstEnums": true,
+        "removeComments": true,
+        "strict": true,
+        "strictPropertyInitialization": false,
+        // classic is required for auto imports to use the shortest path in vscode
+        "moduleResolution": "classic",
+        "paths": {
+            "*": [
+                "node_modules/@wayward/types/definitions/game/*"
+            ],
+            "@cplusplus/*": [
+                "node_modules/@wayward/types/definitions/cplusplus/*"
+            ],
+            "@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": [],
+        "lib": [
+            "DOM",
+            "DOM.Iterable",
+            "ES2021",
+            "WebWorker.ImportScripts",
+        ]
+    }
 }

package/definitions/game/game/entity/creature/Pathing.d.ts

@@ -1,30 +0,0 @@
-/*!
- * 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 type Human from "game/entity/Human";
-import type Island from "game/island/Island";
-import type { ITile } from "game/tile/ITerrain";
-import type { IVector2 } from "utilities/math/IVector";
-export interface IPathingEvents {
-    /**
-     * Called when checking if a tile is blocked, used for pathing.
-     * @param tile The tile to check
-     */
-    isTileBlocked?(tile: ITile): true | undefined;
-}
-declare const _default: {
-    findPath(island: Island, start: IVector2, end: IVector2, z: number, isTileBlocked: (tile: ITile, pos: IVector2) => boolean, getTilePenalty?: ((tile: ITile, pos: IVector2) => number) | undefined, maxNodesChecked?: number): IVector2[] | undefined;
-    /**
-     * Returns whether the tile is blocked (completely impassible)
-     */
-    isWalkToTileBlocked(human: Human, tile: ITile, pos: IVector2, clientSide: boolean): boolean;
-    readonly event: import("event/EventEmitter").IEventEmitter<any, IPathingEvents>;
-};
-export default _default;

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

@@ -1,65 +0,0 @@
-/*!
- * 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 Island from "game/island/Island";
-import Button from "ui/component/Button";
-import Component from "ui/component/Component";
-import Input from "ui/component/Input";
-import CanvasDialog from "ui/screen/screens/game/component/CanvasDialog";
-import type { IVector2 } from "utilities/math/IVector";
-export default class IslandsDialog extends CanvasDialog {
-    private hoveredIslandPosition?;
-    private selectedIslandPosition;
-    private lastSailAwayCheckPosition?;
-    readonly title: Input;
-    readonly info: Component<HTMLElement>;
-    readonly sailButton: Button;
-    closeOnTravel: boolean;
-    constructor();
-    protected initializeSettingsPanel(panel: Component): void;
-    private addMouseMoveListener;
-    private removeMouseMoveListener;
-    selectIsland(x: number, y: number): void;
-    protected onLoad(): Promise<void>;
-    protected sail(): void;
-    protected onIslandRenamed(island: Island): void;
-    protected preMoveToIsland(): void;
-    protected onLoadedOnIsland(): void;
-    protected onMouseMove(): void;
-    protected onCanvasClick(): void;
-    protected onAccept(): boolean;
-    protected onSubmit(): boolean;
-    protected onLeft(): boolean;
-    protected onRight(): boolean;
-    protected onUp(): boolean;
-    protected onDown(): boolean;
-    private moveSelectedIsland;
-    private onChangedSelectedIsland;
-    protected resetViewZoom(): void;
-    protected resetViewOffset(islandPosition?: IVector2): void;
-    protected canHideDrawer(): boolean;
-    protected draw(): void;
-    private drawBackground;
-    private drawFogOfWar;
-    private drawIsland;
-    private travelDotHead?;
-    private drawTravelDots;
-    private dotGenerationSpeed;
-    private generateTravelDots;
-    private mapBackgroundImage?;
-    private getMapBackground;
-    private getViewportBounds;
-    private offset;
-    private getIslandPosition;
-    private getIslandOffset;
-    private handleInvalidSprite;
-    private getHoveredIslandPosition;
-    private canSailAway;
-}

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

@@ -1,123 +0,0 @@
-/*!
- * 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 type Stream from "@wayward/goodstream/Stream";
-import { TileGroup } from "game/entity/creature/ICreature";
-import type Island from "game/island/Island";
-import type { IOverlayInfo, ITile } from "game/tile/ITerrain";
-import { TerrainType } from "game/tile/ITerrain";
-import type { IVector3 } from "utilities/math/IVector";
-import Vector3 from "utilities/math/Vector3";
-declare module TileHelpers {
-    const maskGfx = 31;
-    const maskType = 131040;
-    const maskTypeShift = 5;
-    const maskTilled = 131072;
-    const maskTilledShift: number;
-    const maskDoodadOverHidden = 262144;
-    const maskDoodadOverHiddenShift: number;
-    const maskDoodadAnimationDisabled = 524288;
-    const maskDoodadAnimationDisabledShift: number;
-    function getGfx(tile: ITile): number;
-    /**
-     * This should only be called if you know what you're doing
-     * Use game.changeTile or game.removeTopTile when modifying tiles
-     * Otherwise the game state could get out of sync
-     */
-    function setGfx(tile: ITile, value: number): void;
-    /**
-     * This should only be called from MapGen code
-     */
-    function setGfxRaw(data: number, value: number): number;
-    function getType(tile: ITile): TerrainType;
-    function getTypeRaw(data: number): number;
-    /**
-     * This should only be called if you know what you're doing
-     * Use game.changeTile or game.removeTopTile when modifying tiles
-     * Otherwise the game state could get out of sync
-     */
-    function setType(tile: ITile, value: TerrainType): void;
-    /**
-     * This should only be called from MapGen code
-     */
-    function setTypeRaw(data: number, value: TerrainType): number;
-    /**
-     * This should only be called from the rendering code
-     * Use Island.isTilled for other scenarios
-     */
-    function isTilled(tile: ITile): boolean;
-    /**
-     * This should only be called if you know what you're doing
-     * Ensure a tile data with tilled is created
-     * Otherwise the game state could get out of sync
-     */
-    function setTilled(tile: ITile, value: boolean): void;
-    function isDoodadOverHidden(tile: ITile): boolean;
-    function setDoodadOverHidden(tile: ITile, value: boolean): void;
-    function isDoodadAnimationDisabled(tile: ITile): boolean;
-    function isDoodadAnimationDisabledRaw(data: number): boolean;
-    function setDoodadAnimationDisabled(tile: ITile, value: boolean): void;
-    function setDoodadAnimationDisabledRaw(data: number, value: number): number;
-    function getTileVariation(x: number, y: number): number;
-    function isTypeInGroup(tile: ITile | TerrainType, group: TileGroup): boolean;
-    module Overlay {
-        function add(tile: ITile, overlay: IOverlayInfo, ifNotExist?: (overlay: IOverlayInfo) => boolean): boolean;
-        function has(tile: ITile, filter: (overlay: IOverlayInfo) => boolean): boolean | undefined;
-        function remove(tile: ITile, overlay: IOverlayInfo): boolean;
-        function remove(tile: ITile, filter: (overlay: IOverlayInfo) => boolean): boolean;
-    }
-    function findMatchingTile(island: Island, start: IVector3, isMatchingTile: (island: Island, point: IVector3, tile: ITile) => boolean, options?: {
-        maxTilesChecked?: number;
-        canVisitTile?: (island: Island, point: IVector3, tile: ITile) => boolean;
-    }): IVector3 | undefined;
-    function findMatchingTiles(island: Island, start: IVector3, isMatchingTile: (island: Island, point: IVector3, tile: ITile) => boolean, options?: {
-        maxTiles?: number;
-        maxTilesChecked?: number;
-        canVisitTile?: (island: Island, point: IVector3, tile: ITile) => boolean;
-    }): Array<{
-        point: IVector3;
-        tile: ITile;
-    }>;
-    /**
-     * Check is a tile is open
-     */
-    function isOpenTile(island: Island, point: IVector3, tile?: ITile): boolean;
-    /**
-     * Check if a tile is a suitable spawn point
-     */
-    function isSuitableSpawnPointTile(island: Island, point: IVector3, tile: ITile): boolean;
-    /**
-     * Check if a tile is a suitable spawn point
-     */
-    function isSuitableSpawnPointTileForMultiplayer(island: Island, point: IVector3, tile: ITile, disallowWater?: boolean): boolean;
-    /**
-     * Check if a tile is a suitable spawn point for a creature
-     */
-    function isSuitableSpawnPointTileForTamedCreature(island: Island, point: IVector3, tile: ITile): boolean;
-    function getSuitableSpawnPoint(island: Island): IVector3;
-    function getPointsAround(island: Island, point: IVector3, includeCurrentTile?: boolean, includeCorners?: boolean): IVector3[];
-    /**
-     * Array version of TileHelpers.tilesAround
-     */
-    function getTilesAround(island: Island, point: IVector3, includeCurrentTile?: boolean, includeCorners?: boolean): ITile[];
-    /**
-     * IterableIterator version of TileHelpers.getTilesAround
-     */
-    function tilesAround(island: Island, point: IVector3, includeCurrentTile?: boolean, includeCorners?: boolean): Generator<ITile, void, unknown>;
-    function tilesInRange(island: Island, point: IVector3, range: number, includeCurrentTile?: boolean): Stream<[Vector3, ITile]>;
-    function openTileInRange(island: Island, point: IVector3, range: number, includeCurrentTile?: boolean): [Vector3, ITile] | undefined;
-    /**
-     * Check if the tile is blocked (impassable terrain or doodads that cause blocked movement).
-     */
-    function isTileBlocked(island: Island, point: IVector3): boolean;
-    function isAdjacent(point: IVector3, point2: IVector3): boolean;
-    function isAround(point: IVector3, point2: IVector3): boolean;
-}
-export default TileHelpers;

package/definitions/test/util/mochaNUnitReporter.d.ts

@@ -1,38 +0,0 @@
-/*!
- * 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" />
-export interface IAttachmentConfigurer {
-    setOnlyIfExists(): this;
-    setFilePath(filePath: string): this;
-    setContents(contents: string): this;
-}
-export interface IAttachmentData {
-    directoryStructure: string[];
-    file: {
-        existingFilePath?: string;
-        createNewFileContents?: string | Buffer;
-    };
-}
-export interface ITestCaseApi {
-    addAttachment(name: string, data: IAttachmentData): void;
-}
-export interface ITest {
-    title: string;
-    fullTitle(): string;
-    parent: ITest | undefined;
-    consoleOutputs: string[];
-    consoleErrors: string[];
-    attachments: string[];
-}
-export declare function getMochaTestTree(test: ITest): string[];
-export declare function getAttachmentFilePath(attachmentName: string, data: Omit<IAttachmentData, "file">): string;
-export declare function addTestData(test: ITest, err?: Error): void;
-export declare function MochaNUnitReporter(handleTestcaseData: (api: ITestCaseApi, test: ITest, err?: Error) => any): void;