@wayward/types 2.12.1-beta.dev.20221017.1 → 2.12.1-beta.dev.20221019.1

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

@@ -104,7 +104,7 @@ export default class Component<E extends HTMLElement = HTMLElement> extends Even
     /**
      * Forcibly regenerates the cached result of {@link Component.getBox} for this component and all descendants.
      */
-    regenerateBoxes(): void;
+    regenerateBoxes(descendants?: boolean): void;
     /**
      * Returns an object containing {@link HTMLElement.offsetTop} and {@link HTMLElement.offsetLeft}
      */

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

@@ -9,12 +9,14 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Dictionary from "language/Dictionary";
-import Component from "ui/component/Component";
+import type Component from "ui/component/Component";
 import type { IDropdownOption } from "ui/component/Dropdown";
 import EnumDropdown from "ui/component/dropdown/EnumDropdown";
-import Tooltip from "ui/tooltip/Tooltip";
+import type Tooltip from "ui/tooltip/Tooltip";
+import type TooltipLocationHandler from "ui/tooltip/TooltipLocationHandler";
 export default abstract class GroupDropdown<ENUM_OBJECT, OTHER_OPTIONS extends string, GROUP extends number, VALUES = ENUM_OBJECT[keyof ENUM_OBJECT]> extends EnumDropdown<ENUM_OBJECT, OTHER_OPTIONS, VALUES> {
     private groups;
+    private tooltipSurface?;
     private tooltip?;
     private lastGroupText?;
     private readonly wordToGroups;
@@ -35,15 +37,10 @@ export default abstract class GroupDropdown<ENUM_OBJECT, OTHER_OPTIONS extends s
     protected onClose(): void;
     protected onRemove(): void;
     protected onFilterChange(): void;
-    protected updateTooltip(): GroupDropdownTooltip;
+    protected updateTooltip(): Tooltip | undefined;
     protected onRegenerateBox(): void;
     private getTooltip;
+    protected getTooltipLocation(handler: TooltipLocationHandler): void;
     private getGroupMap;
     private addGroup;
 }
-declare class GroupDropdownTooltip extends Tooltip {
-    constructor(source: Component | HTMLElement);
-    updatePosition(force?: boolean): this;
-    protected onShow(): void;
-}
-export {};

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

@@ -86,6 +86,9 @@ export declare type TranslationData = IBaseTranslationData | (Partial<IBaseTrans
     entry: UiTranslation;
 });
 export declare type TextOrTranslationData = string | UiTranslation | TranslationData;
+/**
+ * @deprecated
+ */
 export declare enum TooltipLocation {
     AboveLeft = 0,
     AboveMiddle = 1,

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

@@ -87,5 +87,6 @@ export declare class BasicText extends Component {
     protected inputModifier?: Modifier;
     constructor(elementType?: string);
     setText(text: IStringSection & Partial<IColorSection> & Partial<ILinkSection> & Partial<IHeadingSection> & Partial<ITooltipSection> & Partial<IReferenceSection> & Partial<IListItemSection> & Partial<IBindingsSection>): this;
+    private setTooltipLocation;
     private onClick;
 }

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

@@ -14,6 +14,7 @@ import type Button from "ui/component/Button";
 import type { IDropdownOption } from "ui/component/Dropdown";
 import Dropdown from "ui/component/Dropdown";
 import type Tooltip from "ui/tooltip/Tooltip";
+import type TooltipLocationHandler from "ui/tooltip/TooltipLocationHandler";
 export default class EnumDropdown<ENUM_OBJECT, OTHER_OPTIONS extends string | never = never, VALUES = ENUM_OBJECT[keyof ENUM_OBJECT]> extends Dropdown<VALUES | OTHER_OPTIONS> {
     protected readonly enumObject: ENUM_OBJECT;
     private readonly dictionary;
@@ -27,6 +28,6 @@ export default class EnumDropdown<ENUM_OBJECT, OTHER_OPTIONS extends string | ne
     protected getTranslation(id: VALUES): import("../../../language/impl/TranslationImpl").default;
     protected filterEnum?(id: VALUES): boolean;
     protected getOptions(enumObject: any): [VALUES, (option: Button) => Button][];
-    private getTooltipLocation;
+    protected getOptionTooltipLocation(handler: TooltipLocationHandler): void;
     protected optionTooltipInitializer?(tooltip: Tooltip, type: VALUES, translation: Translation): any;
 }

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

@@ -35,7 +35,7 @@ export default abstract class InspectionsTooltipHandler<INSPECTIONS_LIST extends
     protected onUpdateTooltipPosition(position: Vector2): void;
     protected getTooltipClass(): string[];
     protected initializeHints(hints: InspectionTooltipHints, ...args: TOOLTIP_ARGS): void;
-    protected updateTooltipPosition(position?: Vector2): void;
+    protected updateTooltipPosition(): void;
     private refreshTooltipExtraInfoAndPosition;
     protected onMoveToIsland(): void;
 }

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

@@ -63,7 +63,7 @@ export declare enum ItemClasses {
     NearlyDecayed = "item-component-nearly-decayed"
 }
 export declare namespace ItemClasses {
-    const IconLocation: (enumValue: ItemDetailIconLocation) => "item-component-icon-location-topleft" | "item-component-icon-location-bottomright";
+    const IconLocation: (enumValue: ItemDetailIconLocation) => "item-component-icon-location-bottomright" | "item-component-icon-location-topleft";
 }
 export interface IItemHandler {
     noDrag?: true;

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

@@ -50,7 +50,7 @@ export default abstract class QuadrantComponent extends StaticComponent {
     protected readonly scrollableHandler: void;
     get preferredQuadrant(): Quadrant;
     get quadrant(): Quadrant;
-    get quadrantName(): "TopLeft" | "TopRight" | "BottomLeft" | "BottomRight" | "None" | "Top" | "Bottom" | "Any";
+    get quadrantName(): "None" | "Top" | "Bottom" | "TopRight" | "BottomRight" | "BottomLeft" | "TopLeft" | "Any";
     readonly log: Log;
     constructor(id: QuadrantComponentId);
     protected registerDataHost(): void;

package/definitions/game/ui/tooltip/Tooltip.d.ts

@@ -16,7 +16,8 @@ import type { TranslationGenerator } from "ui/component/IComponent";
 import { TooltipLocation } from "ui/component/IComponent";
 import Text, { Paragraph } from "ui/component/Text";
 import type Bindable from "ui/input/Bindable";
-import Vector2 from "utilities/math/Vector2";
+import type { TooltipAnchorStringHorizontal, TooltipAnchorStringVertical } from "ui/tooltip/TooltipLocationHandler";
+import TooltipLocationHandler from "ui/tooltip/TooltipLocationHandler";
 export declare enum TooltipClasses {
     Main = "tooltip",
     ForceShown = "tooltip-force-shown",
@@ -28,24 +29,28 @@ export declare enum TooltipClasses {
     Secondary = "tooltip-colored-secondary"
 }
 export interface ITooltipEvents extends Events<Component> {
-    move(position: Vector2): any;
-    setLocation(location: TooltipLocation): any;
+    setLocation(): any;
+    updatePosition(): any;
 }
 export default class Tooltip extends Component {
     event: IEventEmitter<this, ITooltipEvents>;
-    get location(): TooltipLocation;
     readonly source: Component;
     readonly blocks: Component<HTMLElement>;
     readonly hints: Component<HTMLElement>;
+    readonly location: TooltipLocationHandler;
     private forceShown;
     private maxWidth;
     private hasSetPosition;
     constructor(source: Component | HTMLElement);
     protected onRemove(): void;
-    protected onHide(): void;
     setSecondary(): this;
     setForceShown(forceShown?: boolean): this;
     wasForceShown(): boolean;
+    setLocation(initializer: (locationHandler: TooltipLocationHandler) => any): this;
+    setLocation(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical): this;
+    setLocation(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical): this;
+    setLocation(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
+    setLocation(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
     setLocation(location: TooltipLocation): this;
     /**
      * Sets the max width of this tooltip.
@@ -72,9 +77,10 @@ export default class Tooltip extends Component {
     updatePosition(regenerateBox?: boolean): this;
     private initialPositionAndShownHandledExternally;
     setInitialPositionAndShownHandledExternally(): this;
+    private dumpOnShow;
+    setDumpOnShow(dumpOnShow?: boolean): this;
     protected onShow(): void;
     dump(): this;
-    private onMouseMove;
 }
 export declare class TooltipBlock extends Component {
     constructor();

package/definitions/game/ui/tooltip/TooltipLocationHandler.d.ts

@@ -0,0 +1,77 @@
+/*!
+ * Copyright 2011-2021 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 Tooltip from "ui/tooltip/Tooltip";
+import type { IVector2 } from "utilities/math/IVector";
+export declare enum TooltipAnchorType {
+    Off = 0,
+    Aligned = 1
+}
+export declare enum TooltipAnchorSideHorizontal {
+    Right = 0,
+    Left = 1
+}
+export declare enum TooltipAnchorSideVertical {
+    Top = 0,
+    Bottom = 1
+}
+export declare type TooltipAnchorTypeString = Lowercase<keyof typeof TooltipAnchorType>;
+export declare type TooltipAnchorSideStringHorizontal = Lowercase<keyof typeof TooltipAnchorSideHorizontal>;
+export declare type TooltipAnchorSideStringVertical = Lowercase<keyof typeof TooltipAnchorSideVertical>;
+export declare type TooltipAnchorStringHorizontalSimple = `${TooltipAnchorTypeString} ${TooltipAnchorSideStringHorizontal}` | "center";
+export declare type TooltipAnchorStringHorizontal = `${"sticky " | ""}${TooltipAnchorStringHorizontalSimple}`;
+export declare type TooltipAnchorStringVerticalSimple = `${TooltipAnchorTypeString} ${TooltipAnchorSideStringVertical}` | "center";
+export declare type TooltipAnchorStringVertical = `${"sticky " | ""}${TooltipAnchorStringVerticalSimple}`;
+export declare type TooltipAnchorStringSimple = TooltipAnchorStringHorizontalSimple | TooltipAnchorStringVerticalSimple;
+export declare type TooltipAnchorString = TooltipAnchorStringHorizontal | TooltipAnchorStringVertical;
+export interface ITooltipLocationPreference {
+    xAnchor: ITooltipLocationHorizontalAnchor;
+    xRefSelector: string;
+    yAnchor: ITooltipLocationVerticalAnchor;
+    yRefSelector: string;
+}
+export interface ITooltipLocationHorizontalAnchor {
+    type: TooltipAnchorTypeString | "center";
+    side: TooltipAnchorSideStringHorizontal | "center";
+    sticky: boolean;
+}
+export interface ITooltipLocationVerticalAnchor {
+    type: TooltipAnchorTypeString | "center";
+    side: TooltipAnchorSideStringVertical | "center";
+    sticky: boolean;
+}
+export declare enum TooltipLocationAlignment {
+    Left = 0,
+    Center = 1,
+    Right = 2
+}
+export interface ITooltipLocation extends IVector2 {
+    mouse: boolean;
+    padX: boolean;
+    alignment?: Lowercase<keyof typeof TooltipLocationAlignment>;
+}
+export default class TooltipLocationHandler {
+    readonly locationPreference: ITooltipLocationPreference[];
+    private readonly _tooltip;
+    get tooltip(): Tooltip | undefined;
+    constructor(tooltip: Tooltip);
+    isMouse(): boolean;
+    reset(): this;
+    add(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical): this;
+    add(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical): this;
+    add(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
+    add(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
+    private parseAnchor;
+    private location;
+    get(): ITooltipLocation;
+    update(): void;
+    private readonly refCache;
+    private resolveAnchorRef;
+}

package/definitions/game/ui/tooltip/TooltipManager.d.ts

@@ -8,14 +8,13 @@
  * 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 EventEmitter from "event/EventEmitter";
 import Component from "ui/component/Component";
 import Tooltip from "ui/tooltip/Tooltip";
-import type Vector2 from "utilities/math/Vector2";
 export default class TooltipManager {
-    readonly tooltipWrapper: Component;
-    readonly tooltipMainWrapper: Component;
-    readonly tooltipMouseWrapper: Component;
-    private current;
+    readonly surfaceWrapper: Component<HTMLElement>;
+    readonly main: TooltipSurface;
+    readonly surfaces: TooltipSurface[];
     private readonly disablers;
     constructor();
     show(host: HTMLElement, initialize?: (tooltip: Tooltip) => any): Tooltip | undefined;
@@ -32,10 +31,27 @@ export default class TooltipManager {
      * disabler has been removed.
      */
     enable(disabler: any): this;
+    createSurface(): TooltipSurface;
     protected onInterrupt(): void;
     protected onInterruptClose(): void;
     protected onScreenResize(): void;
-    protected onMove(_: any, position: Vector2): void;
+    protected onMove(): void;
     private loop;
-    private remove;
+}
+export interface ITooltipSurfaceEvents {
+    remove(): any;
+}
+export declare class TooltipSurface extends EventEmitter.Host<ITooltipSurfaceEvents> {
+    private _host?;
+    get host(): HTMLElement | undefined;
+    tooltip?: Tooltip;
+    readonly surface: Component<HTMLElement>;
+    setId(id: string): this;
+    hasTooltip(): boolean;
+    showTooltip(host: HTMLElement, initialize?: (tooltip: Tooltip) => any): Tooltip | undefined;
+    hideTooltip(host?: HTMLElement | undefined): boolean;
+    removeTooltip(): void;
+    remove(): void;
+    private currentAlignment;
+    updatePosition(): void;
 }

package/package.json

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