@wayward/types 2.14.1-beta.dev.20241217.2 → 2.14.2-beta.dev.20241219.1

package/definitions/game/game/entity/Entity.d.ts

@@ -96,8 +96,8 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
      */
     get tile(): Tile | undefined;
     get tilesAround(): Tile[] | undefined;
-    protected setCachedTile(tile: Tile): void;
-    clearTileCache(): void;
+    protected setCachedTile(tile: Tile | undefined): void;
+    clearTileCache(): Tile | undefined;
     isNearby(entity: Entity | Tile, includeCurrentTile?: boolean): boolean;
     /**
      * Updates the world renderer & flow field state for the tile

package/definitions/game/game/entity/EntityMovable.d.ts

@@ -22,7 +22,7 @@ import { FieldOfView } from "@wayward/game/renderer/fieldOfView/FieldOfView";
 import type { CanASeeBType } from "@wayward/game/renderer/fieldOfView/IFieldOfView";
 import type { INotificationLocation } from "@wayward/game/renderer/notifier/INotifier";
 import type { Direction } from "@wayward/game/utilities/math/Direction";
-import type { IVector2 } from "@wayward/game/utilities/math/IVector";
+import type { IVector2, IVector3 } from "@wayward/game/utilities/math/IVector";
 import Vector2 from "@wayward/game/utilities/math/Vector2";
 import type { IEventEmitter } from "@wayward/utilities/event/EventEmitter";
 export interface IEntityMovableEvents extends IEntityEvents {
@@ -107,6 +107,7 @@ export default abstract class EntityMovable<DescriptionType = unknown, TypeType
     canSeeTile(type: CanASeeBType, tile: Tile, fieldOfView?: FieldOfView, customRadius?: number): boolean;
     canSeePosition(type: CanASeeBType, islandId: IslandId, x: number, y: number, z: number, fieldOfView?: FieldOfView | undefined, customRadius?: number): boolean;
     queueSoundEffectInFront(type: SfxType, delay?: number, speed?: number): void;
+    runWhileFacing<T>(lambda: () => T, position: IVector3, direction?: Direction.Cardinal): T;
     getMovementDelay(): number;
     /**
      * Move the entity to the tile

package/definitions/game/game/entity/action/IAction.d.ts

@@ -208,8 +208,11 @@ export declare enum ActionFlag {
  * Used for hiding actions that can't currently be used from context menus.
  */
 export declare enum ActionDisplayLevel {
+    /** This action is always displayed, whether usable or not. */
     Always = 0,
+    /** When the action can't be used, it is not displayed, *unless* you are right clicking on an item that has the action. */
     Direct = 1,
+    /** When the action can't be used, it is not displayed. */
     Never = 2
 }
 export interface IActionUsable {
@@ -229,6 +232,7 @@ export interface IActionNotUsable {
     mobCheckTile?: Tile;
     message?: Message | INotUsableMessage;
     sources?: ArrayOr<Source>;
+    /** Whether the action should display or not in context menus due to this error. */
     errorDisplayLevel?: ActionDisplayLevel;
     args?: never;
     arg?: never;

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

@@ -27,7 +27,6 @@ import Message from "@wayward/game/language/dictionary/Message";
 import type { HighlightSelector } from "@wayward/game/ui/util/IHighlight";
 import Observer from "@wayward/game/utilities/Observer";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
-export declare const USABLE_ACTION_USE_ON_MOVE_UNLOCK_AT = 20;
 export interface IUsableActionEvents {
     preExecute(player: Player, using: IUsableActionPossibleUsing, context: IUsableActionExecutionContext): any;
     postExecute(player: Player, using: IUsableActionPossibleUsing, context: IUsableActionExecutionContext): any;

package/definitions/game/language/dictionary/UiTranslation.d.ts

@@ -314,66 +314,66 @@ declare enum UiTranslation {
     GameActionBarConfigurationDrawerButtonUseOnMoveDescription = 299,
     GameActionBarConfigurationDrawerButtonUseOnHoveredTile = 300,
     GameActionBarConfigurationDrawerButtonUseOnHoveredTileDescription = 301,
-    GameActionBarConfigurationDrawerHintDiscoverMore = 302,
-    GameActionBarConfigurationDrawerModeUseExact = 303,
-    GameActionBarConfigurationDrawerModeUseExactNoItemSelected = 304,
-    GameActionBarConfigurationDrawerModeUseBest = 305,
-    GameActionBarConfigurationDrawerModeUseNone = 306,
-    GameActionBarConfigurationDrawerModeUseHovered = 307,
-    GameActionBarConfigurationDrawerItemDropdownAny = 308,
-    GameActionBarConfigurationDrawerItemDropdownNoTypeSelected = 309,
-    GameActionBarConfigurationDrawerButtonDone = 310,
-    GameActionBarConfigurationDrawerButtonCraftType = 311,
-    GameActionBarSlotTooltipHintUse = 312,
-    GameActionBarSlotTooltipHintConfigure = 313,
-    GameActionBarSlotTooltipHintUseOnMove = 314,
-    GameActionBarSlotTooltipHintUseSlottedItem = 315,
-    GameActionBarSlotTooltipHintClear = 316,
-    GameActionBarButtonToggleUseWhenMovingTooltip = 317,
-    GameActionBarButtonRemoveActionBarRowTooltip = 318,
-    GameActionBarButtonAddActionBarRowTooltip = 319,
-    GameActionBarButtonConfigureOptions = 320,
-    GameMessagesButtonSend = 321,
-    GameMessagesContextMenuShowAsDialog = 322,
-    GameMessagesContextMenuClear = 323,
-    GameMessagesContextMenuCopy = 324,
-    GameMessagesContextMenuExport = 325,
-    GameMessagesFilter = 326,
-    GameMessagesFiltersEdit = 327,
-    GameMessagesNewNote = 328,
-    GameMessagesTurn = 329,
-    GameMessagesDedicatedServerBackup = 330,
-    GameMessagesDedicatedServerBackupLimitReached = 331,
-    GameMessagesPlaceholderChat = 332,
-    GameMessagesButtonShowNewest = 333,
-    GameTileInspectionCannotSeeTile = 334,
-    MenuAboutTitle = 335,
-    MenuAboutDescription = 336,
-    MenuAboutGameDescription = 337,
-    MenuAboutSectionTeam = 338,
-    MenuAboutTeamMemberName = 339,
-    MenuAboutTeamMemberNickname = 340,
-    MenuAboutSectionContributors = 341,
-    MenuAboutSectionSpecialThanks = 342,
-    MenuAboutTextSpecialThanksTestorsAndDonators = 343,
-    MenuAboutSectionLibraries = 344,
-    MenuAboutSectionLibrariesDescription = 345,
-    MenuAboutLabelVersion = 346,
-    MenuAboutLabelVersionBuild = 347,
-    MenuAboutLabelVersionBuildTime = 348,
-    MenuBindings = 349,
-    MenuBindingsDescription = 350,
-    MenuBindingsTooltipBindConflicts = 351,
-    MenuBindingsManagedBindableGameActionBarUseSlot = 352,
-    MenuBindingsManagedBindableGameActionBarAssignSlot = 353,
-    MenuBindingsManagedBindableGameActionBarToggleUseOnMoveSlot = 354,
-    MenuChangelogTitle = 355,
-    MenuChangelogDescription = 356,
-    MenuChangelogHeadingUnchartedWaters = 357,
-    MenuChangelogFailedToLoadTitle = 358,
-    MenuChangelogFailedToLoadDescription = 359,
-    MenuChangelogHeadingChangeCount = 360,
-    MenuChangelogButtonCopyChangelog = 361,
+    GameActionBarConfigurationDrawerModeUseExact = 302,
+    GameActionBarConfigurationDrawerModeUseExactNoItemSelected = 303,
+    GameActionBarConfigurationDrawerModeUseBest = 304,
+    GameActionBarConfigurationDrawerModeUseNone = 305,
+    GameActionBarConfigurationDrawerModeUseHovered = 306,
+    GameActionBarConfigurationDrawerItemDropdownAny = 307,
+    GameActionBarConfigurationDrawerItemDropdownNoTypeSelected = 308,
+    GameActionBarConfigurationDrawerButtonDone = 309,
+    GameActionBarConfigurationDrawerButtonCraftType = 310,
+    GameActionBarSlotTooltipHintUse = 311,
+    GameActionBarSlotTooltipHintConfigure = 312,
+    GameActionBarSlotTooltipHintUseOnMove = 313,
+    GameActionBarSlotTooltipHintUseSlottedItem = 314,
+    GameActionBarSlotTooltipHintClear = 315,
+    GameActionBarButtonToggleUseWhenMovingTooltip = 316,
+    GameActionBarButtonRemoveActionBarRowTooltip = 317,
+    GameActionBarButtonAddActionBarRowTooltip = 318,
+    GameActionBarButtonConfigureOptions = 319,
+    GameMessagesButtonSend = 320,
+    GameMessagesContextMenuShowAsDialog = 321,
+    GameMessagesContextMenuClear = 322,
+    GameMessagesContextMenuCopy = 323,
+    GameMessagesContextMenuExport = 324,
+    GameMessagesFilter = 325,
+    GameMessagesFiltersEdit = 326,
+    GameMessagesNewNote = 327,
+    GameMessagesTurn = 328,
+    GameMessagesDedicatedServerBackup = 329,
+    GameMessagesDedicatedServerBackupLimitReached = 330,
+    GameMessagesPlaceholderChat = 331,
+    GameMessagesButtonShowNewest = 332,
+    GameTileInspectionCannotSeeTile = 333,
+    MenuAboutTitle = 334,
+    MenuAboutDescription = 335,
+    MenuAboutGameDescription = 336,
+    MenuAboutSectionTeam = 337,
+    MenuAboutTeamMemberName = 338,
+    MenuAboutTeamMemberNickname = 339,
+    MenuAboutSectionContributors = 340,
+    MenuAboutSectionSpecialThanks = 341,
+    MenuAboutTextSpecialThanksTestorsAndDonators = 342,
+    MenuAboutSectionLibraries = 343,
+    MenuAboutSectionLibrariesDescription = 344,
+    MenuAboutLabelVersion = 345,
+    MenuAboutLabelVersionBuild = 346,
+    MenuAboutLabelVersionBuildTime = 347,
+    MenuBindings = 348,
+    MenuBindingsDescription = 349,
+    MenuBindingsTooltipBindConflicts = 350,
+    MenuBindingsManagedBindableGameActionBarUseSlot = 351,
+    MenuBindingsManagedBindableGameActionBarAssignSlot = 352,
+    MenuBindingsManagedBindableGameActionBarToggleUseOnMoveSlot = 353,
+    MenuChangelogTitle = 354,
+    MenuChangelogDescription = 355,
+    MenuChangelogHeadingUnchartedWaters = 356,
+    MenuChangelogFailedToLoadTitle = 357,
+    MenuChangelogFailedToLoadDescription = 358,
+    MenuChangelogHeadingChangeCount = 359,
+    MenuChangelogButtonCopyChangelog = 360,
+    MenuChangelogButtonCopyAltChangelog = 361,
     MenuCharacterCreationButtonRandomizeName = 362,
     MenuCharacterCreationButtonExportTooltip = 363,
     MenuCharacterCreationButtonImportTooltip = 364,

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

@@ -241,7 +241,7 @@ export default class ItemComponent extends Component implements ItemSlot {
     get actionSlots(): ReadonlySet<number> | undefined;
     private _equipSlot;
     get equipSlot(): EquipType;
-    refresh(refreshType: ItemRefreshType): this;
+    refresh(refreshType: ItemRefreshType, skipPlayingCheck?: boolean): this;
     clone(): this | undefined;
     setItemMenu(initialiser?: (contextMenu: ContextMenu<ActionId>) => any): this;
     private registeredItemHighlights;

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

@@ -45,7 +45,7 @@ export declare class EquipmentSlot extends ItemComponent {
     private overriddenItem?;
     equipItem(item: Item): Promise<void>;
     clear(): void;
-    refresh(refreshType: ItemRefreshType): this;
+    refresh(refreshType: ItemRefreshType, skipPlayingCheck?: boolean): this;
     protected onEquipEvent(): void;
     protected onPickUp(api: IItemPickUpApi): void;
     protected onDropInto(api: IItemDropApi, fromSlot?: ItemSlot): boolean;

package/definitions/game/ui/screen/screens/game/static/actions/ActionBarBindableManager.d.ts

@@ -10,10 +10,6 @@
  */
 import BindableManager from "@wayward/game/ui/input/BindableManager";
 export default class ActionBarBindableManager extends BindableManager {
-    /**
-     * Default to 1 full action bar
-     */
-    static readonly DEFAULT_ACTION_BAR_SLOTS = 12;
     static readonly DEFAULT_ACTION_BAR_ROW_MODIFIER_ORDER: string;
     static readonly INSTANCE: ActionBarBindableManager;
     private requiredSlots;

package/definitions/game/ui/screen/screens/game/static/actions/ActionBarDefaultSlots.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * 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 { IActionBarSlotData } from "@wayward/game/ui/screen/screens/game/static/actions/IActionBar";
+export declare const ACTION_BAR_DEFAULT_SLOT_COUNT = 12;
+declare const ACTION_BAR_DEFAULT_SLOTS: readonly IActionBarSlotData[];
+export default ACTION_BAR_DEFAULT_SLOTS;

package/definitions/game/ui/screen/screens/game/static/actions/ActionSlotConfigurationColumn.d.ts

@@ -72,7 +72,6 @@ export default class ActionSlotConfigurationColumn extends Component {
     readonly hr0: HorizontalLine;
     readonly targetHoveredTileCheckButton: CheckButton;
     readonly autoUseCheckButton: CheckButton;
-    readonly hintDiscoverMore: Paragraph;
     readonly hr1: HorizontalLine;
     readonly clearSlotButton: Button;
     readonly hr2: HorizontalLine;

package/definitions/game/ui/screen/screens/menu/menus/main/component/IWebsite.d.ts

@@ -19,6 +19,7 @@ export declare enum Website {
     Generic = 7,
     SteamStorePage = 8,
     Unlok = 9,
-    Wayward = 10
+    Wayward = 10,
+    Bsky = 11
 }
 export declare const websiteLinks: Readonly<Record<Website, string>>;

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

@@ -18,7 +18,7 @@ export default class HighlightManager {
      *
      * Note: When not providing `until` events, the `remove` event will be subscribed to automatically.
      */
-    register<C extends Component>(component: C, selector: HighlightSelector, ...until: Array<keyof Events<C>>): void;
+    register<C extends Component>(component: C, selector: HighlightSelector | undefined, ...until: Array<keyof Events<C>>): void;
     is(component: Component, selector: HighlightSelector): boolean;
     private getHighlightSelectorId;
     private getHighlightableComponents;

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

@@ -18,7 +18,7 @@ export interface IHighlight {
     class?: string;
 }
 export declare namespace IHighlight {
-    function item(item: Item): HighlightSelector;
+    function item(item: Item): HighlightSelector | undefined;
     function optionalItem(item?: Item): HighlightSelector | undefined;
     function optionalEquipSlot(item?: Item): HighlightSelector | undefined;
     function container(container: IContainer): HighlightSelector;

package/definitions/hosts/shared/globals.d.ts

@@ -9,8 +9,8 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { IWaywardTitle } from "@wayward/hosts/shared/globalTypes";
-export declare const gameVersionStage = "beta", gameVersionMajor = 2, gameVersionMinor = 14, gameVersionPatch = 1, gameVersionName = "Runekeeper", gameVersionColor = 11015763;
-export declare const gameVersion = "beta2.14.1";
+export declare const gameVersionStage = "beta", gameVersionMajor = 2, gameVersionMinor = 14, gameVersionPatch = 2, gameVersionName = "Runekeeper", gameVersionColor = 11015763;
+export declare const gameVersion = "beta2.14.2";
 export declare const gameVersionTitleMajor = "Wayward: Runekeeper";
 export declare const gameVersionTitleMinor: string;
 export declare const gameVersionTitle: string;

package/package.json

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