@wayward/types 2.14.4-beta.dev.20241228.1 → 2.14.4-beta.dev.20241230.1

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

@@ -10,7 +10,7 @@
  */
 import { Uninit } from "@wayward/game/Uninit";
 import CommandManager from "@wayward/game/command/CommandManager";
-import type { IGameEvents, IMovementTime, IPlayOptions, ISynchronizeState } from "@wayward/game/game/IGame";
+import type { IGameEvents, IGameUpgradeState, IMovementTime, IPlayOptions, ISynchronizeState } from "@wayward/game/game/IGame";
 import { PauseSource, SaveType, TurnMode } from "@wayward/game/game/IGame";
 import { TickHelper } from "@wayward/game/game/TickHelper";
 import type { BiomeTypes } from "@wayward/game/game/biome/IBiome";
@@ -51,7 +51,6 @@ import type { IVector2 } from "@wayward/game/utilities/math/IVector";
 import { WebWorkerManager } from "@wayward/game/webWorker/WebWorkerManager";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
 import type { Random } from "@wayward/utilities/random/Random";
-import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
 export declare class Game extends EventEmitter.Host<IGameEvents> {
     get isChallenge(): boolean;
     private difficultyOptions;
@@ -71,9 +70,10 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
      * The version the save was originally created on
      */
     version: Version.String;
-    lastSaveVersion?: Version.String;
-    lastSaveBuildTime?: number;
-    lastSaveBuildId?: IBuildId;
+    /**
+     * Set when a game save upgrade is running
+     */
+    upgradeState?: IGameUpgradeState;
     readonly interval = 16.6666;
     readonly autoSave: AutoSave;
     readonly commandManager: CommandManager;

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

@@ -31,6 +31,7 @@ import type { IReplayLogEntry } from "@wayward/game/replay/IReplayLogEntry";
 import type { IHighscoreOld, IOptions } from "@wayward/game/save/data/ISaveDataGlobal";
 import type Version from "@wayward/game/utilities/Version";
 import type { IVector2, IVector3 } from "@wayward/game/utilities/math/IVector";
+import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
 import type { IRange } from "@wayward/utilities/math/Range";
 export interface IGameEvents {
     /**
@@ -303,6 +304,20 @@ export interface IMovementTime {
     start: number;
     end: number;
 }
+export interface IGameUpgradeState {
+    /**
+     * Current state of the upgrade. Set based on what is upgrading at the time.
+     */
+    state: GameUpgradeState;
+    readonly lastSaveVersion: Version.String;
+    readonly lastSaveBuildTime: number;
+    readonly lastSaveBuildId: IBuildId | undefined;
+}
+export declare enum GameUpgradeState {
+    None = 0,
+    Game = 1,
+    Island = 2
+}
 export declare const LINE_OF_SIGHT_RADIUS = 15;
 export declare const LINE_OF_SIGHT_RADIUS_MAX = 20;
 export declare const LINE_OF_SIGHT_DETAIL = 4;

package/definitions/game/game/entity/player/Player.d.ts

@@ -92,6 +92,15 @@ export default class Player extends Human<undefined, number, ReferenceType.Playe
      */
     private onLoadOrUnload;
     setup(spawnTile: Tile, respawn: boolean): void;
+    private setupEquipment;
+    private setupStats;
+    private setupSkills;
+    private setupRandomInventory;
+    private setupStatuses;
+    private setupItemsFromGroups;
+    private setupAdditionalItemsFromOptions;
+    private setupEquipmentFromOptions;
+    private setupSkillsFromOptions;
     protected onNoInput(): void;
     updateTables(source: string, options?: Partial<{
         allowCaching: boolean;

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

@@ -137,7 +137,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     get isFastForwarding(): boolean;
     constructor(game?: Game, position?: IVector2, seed?: number, mapSize?: number);
     toString(): string;
-    createStaticRandom(seed?: number): Random<PCGSeededGenerator>;
+    createStaticRandom(seed?: number, advance?: number): Random<PCGSeededGenerator>;
     private registerMemoryLeakDetector;
     preSerializeObject(serializer: ISerializer): void;
     postSerializeObject(serializer: ISerializer): void;

package/definitions/game/game/magic/MagicalPropertyType.d.ts

@@ -12,7 +12,7 @@ import Deity from "@wayward/game/game/deity/Deity";
 import { DamageType } from "@wayward/game/game/entity/IEntity";
 import { SkillType } from "@wayward/game/game/entity/IHuman";
 import { Stat } from "@wayward/game/game/entity/IStats";
-import type { IItemDescription, IMagicalPropertyInfo } from "@wayward/game/game/item/IItem";
+import type { IItemDescription, IMagicalPropertyInfo, ItemType } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 import type { MagicalPropertyIdentity } from "@wayward/game/game/magic/MagicalPropertyManager";
 import type { TranslationArg } from "@wayward/game/language/ITranslation";
@@ -94,7 +94,7 @@ export interface IMagicalPropertyDescription {
     /**
      * Generates the magical property value when added.
      */
-    getInfo(item: Item, description: IItemDescription): IMagicalPropertyInfo | undefined;
+    getInfo(item: Item | ItemType, description: IItemDescription): IMagicalPropertyInfo | undefined;
     /**
      * By default, all magical property types can be inscribed. This allows disabling that feature for this magical property type.
      */
@@ -111,4 +111,22 @@ export interface MagicalPropertyTypeSubTypeMap {
     [MagicalPropertyType.ElementalDamage]: DamageType;
     [MagicalPropertyType.StatPotency_EquipmentImproveConsumableStats]: Stat;
 }
+export declare namespace MagicalPropertyInfoHelper {
+    /**
+     * Creates a partial `IMagicalPropertyDescription` that generates an integer value from min (inclusive) to max (exclusive),
+     * with an *actual* max for the magical property using `max`. (1 higher)
+     */
+    function intRange(item: Item | ItemType, min: number, max: number, generatedMax?: number): {
+        min: number;
+        max: number;
+        value: () => number;
+    };
+    function randomInt(item: Item | ItemType, maxExclusive: number): number;
+    function randomInt(item: Item | ItemType, min: number, maxExclusive: number): number;
+    function randomIntInRange(item: Item | ItemType, max: number): number;
+    function randomIntInRange(item: Item | ItemType, min: number, maxInclusive: number): number;
+    function randomFloat(item: Item | ItemType, maxExclusive: number): number;
+    function randomFloat(item: Item | ItemType, min: number, maxExclusive: number): number;
+    function functionRequiringItem<T>(item: Item | ItemType, fn: (item: Item) => T): () => T;
+}
 export declare const magicalPropertyDescriptions: PartialRecord<MagicalPropertyType, IMagicalPropertyDescription>;

package/definitions/game/game/options/GameOptions.d.ts

@@ -12,7 +12,7 @@ import type { SkillType } from "@wayward/game/game/entity/IHuman";
 import type { ItemType } from "@wayward/game/game/item/IItem";
 import type { IGameOptions, IGameOptionsSkill } from "@wayward/game/game/options/IGameOptions";
 import { GameMode } from "@wayward/game/game/options/IGameOptions";
-import Version from "@wayward/game/utilities/Version";
+import type Version from "@wayward/game/utilities/Version";
 export declare const CREATURE_SPAWN_LIMIT = 15;
 declare namespace GameOptions {
     export function getDefault(difficulty?: GameMode, seed?: number): IGameOptions;

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

@@ -37,82 +37,84 @@ export declare enum MultiplayerSyncCheckLevel {
     All = "all"
 }
 export declare enum MultiplayerSyncCheck {
-    Action = 0,
-    ActionAttack = 1,
-    ActionMove = 2,
-    Alignment = 3,
-    BaseEntityManager = 4,
-    CanASeeB = 5,
-    Container = 6,
-    Creature = 7,
-    CreatureAi = 8,
-    CreatureAiAdd = 9,
-    CreatureAiEmit = 10,
-    CreatureAiMaskAdd = 11,
-    CreatureAiMaskRemove = 12,
-    CreatureAiRemove = 13,
-    CreatureAiSet = 14,
-    CreatureCheckMove = 15,
-    CreatureMovement = 16,
-    CreatureNearestPlayer = 17,
-    CreatureOffer = 18,
-    CreatureStatChange = 19,
-    Damage = 20,
-    Dismantle = 21,
-    Doodad = 22,
-    DoodadManager = 23,
-    EncumberedStatus = 24,
-    Entity = 25,
-    EntityPosition = 26,
-    ExhaustedPreMove = 27,
-    FlowFieldHashCode = 28,
-    FlowFieldPenalty = 29,
-    FlowFieldUpdate = 30,
-    FlowFieldUpdateTile = 31,
-    FlowFieldValue = 32,
-    HandToUse = 33,
-    HealthChange = 34,
-    History = 35,
-    InventoryCount = 36,
-    Island = 37,
-    IslandCivilizationScore = 38,
-    Islands = 39,
-    IsTileEmpty = 40,
-    Item = 41,
-    ItemCraft = 42,
-    ItemDamage = 43,
-    ItemOrder = 44,
-    LastCreationIds = 45,
-    Merchant = 46,
-    MilestoneSeed = 47,
-    Modifier = 48,
-    MoveToTile = 49,
-    NPC = 50,
-    Option = 51,
-    PenaltyFieldHashCode = 52,
-    PlaceOnTile = 53,
-    PlayerManager = 54,
-    Players = 55,
-    PlayerSetup = 56,
-    Random = 57,
-    Seed = 58,
-    SeededGenerator = 59,
-    SetPosition = 60,
-    SetZ = 61,
-    SkillGain = 62,
-    StaminaChanges = 63,
-    StatChange = 64,
-    Stats = 65,
-    Status = 66,
-    StatusChange = 67,
-    TemperatureManager = 68,
-    Temporary = 69,
-    Tick = 70,
-    TileEvent = 71,
-    Time = 72,
-    UpdateDirection = 73,
-    Weight = 74,
-    WorldUpdateTile = 75
+    "END REGION" = 0,
+    "START REGION" = 1,
+    Action = 2,
+    ActionAttack = 3,
+    ActionMove = 4,
+    Alignment = 5,
+    BaseEntityManager = 6,
+    CanASeeB = 7,
+    Container = 8,
+    Creature = 9,
+    CreatureAi = 10,
+    CreatureAiAdd = 11,
+    CreatureAiEmit = 12,
+    CreatureAiMaskAdd = 13,
+    CreatureAiMaskRemove = 14,
+    CreatureAiRemove = 15,
+    CreatureAiSet = 16,
+    CreatureCheckMove = 17,
+    CreatureMovement = 18,
+    CreatureNearestPlayer = 19,
+    CreatureOffer = 20,
+    CreatureStatChange = 21,
+    Damage = 22,
+    Dismantle = 23,
+    Doodad = 24,
+    DoodadManager = 25,
+    EncumberedStatus = 26,
+    Entity = 27,
+    EntityPosition = 28,
+    ExhaustedPreMove = 29,
+    FlowFieldHashCode = 30,
+    FlowFieldPenalty = 31,
+    FlowFieldUpdate = 32,
+    FlowFieldUpdateTile = 33,
+    FlowFieldValue = 34,
+    HandToUse = 35,
+    HealthChange = 36,
+    History = 37,
+    InventoryCount = 38,
+    Island = 39,
+    IslandCivilizationScore = 40,
+    Islands = 41,
+    IsTileEmpty = 42,
+    Item = 43,
+    ItemCraft = 44,
+    ItemDamage = 45,
+    ItemOrder = 46,
+    LastCreationIds = 47,
+    Merchant = 48,
+    MilestoneSeed = 49,
+    Modifier = 50,
+    MoveToTile = 51,
+    NPC = 52,
+    Option = 53,
+    PenaltyFieldHashCode = 54,
+    PlaceOnTile = 55,
+    PlayerManager = 56,
+    Players = 57,
+    PlayerSetup = 58,
+    Random = 59,
+    Seed = 60,
+    SeededGenerator = 61,
+    SetPosition = 62,
+    SetZ = 63,
+    SkillGain = 64,
+    StaminaChanges = 65,
+    StatChange = 66,
+    Stats = 67,
+    Status = 68,
+    StatusChange = 69,
+    TemperatureManager = 70,
+    Temporary = 71,
+    Tick = 72,
+    TileEvent = 73,
+    Time = 74,
+    UpdateDirection = 75,
+    Weight = 76,
+    WorldUpdateTile = 77
 }
 export declare const maxPlayers = 32;
 export declare const packetTickRate = 16.6666;

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

@@ -0,0 +1,22 @@
+/*!
+ * 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
+ */
+type Decorator = (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * **Note:** Do not intentionally throw errors through this decorated function. It does not close the region if an error is thrown.
+ */
+export default function SyncRegion(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+/**
+ * **Note:** Do not intentionally throw errors through this decorated function. It does not close the region if an error is thrown.
+ *
+ * **Warning:** Do not combine this with other decorators.
+ */
+export default function SyncRegion<T>(detailProvider: (target: T) => string): Decorator;
+export {};

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

@@ -29,8 +29,10 @@ export interface ISyncCheck {
 }
 export type SyncChecks = ISyncCheck[];
 export interface IHashedSyncCheck {
-    hash: number;
+    hashServer: number;
+    hashClient: number;
     syncCheck: SyncChecks;
+    type: "enabled" | "universal";
 }
 export interface IPacket<T = any> {
     getAllowedStates(): ConnectionState;

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/game/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/utilities/Version.d.ts

@@ -77,7 +77,6 @@ declare namespace Version {
         pt: string;
         build: string;
     };
-    export function isTimeBefore(date: Date, dateStr: DateString, timezone: keyof typeof timezones): boolean;
     export interface Info extends IVersionInfo {
     }
     export class Info {

package/definitions/game/utilities/object/PrettyJsonStringify.d.ts

@@ -8,4 +8,27 @@
  * 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
  */
+/**
+ * Formats a JSON string with custom pretty-printing rules.
+ * This function first stringifies the data with tabs as indentation, then applies several formatting improvements:
+ *
+ * 1. Removes unnecessary tabbing before values in arrays
+ * 2. Reduces multiple spaces between comma-separated values to a single space
+ * 3. Removes unnecessary whitespace after opening brackets
+ * 4. Ensures consistent spacing after commas in arrays and objects
+ *
+ * @param data - The data to be stringified. Can be any JSON-serializable value
+ * @returns A formatted JSON string with customized pretty-printing
+ *
+ * @example
+ * const data = { arr: [1, 2, 3], obj: { a: 1 } };
+ * console.log(prettyJsonStringify(data));
+ * // Output:
+ * // {
+ * //     "arr": [1, 2, 3],
+ * //     "obj": {
+ * //         "a": 1
+ * //     }
+ * // }
+ */
 export default function prettyJsonStringify(data: any): string;

package/definitions/utilities/Errors.d.ts

@@ -24,6 +24,10 @@ declare namespace Errors {
      * Returns the Error callsite string for the caller of the current function.
      */
     function caller(skip?: number): string;
+    /**
+     * Returns the filename of the caller of the current function.
+     */
+    function callerFileBasename(skip?: number): string;
 }
 export default Errors;
 export declare function ensureExhaustive(value: never): never;

package/definitions/utilities/random/IRandom.d.ts

@@ -23,7 +23,7 @@ export interface IRandomGenerator<T = any> {
     pushSeed(seed?: T): void;
     popSeed(): T;
     get(): number;
-    advance?(): this;
+    advance?(times?: number): this;
     asPCG?: PCGSeededGenerator;
 }
 export declare enum RandomInstance {

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

@@ -97,5 +97,5 @@ export declare class Random<G extends IRandomGenerator = IRandomGenerator> {
      * @returns number between provided min/max, rounded.
      */
     intInRangeExponential(min: number, max: number, steepness?: number): number;
-    advance(): this;
+    advance(times?: number): this;
 }

package/definitions/utilities/random/RandomUtilities.d.ts

@@ -21,7 +21,7 @@ export declare function convertStringToSeed(seed: string | number): number;
 /**
  * Creates a seeded random generator with the latest one available
  */
-export declare function createLatestSeededRandom(requiresSynchronization: RandomSychronizationCheck, seed?: Uint16Array | number): Random<PCGSeededGenerator> | Random<LegacySeededGenerator>;
+export declare function createLatestSeededRandom(requiresSynchronization: RandomSychronizationCheck, seed?: Uint16Array | number, advance?: number): Random<PCGSeededGenerator> | Random<LegacySeededGenerator>;
 interface SeededGeneratorMap {
     [SeedType.PCG]: PCGSeededGenerator;
     [SeedType.Legacy]: LegacySeededGenerator;
@@ -29,7 +29,7 @@ interface SeededGeneratorMap {
 /**
  * Creates seeded random generator for the given type
  */
-export declare function createSeededRandom<TYPE extends SeedType = SeedType>(seedType: TYPE, requiresSynchronization: RandomSychronizationCheck, seed?: Uint16Array | number): Random<SeededGeneratorMap[TYPE]>;
+export declare function createSeededRandom<TYPE extends SeedType = SeedType>(seedType: TYPE, requiresSynchronization: RandomSychronizationCheck, seed?: Uint16Array | number, advance?: number): Random<SeededGeneratorMap[TYPE]>;
 /**
  * Random without seeds
  */

package/package.json

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