@wayward/types 2.14.3-beta.dev.20241226.1 → 2.14.4-beta

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

@@ -10,7 +10,7 @@
  */
 import type { ISerializeProperty } from "@wayward/game/save/ISaveManager";
 import { SavePropertyFlag } from "@wayward/game/save/serializer/ISerializer";
-import Version from "@wayward/game/utilities/Version";
+import Version from "@wayward/utilities/Version";
 declare const propertiesToSerializeObject: {
     game: {
         property: string[];
@@ -57,6 +57,10 @@ declare const propertiesToSerializeObject: {
     saveManagerOriginalVersion: {
         property: string[];
     };
+    gameCreationInfo: {
+        property: string[];
+        savePropertyFlag: SavePropertyFlag;
+    };
     gameThumbnail: {
         property: string[];
         savePropertyFlag: SavePropertyFlag;

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

@@ -12,7 +12,7 @@ import type { Game } from "@wayward/game/game/Game";
 import type { ISerializer, ISerializerOptions } from "@wayward/game/save/serializer/ISerializer";
 import { SavePropertyFlag, SerializerMetadataKey, Types } from "@wayward/game/save/serializer/ISerializer";
 import StringTokenizer from "@wayward/game/save/serializer/StringTokenizer";
-import type Version from "@wayward/game/utilities/Version";
+import type Version from "@wayward/utilities/Version";
 export default class Serializer implements ISerializer {
     readonly game: Game;
     private readonly options;

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

@@ -11,7 +11,7 @@
 import type { Game } from "@wayward/game/game/Game";
 import type Player from "@wayward/game/game/entity/player/Player";
 import UpgradesArray from "@wayward/game/save/upgrade/UpgradesArray";
-import Version from "@wayward/game/utilities/Version";
+import type Version from "@wayward/utilities/Version";
 export default function upgradePlayer(game: Game, player: Player, saveVersion: Version.Info, isLocalPlayer: boolean): UpgradesArray;
 /**
  * Called after loading item & tile references

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

@@ -8,5 +8,5 @@
  * 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 "@wayward/game/utilities/Version";
+import type Version from "@wayward/utilities/Version";
 export default function upgradeGlobalSave(saveVersion: Version.Info): void;

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

@@ -22,11 +22,17 @@ import type Item from "@wayward/game/game/item/Item";
 import type { IGameOptions } from "@wayward/game/game/options/IGameOptions";
 import type TileEvent from "@wayward/game/game/tile/TileEvent";
 import type { UpgradesArrayCompressedPusher } from "@wayward/game/save/upgrade/UpgradesArray";
-import type Version from "@wayward/game/utilities/Version";
+import type Version from "@wayward/utilities/Version";
 import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
+import type Tile from "@wayward/game/game/tile/Tile";
+import type { ITileData } from "@wayward/game/game/tile/ITerrain";
+import type Human from "@wayward/game/game/entity/Human";
+import type Entity from "@wayward/game/game/entity/Entity";
 export interface IUpgradeVersion {
     name?: string;
     buildId?: IBuildId;
+    defaultData?: any;
+    data?: any;
     applies(buildVersion: Version.Info): boolean;
     upgradeGlobal?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher): any;
     upgradeGame?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, game: Game): any;
@@ -34,6 +40,8 @@ export interface IUpgradeVersion {
     upgradePlayer?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, player: Player, isLocalPlayer: boolean): any;
     upgradeGameOptions?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, options: IGameOptions, defaultOptions: IGameOptions): any;
     upgradeMessages?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, messages: IMessageManager): any;
+    upgradeEntity?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, entity: Entity): any;
+    upgradeHuman?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, human: Human): any;
     upgradeCreature?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, creature: Creature): any;
     upgradeItem?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, item: Item): any;
     upgradeDoodad?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, doodad: Doodad): any;
@@ -42,11 +50,18 @@ export interface IUpgradeVersion {
     upgradeCorpse?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, corpse: Corpse): any;
     upgradeAi?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, ai: AiManager): any;
     upgradeCreatureZone?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, zone: CreatureZone): any;
+    upgradeTile?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, tile: Tile): any;
+    upgradeTileData?(version: Version.Info, upgrades: UpgradesArrayCompressedPusher, tile: Tile, tileData: ITileData[]): any;
 }
 export type UpgradeType = Exclude<keyof IUpgradeVersion, "applies">;
 export type UpgradeParameters<TYPE extends UpgradeType> = Required<IUpgradeVersion>[TYPE] extends (_v: any, _u: any, ...params: infer PARAMS) => any ? PARAMS : never;
 export declare function oldify<CURRENT, OLD>(current: CURRENT): Merge<CURRENT, Partial<OLD>>;
-export interface IUpgradeVersionDefinition extends Omit<IUpgradeVersion, "applies" | "name" | "buildId"> {
+export interface IUpgradeVersionDefinition<T = any> extends Omit<IUpgradeVersion, "applies" | "name" | "buildId" | "defaultData" | "data"> {
     applies?: IUpgradeVersion["applies"];
+    data?: T;
 }
-export default function (definition: IUpgradeVersionDefinition): IUpgradeVersionDefinition;
+export interface IUpgradeVersionDefinitionWithData<T = any> extends IUpgradeVersionDefinition<T> {
+    data: T;
+}
+export default function <T>(definition: IUpgradeVersionDefinitionWithData<T>): IUpgradeVersionDefinitionWithData<T>;
+export default function <T>(definition: IUpgradeVersionDefinition<T>): IUpgradeVersionDefinition<T>;

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

@@ -10,8 +10,11 @@
  */
 import type { IUpgradeVersion, UpgradeParameters, UpgradeType } from "@wayward/game/save/upgrade/UpgradeVersion";
 import type UpgradesArray from "@wayward/game/save/upgrade/UpgradesArray";
-import type Version from "@wayward/game/utilities/Version";
+import type Version from "@wayward/utilities/Version";
+import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
+export declare const BUILD_TIME_INTRODUCED_TIME: Date;
 declare namespace UpgradeVersionRegistry {
+    function getMostRecentBuildId(): IBuildId | undefined;
     function getAll(): readonly IUpgradeVersion[];
     function run<TYPE extends UpgradeType>(version: Version.Info, messages: UpgradesArray, which: TYPE, ...params: UpgradeParameters<TYPE>): void;
 }

package/definitions/game/save/upgrade/versions/beta2.14.0/_beta.2.14.0-dev20240828.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev00000001.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev00000002.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20240827.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20240828.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20240829.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20240901.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20240905.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20241024.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20241129.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.3/beta2.14.3-dev20241223.d.ts

@@ -8,5 +8,5 @@
  * 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
  */
-declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition;
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
 export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.4/beta.2.14.4-dev20250422.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2011-2024 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
+ */
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
+export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.4/beta2.14.4-dev20241231.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2011-2024 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
+ */
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
+export default _default;

package/definitions/game/save/upgrade/versions/beta2.14.4/beta2.14.4-dev20250220.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2011-2024 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
+ */
+declare const _default: import("@wayward/game/save/upgrade/UpgradeVersion").IUpgradeVersionDefinition<unknown>;
+export default _default;

package/definitions/game/steamworks/ISteamworks.d.ts

@@ -47,12 +47,6 @@ export interface IDedicatedServerInfo {
     syncChecks: MultiplayerSyncCheckLevel;
     gameCode?: string;
 }
-export interface IBuild {
-    name: string;
-    time: number;
-    publishName?: string;
-    publishTime?: string;
-}
 export declare enum SteamStatArea {
     Music = 0,
     Renderer = 1
@@ -63,3 +57,4 @@ export declare const steamStatTypes: {
 };
 export type SteamStatTypeValues<T extends SteamStatArea> = typeof steamStatTypes[T][keyof typeof steamStatTypes[T]];
 export declare const actionToSteamMarker: OptionalDescriptions<ActionType, SteamTimelineMarker>;
+export type RunningContext = "Steam" | "Electron" | "Node.js" | "Browser";

package/definitions/game/steamworks/Steamworks.d.ts

@@ -12,15 +12,15 @@ import type { HeapStatistics } from "electron";
 import type { Game } from "@wayward/game/game/Game";
 import type Entity from "@wayward/game/game/entity/Entity";
 import IActionContext from "@wayward/game/game/entity/action/IActionContext";
-import { ModType } from "@wayward/game/mod/IModInformation";
+import { ModState, ModType } from "@wayward/game/mod/IModInformation";
 import type { ModInformation } from "@wayward/game/mod/ModInformation";
 import type { IJoinServerOptions, ServerInfo } from "@wayward/game/multiplayer/IMultiplayer";
-import type { IBuild, IDedicatedServerInfo, IModPath, ISteamworksEvents, SteamStatTypeValues } from "@wayward/game/steamworks/ISteamworks";
+import type { IDedicatedServerInfo, IModPath, ISteamworksEvents, RunningContext, SteamStatTypeValues } from "@wayward/game/steamworks/ISteamworks";
 import { SteamStatArea } from "@wayward/game/steamworks/ISteamworks";
 import type { ISteamBeta } from "@wayward/hosts/shared/interfaces";
 import { type IMatchmakingServer, type INapiDiscordPresenceInfo, type IRemoteFile, type ISteamFriend, type ISteamId, type ISteamworksNetworking, type IWaywardPreload, type IWorkshopItem, type LobbyType } from "@wayward/hosts/shared/interfaces";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
-import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
+import type { IBuild, IBuildId } from "@wayward/hosts/shared/globalTypes";
 export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
     private readonly game;
     protected initialized: boolean;
@@ -89,9 +89,10 @@ export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
     getMatchmakingServer(): IMatchmakingServer | undefined;
     getMatchmakingServerPort(): number;
     getSteamNetworking(): ISteamworksNetworking | undefined;
-    setBuildId(id?: string): void;
+    /** @deprecated For console use */
+    protected setBuildId(id?: string): void;
     initialize(): Promise<IWaywardPreload | undefined>;
-    enableSafePaths(): void;
+    enableSafePaths(): Promise<void>;
     onUnload(): void;
     getHeapStatistics(): Promise<HeapStatistics | undefined>;
     setFullscreen(fullscreen: boolean): Promise<void>;
@@ -129,6 +130,10 @@ export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
      * - {@link Island.saveBuildId}
      */
     get buildId(): IBuildId | undefined;
+    /**
+     * Returns a string about how the game is running
+     */
+    get runningContext(): RunningContext;
     getPublishedMods(): IWorkshopItem[] | undefined;
     getStatInt(name: string): number | undefined;
     /**
@@ -214,6 +219,10 @@ export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
     private refreshSetupMods;
     private cleanupTemporaryLocalFiles;
     private cleanupTemporaryRemoteFiles;
+    /**
+     * Called when the overlay is closed or when the refresh mods button is clicked
+     */
+    refreshWorkshopMods(waitForRefresh?: boolean, initialModState?: ModState.Enabled | ModState.Disabled): Promise<void>;
     private refreshPublishedMods;
     private getIdFromWorkshopItem;
     private syncWorkshopItems;

package/definitions/game/ui/{screen/screens/splash → component}/Notice.d.ts

@@ -27,11 +27,13 @@ export declare enum NoticeClasses {
     Markdown = "notice-markdown"
 }
 export default class Notice extends Component {
-    static await(noticeClass: Class<Notice>, appendTo: Component): Promise<any>;
+    static await(noticeClass: Class<Notice>, appendTo: Component | HTMLElement): Promise<boolean>;
     readonly sections: Component<HTMLElement>;
     readonly footer: Component<HTMLElement>;
     readonly footerContent: Component<HTMLElement>;
-    readonly dismissButton: Button;
+    private returnValue;
+    readonly proceedButton: Button;
+    get cancelButton(): Button;
     constructor();
     addSection(initializer: (section: NoticeSection) => any): this;
     hideAndRemove(): Promise<void>;

package/definitions/game/ui/component/dropdown/IslandDropdown.d.ts

@@ -20,7 +20,7 @@ export default class IslandDropdown<OTHER_OPTIONS extends string = never> extend
     protected getTranslation(islandId: IslandId): TranslationImpl;
     protected sortEnumOptions(o1: IDropdownSortableOption<string>, o2: IDropdownSortableOption<string>): number;
     protected getGroupName(biome: BiomeType): string;
-    protected optionTooltipInitializer: (tooltip: Tooltip, option: string) => Promise<void> | undefined;
+    protected optionTooltipInitializer: (tooltip: Tooltip, option: string) => Promise<boolean> | undefined;
     protected shouldIncludeOtherOptionsInGroupFilter(): boolean;
     protected isInGroup(islandId: IslandId, biome: BiomeType): boolean;
     protected getGroups(): BiomeType[];

package/definitions/game/ui/component/dropdown/MagicalPropertyDropdown.d.ts

@@ -8,8 +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 { MagicalPropertyIdentityHash } from "@wayward/game/game/magic/MagicalPropertyManager";
-import { MagicalPropertyIdentity } from "@wayward/game/game/magic/MagicalPropertyManager";
+import { MagicalPropertyIdentity, type MagicalPropertyIdentityHash } from "@wayward/game/game/magic/IMagicalProperty";
 import MagicalPropertyType from "@wayward/game/game/magic/MagicalPropertyType";
 import type TranslationImpl from "@wayward/game/language/impl/TranslationImpl";
 import type { IDropdownOption } from "@wayward/game/ui/component/Dropdown";