@wayward/types 2.13.2-beta.dev.20230602.1 → 2.13.2-beta.dev.20230604.1

package/definitions/game/IGlobal.d.ts

@@ -36,6 +36,7 @@ import "utilities/typesglobal/Iterables";
 import "utilities/typesglobal/Misc";
 import "utilities/typesglobal/Objects";
 import "utilities/typesglobal/Types";
+import type Version from "utilities/Version";
 declare global {
     let audio: WAudio | undefined;
     let game: Game;
@@ -50,7 +51,7 @@ declare global {
     let saveData: SaveData;
     let saveDataGlobal: SaveDataGlobal;
     let ui: Ui;
-    const gameVersion: string;
+    const gameVersion: Version.String;
     const gameVersionStage: string;
     const gameVersionMajor: number;
     const gameVersionMinor: number;

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

@@ -49,6 +49,7 @@ import { Uninit } from "Uninit";
 import type { IVector2 } from "utilities/math/IVector";
 import type { Random } from "utilities/random/Random";
 import type { IVersionInfo } from "utilities/Version";
+import Version from "utilities/Version";
 import { WebWorkerManager } from "webWorker/WebWorkerManager";
 export declare class Game extends EventEmitter.Host<IGameEvents> {
     get isChallenge(): boolean;
@@ -57,7 +58,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     difficulty: GameMode;
     gameplayModifierData: Record<number, any>;
     replay: ReplayManager | undefined;
-    saveVersion: string;
+    saveVersion: Version.String;
     shouldUpdateTablesAndWeight: boolean;
     tickSpeed: number;
     time: TimeManager;
@@ -68,7 +69,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     /**
      * The version the save was originally created on
      */
-    version: string;
+    version: Version.String;
     readonly interval = 16.6666;
     readonly autoSave: AutoSave;
     readonly commandManager: CommandManager;

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

@@ -30,6 +30,7 @@ import type { IReplayLogEntry } from "replay/IReplayLogEntry";
 import type { IHighscoreOld, IOptions } from "save/data/ISaveDataGlobal";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
 import type { IRange } from "utilities/math/Range";
+import type Version from "utilities/Version";
 export interface IGameEvents {
     /**
      * Called when the game is starting
@@ -128,7 +129,7 @@ export type IGameOld = Partial<Game> & Partial<{
     monsters: Creature[];
     tamedCreatures: number[];
     options: IOptions;
-    lastPlayedVersion: string | undefined;
+    lastPlayedVersion: Version.String | undefined;
     highscores: IHighscoreOld[];
     playedCount: number;
     dailyChallenge: boolean;

package/definitions/game/game/doodad/IDoodad.d.ts

@@ -196,6 +196,10 @@ export interface IDoodadDescription extends IObjectDescription, IModdable, ICaus
      */
     containedItemGroupProvidesSkill?: IProvidesSkill;
     alwaysInspectable?: true;
+    /**
+     * The amount of turns it takes to purify the water.
+     */
+    waterPurificationTurns?: number;
 }
 export interface IItemStackRegion {
     xMin?: number;
@@ -271,8 +275,8 @@ export declare enum DoodadType {
     Cotton = 26,
     PricklyPears = 27,
     Tumbleweed = 28,
-    GraniteWaterStill = 29,
-    LitGraniteWaterStill = 30,
+    TinWaterStill = 29,
+    LitTinWaterStill = 30,
     GraniteCampfire = 31,
     LitGraniteCampfire = 32,
     SandstoneKiln = 33,
@@ -297,14 +301,14 @@ export declare enum DoodadType {
     LitClayCampfire = 52,
     ClayFurnace = 53,
     LitClayFurnace = 54,
-    ClayWaterStill = 55,
-    LitClayWaterStill = 56,
+    CopperWaterStill = 55,
+    LitCopperWaterStill = 56,
     SandstoneCampfire = 57,
     LitSandstoneCampfire = 58,
     SandstoneFurnace = 59,
     LitSandstoneFurnace = 60,
-    SandstoneWaterStill = 61,
-    LitSandstoneWaterStill = 62,
+    WroughtIronWaterStill = 61,
+    LitWroughtIronWaterStill = 62,
     GraniteKiln = 63,
     LitGraniteKiln = 64,
     WroughtIronAnvil = 65,
@@ -380,8 +384,8 @@ export declare enum DoodadType {
     BronzeMinecart = 135,
     BasaltWall = 136,
     SetBasaltDeadfall = 137,
-    BasaltWaterStill = 138,
-    LitBasaltWaterStill = 139,
+    IronWaterStill = 138,
+    LitIronWaterStill = 139,
     BasaltCampfire = 140,
     LitBasaltCampfire = 141,
     BasaltFurnace = 142,
@@ -407,7 +411,9 @@ export declare enum DoodadType {
     GraniteDripstone = 162,
     SandstoneDripstone = 163,
     BasaltDripstone = 164,
-    ClayDripstone = 165
+    ClayDripstone = 165,
+    BronzeWaterStill = 166,
+    LitBronzeWaterStill = 167
 }
 export declare enum DoodadTypeExtra {
     None = 999,
@@ -446,7 +452,8 @@ export declare enum DoodadTypeGroup {
     Lighthouse = 416,
     LitLighthouse = 417,
     Dripstone = 418,
-    Last = 419
+    WaterStill = 419,
+    Last = 420
 }
 export declare enum DoorOrientation {
     Default = 0,

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/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)[];
+    get(): (import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | import("../../language/ITranslation").ISerializedTranslation | (() => import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | import("../../language/ITranslation").ISerializedTranslation | import("../../utilities/string/Interpolator").IStringSection[] | undefined) | InfoProvider)[];
     add(...translations: Array<TranslationGenerator | InfoProvider | Falsy>): this;
     onlyIfHasContents(): this | undefined;
     addInfoGetter(provider: () => InfoProvider | undefined): this;

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

@@ -44,6 +44,7 @@ import TimeManager from "game/time/TimeManager";
 import Translation from "language/Translation";
 import World from "renderer/world/World";
 import type { IPostSerializeCallback, IPreSerializeCallback, ISerializer } from "save/serializer/ISerializer";
+import type Version from "utilities/Version";
 import type { IVersionInfo } from "utilities/Version";
 import { Direction } from "utilities/math/Direction";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
@@ -75,14 +76,14 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     readonly time: TimeManager;
     readonly world: World;
     saveBuildTime?: number;
-    saveVersion: string;
+    saveVersion: Version.String;
     biomeType: BiomeTypes;
     civilizationScore: number;
     civilizationScoreTiles: Record<number, number>;
     contaminatedWater: IWaterContamination[];
     creatureSpawnTimer: number;
     loadCount: number;
-    mapGenVersion: string;
+    mapGenVersion: Version.String;
     name?: string;
     position: IVector2;
     readonly mapSize: number;
@@ -91,7 +92,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     referenceId?: number;
     templateBiomeOptions: ITemplateBiomeOptions | undefined;
     tileContainers: ITileContainer[];
-    version: string;
+    version: Version.String;
     tileData: SaferNumberIndexedObject<SaferNumberIndexedObject<SaferNumberIndexedObject<ITileData[]>>>;
     readonly seeds: ISeeds;
     readonly seededRandom: Random<LegacySeededGenerator | PCGSeededGenerator>;

package/definitions/game/game/item/IItem.d.ts

@@ -899,7 +899,7 @@ export declare enum ItemType {
     WroughtIronTongs = 200,
     SheetOfGlass = 201,
     SolarStill = 202,
-    GraniteWaterStill = 203,
+    TinWaterStill = 203,
     GraniteSundial = 204,
     LitTallowTorch = 205,
     Sinew = 206,
@@ -993,10 +993,10 @@ export declare enum ItemType {
     ClayKiln = 294,
     ClayCampfire = 295,
     ClayFurnace = 296,
-    ClayWaterStill = 297,
+    CopperWaterStill = 297,
     SandstoneCampfire = 298,
     SandstoneFurnace = 299,
-    SandstoneWaterStill = 300,
+    WroughtIronWaterStill = 300,
     GraniteKiln = 301,
     WroughtIronAnvil = 302,
     IronAnvil = 303,
@@ -1396,7 +1396,7 @@ export declare enum ItemType {
     BasaltHammer = 697,
     BasaltAnvil = 698,
     BasaltDeadfall = 699,
-    BasaltWaterStill = 700,
+    IronWaterStill = 700,
     BasaltSundial = 701,
     BasaltBullet = 702,
     BasaltKnife = 703,
@@ -1453,7 +1453,8 @@ export declare enum ItemType {
     GraniteDripstone = 754,
     SandstoneDripstone = 755,
     BasaltDripstone = 756,
-    ClayDripstone = 757
+    ClayDripstone = 757,
+    BronzeWaterStill = 758
 }
 export declare enum ItemTypeExtra {
     None = 999,

package/definitions/game/game/mapgen/MapGenHelpers.d.ts

@@ -14,9 +14,10 @@ import type Island from "game/island/Island";
 import type { MapGenVersions } from "game/mapgen/IMapGen";
 import type { ITemplate, TileTemplateType } from "game/tile/ITerrain";
 import type Tile from "game/tile/Tile";
+import Version from "utilities/Version";
 export declare module MapGenHelpers {
-    function pickBasedOnVersion<T>(version: string, versions: MapGenVersions<T>): {
-        version: string;
+    function pickBasedOnVersion<T>(version: Version.String, versions: MapGenVersions<T>): {
+        version: Version.String;
         selection: T;
     };
     function startLoading(): Promise<void>;

package/definitions/game/mod/IMod.d.ts

@@ -8,6 +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 Version from "utilities/Version";
 export declare enum MultiplayerCompatibility {
     Clientside = "clientside",
     Serverside = "serverside",
@@ -23,7 +24,7 @@ export interface IModConfig {
     readonly unloadable?: boolean;
     readonly tags?: string[];
     readonly dependencies?: string[];
-    readonly waywardVersion?: string;
+    readonly waywardVersion?: Version.StringSemVer;
     readonly multiplayer?: MultiplayerCompatibility;
     readonly languages?: string[];
     readonly stylesheets?: string[];

package/definitions/game/save/ISaveManager.d.ts

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { SavePropertyFlag } from "save/serializer/ISerializer";
+import type Version from "utilities/Version";
 export declare const SLOT_MIN = 0;
 export declare const SLOT_GLOBAL = -1;
 export declare const SLOT_MULTIPLAYER = -2;
@@ -38,7 +39,7 @@ export declare enum CompressionType {
 }
 export declare const defaultCompressionType = CompressionType.PakoDeflate;
 export interface ISaveObject {
-    version: string;
+    version: Version.String;
     compressionType: CompressionType;
     data: Record<string, any>;
 }
@@ -48,8 +49,8 @@ export interface ISerializeProperty {
     enableStats?: boolean;
     skipCompression?: boolean;
     savePropertyFlag?: SavePropertyFlag;
-    shouldSerialize?(version: string): boolean;
-    shouldDeserialize?(version: string): boolean;
+    shouldSerialize?(version: Version.String): boolean;
+    shouldDeserialize?(version: Version.String): boolean;
 }
 export interface ISaveManagerEvents {
     /**

package/definitions/game/save/data/SaveDataGlobal.d.ts

@@ -15,10 +15,11 @@ import type { IHighscore, IOptions } from "save/data/ISaveDataGlobal";
 import type { IDialogInfo } from "ui/old/IOldUi";
 import type { ISavedCharacter } from "ui/screen/screens/menu/menus/character/Character";
 import type EnumInfo from "utilities/enum/EnumInfo";
+import type Version from "utilities/Version";
 export default class SaveDataGlobal {
     static defaultOptions: IOptions;
     gameCrafted: Record<number, ICrafted>;
-    gameLastPlayedVersion: string;
+    gameLastPlayedVersion: Version.String;
     gameHighscores: IHighscore[];
     gamePlayedCount: number;
     options: IOptions;

package/definitions/game/save/serializer/ISerializer.d.ts

@@ -9,9 +9,10 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { Game } from "game/Game";
+import type Version from "utilities/Version";
 export interface ISerializer {
     readonly game: Game;
-    readonly version: string;
+    readonly version: Version.String;
     readonly metadata: Map<SerializerMetadataKey, any>;
     readonly dataView: DataView;
     byteOffset: number;
@@ -33,7 +34,7 @@ export declare enum SerializerMetadataKey {
     StringStats = 3
 }
 export interface ISerializerOptions {
-    version: string;
+    version: Version.String;
     includeFlags?: SavePropertyFlag;
     emptyObjectMode?: boolean;
     disableJitDeserialization?: boolean;

package/definitions/game/save/serializer/Serializer.d.ts

@@ -12,6 +12,7 @@ import type { Game } from "game/Game";
 import type { ISerializer, ISerializerOptions } from "save/serializer/ISerializer";
 import { SavePropertyFlag, SerializerMetadataKey, Types } from "save/serializer/ISerializer";
 import StringTokenizer from "save/serializer/StringTokenizer";
+import type Version from "utilities/Version";
 export default class Serializer implements ISerializer {
     readonly game: Game;
     private readonly options;
@@ -23,7 +24,7 @@ export default class Serializer implements ISerializer {
     readonly metadata: Map<SerializerMetadataKey, any>;
     dataView: DataView;
     byteOffset: number;
-    readonly version: string;
+    readonly version: Version.String;
     private readonly includeFlags;
     private readonly emptyObjectMode;
     private readonly disableJitDeserialization;

package/definitions/game/save/upgrade/UpgradePlayer.d.ts

@@ -10,8 +10,8 @@
  */
 import type Player from "game/entity/player/Player";
 import type { Game } from "game/Game";
-import type { IVersionInfo } from "utilities/Version";
-export default function upgradePlayer(game: Game, player: Player, saveVersion: IVersionInfo, isLocalPlayer: boolean): string[];
+import Version from "utilities/Version";
+export default function upgradePlayer(game: Game, player: Player, saveVersion: Version.Info, isLocalPlayer: boolean): string[];
 /**
  * Called after loading item & tile references
  */

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/impl/TranslationImpl").default | import("../../../../../language/ITranslation").ISerializedTranslation | import("../../../../../language/dictionary/UiTranslation").default | undefined;
+    getName(): import("../../../../../language/impl/TranslationImpl").default | import("../../../../../language/dictionary/UiTranslation").default | import("../../../../../language/ITranslation").ISerializedTranslation | undefined;
     openBook(item: Item): void;
     private getText;
     protected onInventoryItemRemove(_: any, itemOrItems: Item | Item[]): void;

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

@@ -8,9 +8,10 @@
  * 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 TranslationImpl from "language/impl/TranslationImpl";
 export interface IVersionInfo {
-    str: string;
-    strSemver: string;
+    str: Version.String;
+    strSemver: Version.StringSemVer;
     stage: "beta" | "release";
     major: number;
     minor: number;
@@ -23,28 +24,73 @@ export interface IVersionInfo {
     update?: number;
 }
 declare module Version {
+    export type Stage = "beta" | "release";
+    export type String = `${Stage}${bigint}.${bigint}.${bigint}` | `${Stage}${bigint}.${bigint}` | `${Stage}${bigint}`;
+    export type StringSemVer = `${bigint}.${bigint}.${bigint}-${Stage}` | `${bigint}.${bigint}.${bigint}`;
+    export type Month = "jan" | "feb" | "mar" | "apr" | "may" | "jun" | "jul" | "aug" | "sep" | "oct" | "nov" | "dec";
+    export type DateString = `${Month} ${bigint} ${bigint} ${bigint}:${bigint | "00"}`;
     export const versionInfoRegExp: RegExp;
     export const versionInfoRegExpSemver: RegExp;
     /**
      * Returns whether the given version is compatible with the game's version. This is used to check, for example,
      * if a mod is compatible with the game's version.
+     *
+     * - Compatible versions in "beta" stage require identical stage, major, minor, and a patch less than or equal to the current patch.
+     * - Compatible versions in "release" stage require identical stage and major, and a minor and patch less than or equal to the current minor and patch.
      */
-    export function isCompatible(version: IVersionInfo | string): boolean;
+    export function isCompatible(version: IVersionInfo | Version.String | Version.StringSemVer): boolean;
     /**
      * Returns whether the given `version` is `atLeast` another version. This can be used, for example,
      * to see if a save or mod was created/edited after a specific thing was implemented.
      */
-    export function isAtLeast(version: IVersionInfo | string, atLeast: IVersionInfo | string): boolean;
-    export function create(stage: "beta" | "release", major: number, minor: number, patch?: number, date?: Date): IVersionInfo;
-    export function getVersionInfo(version: string): IVersionInfo;
+    export function isAtLeast(version: IVersionInfo | Version.String | Version.StringSemVer, atLeast: IVersionInfo | Version.String | Version.StringSemVer): boolean;
+    /**
+     * Returns if `checkVersion` is older than `isBefore`
+     */
+    export function isBefore(checkVersion: IVersionInfo | Version.String | Version.StringSemVer, isBefore: IVersionInfo | Version.String | Version.StringSemVer): boolean;
+    export function createRawVersionInfo(stage: Version.Stage, major: number, minor: number, patch?: number, date?: Date): IVersionInfo;
+    export function convertStringToRawInfo(version: Version.String | Version.StringSemVer): IVersionInfo;
+    export function create(stage: Version.Stage, major: number, minor: number, patch?: number, date?: Date): Info;
+    export function getVersionInfo(version: IVersionInfo | Version.String | Version.StringSemVer): Info;
     export function isSameVersion(version: IVersionInfo, compareVersion: IVersionInfo): boolean;
-    export function getVersionDisplayString(version?: string | IVersionInfo, development?: boolean): string;
-    export function getUpdateDisplayString(version?: string | IVersionInfo): string | undefined;
+    export function getVersionDisplayTranslation(version?: Version.String | Version.StringSemVer | IVersionInfo, development?: boolean): TranslationImpl;
+    export function getUpdateDisplayTranslation(version?: Version.String | Version.StringSemVer | IVersionInfo): TranslationImpl | undefined;
     const timezones: {
         nz: string;
         build: string;
     };
-    export function isBefore(date: Date, dateStr: `${string} ${number} ${number} ${number}:${number}`, timezone: keyof typeof timezones): boolean;
+    export function isTimeBefore(date: Date, dateStr: DateString, timezone: keyof typeof timezones): boolean;
+    export interface Info extends IVersionInfo {
+    }
+    export class Info {
+        constructor(info: IVersionInfo | Version.String | Version.StringSemVer);
+        /**
+         * Returns whether this version is compatible with the game's version. This is used to check, for example,
+         * if a mod is compatible with the game's version.
+         *
+         * - Compatible versions in "beta" stage require identical stage, major, minor, and a patch less than or equal to the current patch.
+         * - Compatible versions in "release" stage require identical stage and major, and a minor and patch less than or equal to the current minor and patch.
+         */
+        isCompatible(): boolean;
+        /**
+         * Returns whether this version is greater than or equal to the given version. This can be used, for example,
+         * to see if a save or mod was created/edited after a specific thing was implemented.
+         */
+        isAtLeast(version: IVersionInfo | Version.String | Version.StringSemVer): boolean;
+        /**
+         * Returns whether this version is older than the given version.
+         */
+        isBefore(version: IVersionInfo | Version.String | Version.StringSemVer): boolean;
+        /**
+         * Returns whether this version is older than the given build time.
+         *
+         * **Note:** Always returns `true` if this version object doesn't have a date set.
+         */
+        isBefore(dateStr: DateString, timezone: keyof typeof timezones): boolean;
+        equals(version: IVersionInfo | Version.String | Version.StringSemVer): boolean;
+        getTranslation(): TranslationImpl;
+        getUpdateTranslation(): TranslationImpl | undefined;
+    }
     export {};
 }
 export default Version;

package/package.json

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