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

package/definitions/game/language/english/item/MagicalSubPropertyAffixes.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * 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
+ */
+import type { MagicalPropertyIdentityHash } from "@wayward/game/game/magic/IMagicalProperty";
+declare const magicalSubPropertyAffixes: PartialRecord<MagicalPropertyIdentityHash, [adjective: string, noun: string]>;
+export default magicalSubPropertyAffixes;

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

@@ -0,0 +1,23 @@
+/*!
+ * 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
+ */
+import type { RunningContext } from "@wayward/game/steamworks/ISteamworks";
+import type Version from "@wayward/game/utilities/Version";
+import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
+export interface IGameCreationInfo {
+    build: IGameCreationInfoBuild;
+    creationTime: number;
+    runningContext: RunningContext;
+    version: Version.String;
+}
+export interface IGameCreationInfoBuild {
+    id: IBuildId | undefined;
+    time: number;
+}

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

@@ -34,6 +34,7 @@ export interface IOptions {
     defaultCursor: boolean;
     developerMode: boolean;
     developerModeContextMenu: boolean;
+    developerLogMessagesForContainerDesyncs: boolean;
     dialogOpacity: number;
     directionTurnDelay: number;
     disableAcrylicTransparency: boolean;

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

@@ -13,7 +13,9 @@ import type { GameMode, IGameOptions } from "@wayward/game/game/options/IGameOpt
 import type { ISerializedTranslation } from "@wayward/game/language/ITranslation";
 import type { IMultiplayerState } from "@wayward/game/multiplayer/IMultiplayer";
 import type IClientStore from "@wayward/game/save/clientStore/IClientStore";
+import type { IGameCreationInfo } from "@wayward/game/save/data/ISaveData";
 import type EnumInfo from "@wayward/game/utilities/enum/EnumInfo";
+import type Version from "@wayward/game/utilities/Version";
 import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
 export declare const saveDataVersionUnknown = "Unknown";
 export default class SaveData {
@@ -30,7 +32,14 @@ export default class SaveData {
     saveManagerDifficulty: GameMode;
     saveManagerOptions: IGameOptions;
     saveManagerScore: number;
-    saveManagerOriginalVersion: string;
+    saveManagerOriginalVersion: Version.String;
+    /**
+     * Contains extra information about the creation of this save.
+     * This may not be accurate for older saves before this was added (beta2.14.4).
+     * The existing data must not be modified after initial save creation.
+     * TODO: Remove gameCreationTime & saveManagerOriginalVersion and use this instead?
+     */
+    gameCreationInfo: Readonly<IGameCreationInfo>;
     saveManagerDeathBy: ISerializedTranslation;
     modManagerSaveData: Record<string, any>;
     modManagerUnloadable: Record<string, {

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

@@ -57,6 +57,10 @@ declare const propertiesToSerializeObject: {
     saveManagerOriginalVersion: {
         property: string[];
     };
+    gameCreationInfo: {
+        property: string[];
+        savePropertyFlag: SavePropertyFlag;
+    };
     gameThumbnail: {
         property: string[];
         savePropertyFlag: SavePropertyFlag;

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;
+export default _default;

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

@@ -63,3 +63,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

@@ -15,7 +15,7 @@ import IActionContext from "@wayward/game/game/entity/action/IActionContext";
 import { 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 { IBuild, 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";
@@ -92,7 +92,7 @@ export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
     /** @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>;
@@ -130,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;
     /**

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";

package/definitions/game/ui/screen/screens/game/component/container/ContainerBucketItemList.d.ts

@@ -96,6 +96,7 @@ export default class ContainerBucketItemList extends Component implements ISorta
     private readonly transientItemComponents;
     addTransientItem(item: Item): ItemComponent | undefined;
     removeTransientItem(item: Item): void;
+    ensureItemComponent(item: Item): ItemComponent | undefined;
     private readonly itemComponents;
     private getItemComponent;
     private readonly itemStacks;

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

@@ -22,6 +22,7 @@ export declare enum MilestonesDialogClasses {
 }
 export default class MilestonesDialog extends UnlockablesDialog<Milestone, MilestoneSort> {
     constructor();
+    refreshNotUnlockableWarning(): void;
     getBindable(): Bindable;
     getIcon(): MenuBarButtonType;
     protected getUnlockablesName(): Translation;

package/definitions/game/ui/screen/screens/game/dialog/unlockables/UnlockablesDialog.d.ts

@@ -38,6 +38,7 @@ export default abstract class UnlockablesDialog<UNLOCKABLE extends number, SORT
     readonly sectionUnlockableInMode: Component;
     readonly sectionNotUnlockableInMode: Component;
     readonly sectionHidden: Component;
+    readonly noticeNotUnlockable: Paragraph;
     readonly noticeRowsHidden: Paragraph;
     readonly sortFilterRow: DialogSortFilter<SORT>;
     constructor(id: DialogId);

package/definitions/game/ui/screen/screens/menu/menus/options/TabDeveloper.d.ts

@@ -19,7 +19,7 @@ export default class TabDeveloper extends Tab implements IRefreshable {
     private readonly buttonReloadStylesheets;
     private readonly buttonReloadTexturesCache;
     private readonly buttonTogglePrepackedSprites;
-    private readonly buttonDisableMilestones;
+    private readonly buttonToggleContainerDesyncMessages;
     private readonly buttonToggleTraceRecording;
     private readonly buttonDisposeReflection;
     private readonly blockLogSourceFiltering;

package/definitions/game/ui/screen/screens/menu/menus/options/TabSaveData.d.ts

@@ -24,6 +24,7 @@ export default class TabSaveData extends Tab implements IRefreshable {
     private onClearOptions;
     private onClearSaves;
     private onClearCharacters;
+    private onClearUI;
     private onClearHighscores;
     private onClearMilestones;
     private onClearCraftingRecipes;

package/definitions/game/ui/util/HighlightManager.d.ts

@@ -9,16 +9,26 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import Component from "@wayward/game/ui/component/Component";
-import type { HighlightSelector, IHighlight } from "@wayward/game/ui/util/IHighlight";
+import type { HighlightSelector, HighlightSelectorResolved, IHighlight } from "@wayward/game/ui/util/IHighlight";
+import { HighlightType } from "@wayward/game/ui/util/IHighlight";
 import type { Events } from "@wayward/utilities/event/EventEmitter";
 export default class HighlightManager {
     private readonly highlightableComponents;
+    private readonly highlightableResolvers;
     /**
      * Registers this component to the given highlight selector.
      *
      * Note: When not providing `until` events, the `remove` event will be subscribed to automatically.
      */
     register<C extends Component>(component: C, selector: HighlightSelector | undefined, ...until: Array<keyof Events<C>>): void;
+    /**
+     * Registers a "resolver" function to the given highlight selector. This resolver function will be called to produce an additional list
+     * of components to highlight when the highlight is started.
+     *
+     * This resolver function will never be automatically deregistered. Use {@link deregisterResolver} to deregister it.
+     */
+    registerResolver<C extends Component>(type: HighlightType | undefined, resolver: (selector: HighlightSelectorResolved) => ArrayOr<C> | undefined): void;
+    deregisterResolver<C extends Component>(type: HighlightType | undefined, resolver: (selector: HighlightSelectorResolved) => ArrayOr<C> | undefined): void;
     is(component: Component, selector: HighlightSelector): boolean;
     private getHighlightSelectorId;
     private getHighlightableComponents;

package/definitions/game/ui/util/IHighlight.d.ts

@@ -11,6 +11,7 @@
 import type { IContainer } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 export type HighlightSelector = [HighlightType, GetterOfOr<string | number>];
+export type HighlightSelectorResolved = [HighlightType, string | number];
 export interface IHighlight {
     selectors: SupplierOr<HighlightSelector[]>;
     time?: number;

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

@@ -31,7 +31,9 @@ export declare class ApplicationDom {
     }>): Promise<void>;
     waitForVisibleElements(selector: string, timeout?: number, scrollIntoView?: boolean): Promise<WebdriverIO.Element[]>;
     waitForNotVisible(selector: string, timeout?: number): Promise<void>;
-    waitUntil(executor: () => Promise<boolean>, options: WaitUntilOptions): Promise<true | void>;
+    waitUntil(executor: () => Promise<boolean>, options: WaitUntilOptions & {
+        triggerDebugger?: true;
+    }): Promise<true | void>;
 }
 export interface WaitUntilOptions extends Omit<webdriverio.WaitUntilOptions, "timeoutMsg"> {
     timeoutMsg?: string | (() => string);

package/definitions/utilities/Log.d.ts

@@ -87,7 +87,8 @@ declare namespace Log {
         Memory = 2
     }
     function setMemoryLog(memoryLog: MemoryLog | undefined): void;
-    function disableFileLogging(source: string): void;
+    function disableFileLogger(): void;
+    function disableFileLoggingForSource(source: string): void;
     function initializeGameState(): void;
     function setCallback(cb?: (...args: any[]) => void): void;
     function addPreConsoleCallback(cb: (...args: any[]) => void): void;
@@ -95,7 +96,7 @@ declare namespace Log {
     /**
      * Setups file logging
      */
-    function setupFileLogger(fileSystem: IFileSystem, logsPath: string): void;
+    function setupFileLogger(fileSystem: IFileSystem, logsPath: string): Promise<void>;
     /**
      * Flushes pending logs to disk if the file logger is active
      */

package/package.json

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