@wayward/types 2.14.0-beta.dev.20240901.1 → 2.14.0-beta.dev.20240902.1

package/definitions/game/game/inspection/IInfoProvider.d.ts

@@ -35,6 +35,9 @@ export declare enum InfoClass {
     Description = "info-provider-description",
     List = "info-provider-list",
     ListItem = "info-provider-list-item",
-    MultiTextParagraph = "info-provider-multi-text-paragraph"
+    MultiTextParagraph = "info-provider-multi-text-paragraph",
+    DisplayRoot = "display-root",
+    DisplayLevelExtra = "display-level-extra",
+    DisplayLevelVerbose = "display-level-verbose"
 }
 export {};

package/definitions/game/language/ITranslation.d.ts

@@ -38,7 +38,7 @@ export interface ISerializedTranslation {
     reformatters?: Reformatter[];
     reference?: Reference;
     referenceContext?: InfoProviderContext;
-    referenceForced?: true;
+    forceInclude?: true;
     tooltip?: ISerializedTranslation | IStringSection[];
     tooltipWide?: true;
     interpolator?: ISerializedInterpolator;

package/definitions/game/language/impl/TranslationImpl.d.ts

@@ -67,7 +67,7 @@ export default class TranslationImpl implements Omit<ISerializable, "deserialize
     private tooltipWide?;
     private reference?;
     private referenceContext?;
-    private referenceForced?;
+    private forceInclude?;
     private classes?;
     constructor(dictionary: Dictionary | string, entry: number | string, index?: "random" | number);
     constructor(translationId: string);
@@ -132,7 +132,7 @@ export default class TranslationImpl implements Omit<ISerializable, "deserialize
     private getCustomInterpolatorSegments;
     serializeObject(): ISerializedTranslation;
     serialize(depth?: number): ISerializedTranslation;
-    static serializeTranslationArg(arg: any, depth?: number, maxSerializationDepth?: number): ISerializedTranslation | undefined;
+    static serializeTranslationArg(arg: any, depth?: number, maxSerializationDepth?: number): TranslationArg | undefined;
     private canCache;
     private getCachedTranslation;
     /**

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

@@ -43,6 +43,7 @@ export interface IOptions {
     disableHealthVignette: boolean;
     disableMovementAnimations: boolean;
     disableOverlaySupport: boolean;
+    disableQuitConfirmation: boolean;
     disableSpritePack: boolean;
     disableUIEffects: boolean;
     disableUIOpacity: boolean;
@@ -91,7 +92,6 @@ export interface IOptions {
     windowMode: boolean;
     zoomLevel: number;
     zoomSmoothing: boolean;
-    disableQuitConfirmation: boolean;
 }
 export declare enum DropLocation {
     Facing = 0,

package/definitions/game/ui/IUi.d.ts

@@ -67,5 +67,8 @@ export declare enum UiClasses {
 }
 export declare namespace UiClasses {
     function createDynamic<CLASS extends string, ENUM>(baseClass: CLASS, enm: ENUM): (enumValue: ENUM[keyof ENUM]) => `${CLASS}-${Lowercase<keyof ENUM & string>}`;
+    /**
+     * For raw classes use `InfoClass`
+     */
     function displayLevel(displayLevel: InfoDisplayLevel): string[];
 }

package/definitions/game/ui/Ui.d.ts

@@ -97,6 +97,7 @@ export declare class Ui extends EventEmitter.Host<IUiEvents> {
      * @param save Whether or not to save the new scale into options. Defaults to true.
      */
     setDialogOpacity(opacity?: number, save?: boolean): void;
+    private stylesheetIndex;
     addStylesheet(path: string): void;
     removeStylesheet(path: string): void;
     private getStylesheet;

package/definitions/game/ui/component/Component.d.ts

@@ -97,6 +97,7 @@ export default class Component<E extends HTMLElement = HTMLElement> extends Even
      * Alias of `.element.addEventListener`, except it returns `this` instead and prevents memory leaks
      */
     addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): this;
+    addEventListener(type: string, listener: (this: HTMLElement, ev: Event) => any, options?: boolean | AddEventListenerOptions): this;
     removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any): this;
     getAs<C extends Component>(cls: AnyClass<C>): C | undefined;
     matches(selector: string): boolean;
@@ -161,6 +162,7 @@ export default class Component<E extends HTMLElement = HTMLElement> extends Even
      * @param visible The new visiblity of this element.
      */
     toggle(visible?: boolean, trustInternalState?: boolean): this;
+    setInert(inert?: boolean): this;
     /**
      * Returns this component's parent component, if it exists.
      */

package/definitions/game/ui/old/screens/InGameScreen.d.ts

@@ -22,6 +22,7 @@ import { GlobalMouseInfo } from "@wayward/game/ui/input/InputManager";
 import type { IContainerSortInfo } from "@wayward/game/ui/old/IOldUi";
 import { CraftingSort, OldUiDialogId } from "@wayward/game/ui/old/IOldUi";
 import BaseScreen from "@wayward/game/ui/old/screens/BaseScreen";
+import type ScreenManager from "@wayward/game/ui/screen/ScreenManager";
 export type DialogIndexStrings = "inventory" | "crafting-tabs";
 export type DialogIndex = DialogIndexStrings | Reference<ReferenceType.Item | ReferenceType.Doodad | ReferenceType.NPC>;
 export type DereferencedDialogIndex = DialogIndexStrings | number;
@@ -79,6 +80,7 @@ export default class InGameScreen extends BaseScreen {
     private derefenceDialogIndex;
     setupDialog(dialogId: OldUiDialogId, containerReference?: ContainerReference): JQueryUI.DialogOptions;
     blurInputs(): void;
+    protected onScreenStateChange(screens: ScreenManager): void;
     toggleDialog(dialog: JQuery): boolean;
     openDialog(dialog: JQuery): boolean;
     onOpenDialog(dialog: JQuery): void;

package/definitions/game/ui/screen/Screen.d.ts

@@ -25,6 +25,10 @@ interface IScreenEvents extends Events<Component> {
     showDialog(dialog: Dialog): any;
     showContextMenu(contextMenu: ContextMenu): any;
     hideContextMenu(contextMenu: ContextMenu): any;
+    /** Emitted when this screen is obscured by another */
+    obscure(): any;
+    /** Emitted when this screen is no longer obscured */
+    reveal(): any;
 }
 export default abstract class Screen extends Component {
     readonly type: ScreenId;
@@ -38,6 +42,7 @@ export default abstract class Screen extends Component {
     dialogs: DialogManager;
     visibleDialogs: IDialogStates;
     constructor(type: ScreenId);
+    get isObscured(): boolean;
     remove(): this;
     getBackground(): Background;
     setBackground(background: Background): this;

package/definitions/game/ui/screen/ScreenManager.d.ts

@@ -14,6 +14,11 @@ import Screen from "@wayward/game/ui/screen/Screen";
 import type { ScreenById } from "@wayward/game/ui/screen/ScreenMap";
 import Stream from "@wayward/goodstream/Stream";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
+export declare enum ScreenClasses {
+    Main = "screen",
+    _Top = "screen--top",
+    _Obscured = "screen--obscured"
+}
 export interface IScreenManagerEvents {
     init(screen: Screen): any;
     show(screen: Screen): any;
@@ -68,6 +73,7 @@ export default class ScreenManager extends EventEmitter.Host<IScreenManagerEvent
      * Returns if the given screen id is a currently visible screen (either the main screen or the overlay screen).
      */
     isVisible(screenId: ScreenId): boolean;
+    hasOverlay(): boolean;
     /**
      * Shows a screen
      * @param screenId The id of the screen to show

package/definitions/game/ui/screen/screens/GameScreen.d.ts

@@ -44,6 +44,13 @@ import InteractionManager from "@wayward/game/ui/screen/screens/game/util/moveme
 import type { Direction } from "@wayward/game/utilities/math/Direction";
 import type Stream from "@wayward/goodstream";
 import type { Events, IEventEmitter } from "@wayward/utilities/event/EventEmitter";
+export declare enum GameScreenClasses {
+    PauseIcon = "pause-icon",
+    PauseIcon_Paused = "pause-icon--paused",
+    PauseIcon_Unpausable = "pause-icon--unpausable",
+    PauseIcon_Visible = "pause-icon--visible",
+    PauseIcon_Overlay = "pause-icon--overlay"
+}
 export type IDialogStates = {
     [key in `${DialogId}` | `${DialogId},${string}`]: boolean;
 };
@@ -75,6 +82,7 @@ export default class GameScreen extends Screen {
     private readonly pausedPopupOverlay;
     private readonly nightPopupOverlay;
     private readonly buttonRespawn;
+    private readonly buttonPause;
     constructor();
     get isTwoColumn(): boolean;
     private get gameCanvasComponent();
@@ -183,6 +191,9 @@ export default class GameScreen extends Screen {
      * Returns the first unused `Quadrant`, or `Quadrant.None` if there are none.
      */
     private getUnusedQuadrant;
+    protected onObscureOrReveal(): void;
     private updatePauseIcon;
-    private get canUnpause();
+    private get canSelfUnpause();
+    private get isRelevantlyPaused();
+    private get couldBeRelevantlyPaused();
 }

package/definitions/game/ui/screen/screens/game/component/ContainerBucket.d.ts

@@ -81,6 +81,7 @@ export default class ContainerBucket extends Component {
     protected makeTopDialog(dialog: Dialog, order: number): void;
     protected onDialogMoveOrResize(dialog: Dialog): void;
     protected onContainerUpdateOrder(manager: ItemManager, container: IContainer): void;
+    protected onRooted(): void;
     protected onMouseEnter(): void;
     protected onMouseLeave(): void;
     private updateDialogActive;

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

@@ -50,8 +50,9 @@ export default class ApplicationInteractions {
     clickJoinServer(): Promise<void>;
     clickDailyChallenge(): Promise<void>;
     clickBack(timeout?: number): Promise<void>;
-    clickButton(name: string, options?: Partial<{
+    clickButton(buttonText: string, options?: Partial<{
         force: boolean;
+        selector: string;
         clickOnce: boolean;
         timeout: number;
     }>): Promise<void>;

package/definitions/utilities/prototype/Array.d.ts

@@ -67,6 +67,8 @@ declare global {
          * @returns The new array length
          */
         insertSorted(value: T, ...sorters: SortingFunction.List<T>): number;
+        indexOfOrElse(value: T): number | undefined;
+        findIndexOrElse(predicate: (value: T) => any): number | undefined;
     }
 }
 export default function (): void;

package/definitions/utilities/string/XPath.d.ts

@@ -0,0 +1,22 @@
+declare namespace XPath {
+    /**
+     * Given a custom-formatted XPath selector, produces an XPath compatible version.
+     * Custom syntax:
+     * - No need to start the selector with `.//` to select from descendants
+     * - No need to have a `*` before an element filter, as it is implied if there's no tagname
+     * - `#id` — filters an element list down to only elements with this id (must be specified before .class)
+     * - `.class` — filters an element list down to only elements with this class
+     * - `[not(#id)]` — filters an element list down to only elements without this id
+     * - `[not(.class)]` — filters an element list down to only elements without this class
+     * - `text()*="text"` — filters down an element list to only elements with text containing "text"
+     * - `text()~="text"` — filters down an element list to only elements with text containing the word(s) "text"
+     * - `text()^="text"` — filters down an element list to only elements with text starting with "text"
+     * - `text()$="text"` — filters down an element list to only elements with text ending with "text"
+     * - `@attribute*="text"` — filters down an element list to only elements with the given attribute containing "text"
+     * - `@attribute~="text"` — filters down an element list to only elements with the given attribute containing the word(s) "text"
+     * - `@attribute^="text"` — filters down an element list to only elements with the given attribute starting with "text"
+     * - `@attribute$="text"` — filters down an element list to only elements with the given attribute ending with "text"
+     */
+    function selector(selector: string): string;
+}
+export default XPath;

package/package.json

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