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

package/definitions/game/game/entity/action/usable/UsableActionRegistrar.d.ts

@@ -26,7 +26,6 @@ export default class UsableActionRegistrar {
     add<REQUIREMENTS extends IUsableActionRequirements>(id: string | number, action: UsableAction<REQUIREMENTS>): this;
     showContextMenu(provided: IUsableActionPossibleUsing, contextMenu?: ContextMenu<ActionId>, context?: ActionDisplayLevel, initialiser?: (contextMenu: ContextMenu<ActionId>) => any): ContextMenu<string | number | symbol>;
     createContextMenu(provided: IUsableActionPossibleUsing, contextMenu?: ContextMenu<ActionId>, context?: ActionDisplayLevel, initialiser?: (contextMenu: ContextMenu<ActionId>) => any): ContextMenu;
-    private getTooltipLocation;
 }
 export interface IUsableActionGeneratorEvents {
     stopPersisting(): any;

package/definitions/game/ui/screen/screens/game/static/stats/component/Stat.d.ts

@@ -60,6 +60,7 @@ export declare abstract class StatComponent extends Component {
      */
     protected getTooltipElement(): Component;
     private getTooltip;
+    private getTooltipLocation;
 }
 export declare abstract class StatsContainer<STAT_COMPONENT extends StatComponent> extends Component {
     private readonly entity;

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

@@ -46,12 +46,39 @@ export default class Tooltip extends Component {
     setSecondary(): this;
     setForceShown(forceShown?: boolean): this;
     wasForceShown(): boolean;
+    /**
+     * Set this tooltip's location by initialising a `TooltipLocationHandler` with multiple location fallbacks.
+     */
     setLocation(initializer: (locationHandler: TooltipLocationHandler) => any): this;
+    /**
+     * Set this tooltip's location by defining an x and y anchor on the source component.
+     */
     setLocation(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical): this;
+    /**
+     * Set this tooltip's location by defining an x anchor on a selected ancestor component, and a y anchor on the source component.
+     */
     setLocation(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical): this;
+    /**
+     * Set this tooltip's location by defining an x anchor on the source component, and a y anchor on a selected ancestor component.
+     */
     setLocation(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
+    /**
+     * Set this tooltip's location by defining x and y anchors on selected ancestor components.
+     */
     setLocation(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
+    /**
+     * Set this tooltip's location to the default, determined based on where the source component is. (IE, menu or dialog)
+     */
+    setLocation(location: "default"): this;
+    /**
+     * Set this tooltip's location to follow the mouse.
+     */
+    setLocation(location: "mouse"): this;
+    /**
+     * @deprecated This overload will be removed in 2.13.0-beta. Please update to other overloads.
+     */
     setLocation(location: TooltipLocation): this;
+    private getDefaultLocation;
     /**
      * Sets the max width of this tooltip.
      * @param maxWidth The max-width of the tooltip is this value * ui scale.

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

@@ -64,9 +64,21 @@ export default class TooltipLocationHandler {
     constructor(tooltip: Tooltip);
     isMouse(): boolean;
     reset(): this;
+    /**
+     * Add a location fallback by defining an x and y anchor on the source component.
+     */
     add(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical): this;
+    /**
+     * Add a location fallback by defining an x anchor on a selected ancestor component, and a y anchor on the source component.
+     */
     add(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical): this;
+    /**
+     * Add a location fallback by defining an x anchor on the source component, and a y anchor on a selected ancestor component.
+     */
     add(xAnchor: TooltipAnchorStringHorizontal, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
+    /**
+     * Add a location fallback by defining x and y anchors on selected ancestor components.
+     */
     add(xAnchor: TooltipAnchorStringHorizontal, xRefSelector: string, yAnchor: TooltipAnchorStringVertical, yRefSelector: string): this;
     private parseAnchor;
     private location;

package/package.json

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