@wayward/types 2.12.2-beta.dev.20221031.1 → 2.12.2-beta.dev.20221102.1

package/definitions/game/language/english/ui/TooltipVisibilityOptions.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * 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 { TooltipVisibilityOption } from "save/data/ISaveDataGlobal";
+declare const tooltipVisibilityOptions: Descriptions<TooltipVisibilityOption, string>;
+export default tooltipVisibilityOptions;

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

@@ -19,7 +19,6 @@ import type UiExperiment from "ui/UiExperiments";
 import type { ISourceFilter } from "utilities/Log";
 export interface IOptions {
     alternatingDirectionMovement: boolean;
-    alwaysShowMoreInformation: boolean;
     autoAttack: boolean;
     autoPickup: boolean;
     autoPickupOnIdle: boolean;
@@ -66,6 +65,7 @@ export interface IOptions {
     tooltips: {
         [key in InspectType]: boolean | undefined;
     };
+    tooltipVisibility?: TooltipVisibilityOption;
     uiExperiments: UiExperiment.Any[];
     uiScale?: number;
     useAdjacentContainers: boolean;
@@ -94,7 +94,13 @@ export declare enum MusicPlaylist {
     Shuffle = 1,
     Dynamic = 2
 }
+export declare enum TooltipVisibilityOption {
+    HiddenUnlessBind = 0,
+    ShowMoreInformationWithBind = 1,
+    AlwaysShowMoreInformation = 2
+}
 export declare type IOptionsOld = Partial<Pick<IOptions, "bindings">> & Partial<{
+    alwaysShowMoreInformation: boolean;
     keyBinds: Record<number, number>;
     bindings: IBindingsOld;
     directionTurnDelay: boolean;

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

@@ -15,6 +15,7 @@ import type { PlayerState } from "game/entity/player/IPlayer";
 import type { Game } from "game/Game";
 import type { Prompt } from "game/meta/prompt/IPrompt";
 import type InterruptChoice from "language/dictionary/InterruptChoice";
+import { TooltipVisibilityOption } from "save/data/ISaveDataGlobal";
 import Component from "ui/component/Component";
 import type { IBindHandlerApi } from "ui/input/Bind";
 import LoadingBridge from "ui/LoadingBridge";
@@ -34,7 +35,7 @@ export interface IUiEvents {
     interrupt(options: Partial<InterruptOptions>, interrupt?: Prompt): string | boolean | InterruptChoice | undefined | void;
     interruptClose(options: Partial<InterruptOptions>, result?: string | boolean | InterruptChoice): any;
     loadedFromSave(): any;
-    toggleShowMoreInformation(showingMoreInformation: boolean): any;
+    changeInformationVisibility(informationVisibility: TooltipVisibilityOption): any;
     toggleHealthVignette(healthVignette: boolean): any;
     toggleDeveloperMode(developerMode: boolean): any;
 }
@@ -66,8 +67,8 @@ export declare class Ui extends EventEmitter.Host<IUiEvents> {
      */
     registerDataHost(id: string | number, host: any): void;
     playSound(sound: SfxType | SfxUi): void;
-    shouldShowMoreInformation(): boolean;
-    toggleShowMoreInformation(showMoreInformation: boolean): void;
+    getTooltipVisibility(): TooltipVisibilityOption;
+    protected onChangeInformationVisibility(): void;
     /**
      * Toggle health vignette
      */

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

@@ -42,6 +42,8 @@ export declare type ContextMenuOptionKeyValuePair<O extends number | string | sy
 export declare type ContextMenuOptionDescription<O extends number | string | symbol = number | string | symbol> = ContextMenuOptionKeyValuePair<O> | typeof ContextMenu.Divider;
 export declare type ContextMenuDescriptions<O extends number | string | symbol = number | string | symbol> = Array<ContextMenuOptionDescription<O>>;
 export interface IContextMenuEvents extends Events<Component> {
+    setPosition(): any;
+    interactable(): any;
     chosen(choice: ContextMenuOption): any;
     becomeActive(): any;
 }

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

@@ -9,7 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Doodad from "game/doodad/Doodad";
-import type { EquipType } from "game/entity/IHuman";
+import { EquipType } from "game/entity/IHuman";
 import NPC from "game/entity/npc/NPC";
 import type { IContainer, IDismantleComponent } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";

package/definitions/game/ui/screen/screens/game/static/menubar/IMenuBarButton.d.ts

@@ -11,6 +11,7 @@
 import type { IHasImagePath } from "game/IObject";
 import type { IModdable } from "mod/ModRegistry";
 import type Button from "ui/component/Button";
+import type { IBindHandlerApi } from "ui/input/Bind";
 import type Bindable from "ui/input/Bindable";
 import type Tooltip from "ui/tooltip/Tooltip";
 import type { IVector2 } from "utilities/math/IVector";
@@ -72,7 +73,7 @@ export interface IMenuBarButtonDescription extends IModdable, IHasImagePath {
     /**
      * What should happen when this button is clicked.
      */
-    onActivate(): any;
+    onActivate(api?: IBindHandlerApi): any;
     onCreate?(button: Button): any;
     onDispose?(button: Button): any;
     tooltip?(tooltip: Tooltip, button: Button, addBindLabel: (tooltip: Tooltip) => void): Tooltip;

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

@@ -106,6 +106,9 @@ export default class Tooltip extends Component {
     setInitialPositionAndShownHandledExternally(): this;
     private dumpOnShow;
     setDumpOnShow(dumpOnShow?: boolean): this;
+    private showId?;
+    reshow(force?: boolean): void;
+    private reshowInternal;
     protected onShow(): void;
     dump(): this;
 }

package/package.json

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