@wayward/types 2.14.2-beta.dev.20241220.1 → 2.14.2-beta.dev.20241222.1

package/definitions/game/game/doodad/Doodad.d.ts

@@ -133,6 +133,7 @@ export default class Doodad extends EntityMovable<IDoodadDescription, DoodadType
     private _isWell?;
     private readonly _doodadGroupCache;
     constructor(entityOptions?: IEntityConstructorOptions<DoodadType>, options?: IDoodadOptions);
+    protected get typeEnum(): typeof DoodadType;
     get asCorpse(): undefined;
     get asCreature(): undefined;
     get asDoodad(): Doodad | undefined;

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

@@ -31,7 +31,7 @@ import type { EntityReferenceTypes, IReferenceable, Reference } from "@wayward/g
 import type { ITemperatureSource } from "@wayward/game/game/temperature/ITemperature";
 import type Tile from "@wayward/game/game/tile/Tile";
 import type TileEvent from "@wayward/game/game/tile/TileEvent";
-import type { ISerializedTranslation } from "@wayward/game/language/ITranslation";
+import { type ISerializedTranslation } from "@wayward/game/language/ITranslation";
 import type Translation from "@wayward/game/language/Translation";
 import type { RenderSource, UpdateRenderFlag } from "@wayward/game/renderer/IRenderer";
 import type { INotificationLocation, ItemNotifierType, MarkerIconType, StatNotificationType } from "@wayward/game/renderer/notifier/INotifier";
@@ -75,11 +75,14 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
      * Get the entities description
      */
     get description(): Readonly<DescriptionType> | undefined;
+    protected abstract get typeEnum(): PartialRecord<string | TypeType, TypeType | string>;
     /**
      * Adds a referenceId to the entity if it doesn't already have one
      */
     addReferenceId(): void;
     abstract getName(): Translation;
+    /** @deprecated Console helper */
+    protected get debug(): any;
     /**
      * Called when filling out the entities description for the first time
      */

package/definitions/game/game/entity/creature/Creature.d.ts

@@ -83,6 +83,7 @@ export default class Creature extends EntityWithStats<ICreatureDescription, Crea
      * - `creature.getName(undefined, 3)` // "acid spitter demons"
      */
     getName(article?: Article, count?: number): Translation;
+    protected get typeEnum(): typeof CreatureType;
     protected getDescription(): ICreatureDescription | undefined;
     get isHostile(): boolean;
     get canAlert(): boolean;

package/definitions/game/game/entity/creature/corpse/Corpse.d.ts

@@ -90,6 +90,7 @@ export default class Corpse extends Entity<ICorpseDescription, CreatureType, Ref
      * - `corpse.getName(undefined, 3)` // "acid spitter demons"
      */
     getName(article?: Article, count?: number): Translation;
+    protected get typeEnum(): typeof CreatureType;
     protected getDescription(): ICorpseDescription | undefined;
     creatureDescription(): ICreatureDescription | undefined;
     get isValid(): boolean;

package/definitions/game/game/entity/npc/NPC.d.ts

@@ -21,7 +21,7 @@ import { AiType, ChangeAiType } from "@wayward/game/game/entity/ai/AI";
 import type { IEntityAiEvents } from "@wayward/game/game/entity/ai/AiManager";
 import AiManager from "@wayward/game/game/entity/ai/AiManager";
 import type { INPCDescription } from "@wayward/game/game/entity/npc/INPC";
-import type { NPCType } from "@wayward/game/game/entity/npc/INPCs";
+import { NPCType } from "@wayward/game/game/entity/npc/INPCs";
 import type MerchantNPC from "@wayward/game/game/entity/npc/npcs/Merchant";
 import type ShipperNPC from "@wayward/game/game/entity/npc/npcs/Shipper";
 import { MessageManagerNoOp } from "@wayward/game/game/entity/player/MessageManager";
@@ -66,6 +66,7 @@ export default abstract class NPC extends Human<INPCDescription, NPCType, Refere
     static getRegistrarId(): number;
     static setRegistrarId(id: number): void;
     constructor(entityOptions?: IEntityConstructorOptions<NPCType>);
+    protected get typeEnum(): typeof NPCType;
     getDescription(): INPCDescription | undefined;
     getWeightCapacity(): number;
     getRegistrarId(): number;

package/definitions/game/game/entity/player/Player.d.ts

@@ -63,6 +63,7 @@ export default class Player extends Human<undefined, number, ReferenceType.Playe
     delete(): void;
     get isValid(): boolean;
     get clientStore(): IClientStore;
+    protected get typeEnum(): {};
     getDescription(): undefined;
     createNoteManager(): NoteManager;
     createMessageManager(): MessageManager;

package/definitions/game/game/item/Item.d.ts

@@ -29,7 +29,8 @@ import type Corpse from "@wayward/game/game/entity/creature/corpse/Corpse";
 import type NPC from "@wayward/game/game/entity/npc/NPC";
 import type Player from "@wayward/game/game/entity/player/Player";
 import type { IMobCheck, IslandId } from "@wayward/game/game/island/IIsland";
-import type { ContainerReference, DisplayableItemType, IConstructedInfo, IContainable, IContainer, IItemChangeIntoOptions, IItemDescription, IItemDisassembleResult, IItemDisassembly, IItemGetNameOptions, IItemUsed, IItemVehicle, IMagicalPropertyInfo, IItemMovementResult as IMoveToTileMobCheckResult, IMoveToTileOptions, ItemTag, ItemTypeExtra } from "@wayward/game/game/item/IItem";
+import type { ContainerReference, DisplayableItemType, IConstructedInfo, IContainable, IContainer, IItemChangeIntoOptions, IItemDescription, IItemDisassembleResult, IItemDisassembly, IItemGetNameOptions, IItemUsed, IItemVehicle, IMagicalPropertyInfo, IItemMovementResult as IMoveToTileMobCheckResult, IMoveToTileOptions, ItemTag } from "@wayward/game/game/item/IItem";
+import { ItemTypeExtra } from "@wayward/game/game/item/IItem";
 import { BookType, ContainerSort, ItemDamageResult, ItemType, ItemTypeGroup, ItemWeightChange, SYMBOL_CONTAINER_CACHED_REFERENCE } from "@wayward/game/game/item/IItem";
 import type { IPlaceOnTileOptions } from "@wayward/game/game/item/IItemManager";
 import ItemMapManager from "@wayward/game/game/item/ItemMapManager";
@@ -198,6 +199,9 @@ export default class Item extends EntityMovable<IItemDescription, ItemType, Refe
      * - `item.getName(undefined, 3)` // "stone axes"
      */
     getName(article?: Article, options?: Partial<IItemGetNameOptions>): TranslationImpl;
+    protected get debug(): any;
+    private getDebug;
+    protected get typeEnum(): typeof ItemType;
     protected getDescription(): IItemDescription | undefined;
     get isTransient(): boolean;
     get isValid(): boolean;

package/definitions/game/game/item/ItemManager.d.ts

@@ -69,6 +69,8 @@ export interface IItemManagerEvents extends Events<EntityManager<Item>> {
     containerUpdateOrder(container: IContainer): any;
     containerStack(container: IContainer, type: ItemType): any;
     containerUnstack(container: IContainer, type: ItemType): any;
+    /** Called at the end of inserting new items into a container, specifically when sorting the container was not necessary. */
+    containerItemAddDidNotSort(container: IContainer): any;
     /**
      * Called when an item is crafted
      * @param human The human object

package/definitions/game/game/tile/Tile.d.ts

@@ -113,6 +113,8 @@ export default class Tile implements IVector4, Partial<ITileContainer>, IFieldOf
     constructor(island: Island, x: number, y: number, z: number, id: number, rendererData: number, quality: Quality, isFake?: true);
     get point(): IVector3;
     get description(): ITerrainDescription | undefined;
+    /** @deprecated Console helper */
+    protected get debug(): any;
     toString(): string;
     getName(layerIndex?: number, article?: Article, options?: ITileGetNameOptions): Translation;
     get type(): TerrainType;

package/definitions/game/game/tile/TileEvent.d.ts

@@ -88,6 +88,7 @@ export default class TileEvent extends EntityMovable<ITileEventDescription, Tile
     get point(): IVector3;
     get tile(): Tile;
     toString(): string;
+    protected get typeEnum(): typeof TileEventType;
     protected getDescription(): ITileEventDescription | undefined;
     getName(article?: Article, count?: number): TranslationImpl;
     getProducedTemperature(): number | undefined;

package/definitions/game/ui/input/Bind.d.ts

@@ -10,7 +10,8 @@
  */
 import Bindable from "@wayward/game/ui/input/Bindable";
 import { IInput } from "@wayward/game/ui/input/IInput";
-import type { GlobalInputInfo, GlobalMouseInfo, InputInfo } from "@wayward/game/ui/input/InputManager";
+import type { GlobalInputInfo, GlobalMouseInfo } from "@wayward/game/ui/input/InputManager";
+import { InputInfo } from "@wayward/game/ui/input/InputManager";
 import type { Macro } from "@wayward/game/ui/input/Macros";
 import type { TypedPropertyDescriptorFunctionAnyNOfParams } from "@wayward/utilities/event/EventManager";
 export interface IBindHandlerApi {
@@ -156,6 +157,7 @@ declare namespace Bind {
     function deregisterHandlers(host: any): void;
     const shouldLogHoldingEvent = false;
     function emitEvent(event: BindingEventName, input: IInput, info: InputInfo, mouse: GlobalMouseInfo, globalInput: GlobalInputInfo): Set<Bindable>;
+    function handleMaybeNothingPressed(input: GlobalInputInfo, mouse: GlobalMouseInfo): void;
     namespace Modifiers {
         /**
          * Registers a handler for when the modifiers of the given `Bindable` are pressed. This event won't be fired again until the modifiers of the `Bindable` are then *released*.

package/definitions/game/ui/screen/screens/game/component/container/ContainerBucketItemList.d.ts

@@ -82,7 +82,9 @@ export default class ContainerBucketItemList extends Component implements ISorta
     get container(): IContainer | undefined;
     isStacked(type?: ItemType): boolean;
     isStacked(item?: Item): boolean;
-    getStackedItems(type?: ItemType): Item[];
+    isFirstVisiblyStacked(item?: Item, excluding?: Item): boolean;
+    getStackedItemsThatAreVisible(type?: ItemType, excluding?: Item): Item[];
+    getStackedItems(type?: ItemType, excluding?: Item): Item[];
     getStackIndex(type?: ItemType): number | undefined;
     constructor(container?: IContainer);
     private readonly activeReasons;
@@ -132,8 +134,10 @@ export default class ContainerBucketItemList extends Component implements ISorta
     protected onContainerOrderUpdate(manager: ItemManager, container: IContainer): void;
     protected onItemToggleProtected(item: Item): void;
     private getAppendStrategy;
+    private addItemAddedStacks?;
     protected onAddItem(manager: ItemManager, items: Item[], container: IContainer, index: number, options?: IMoveItemOptions): Promise<void>;
     protected onRemoveItem(manager: ItemManager, items: Item[], container?: IContainer, containerTile?: Tile): void;
+    protected onAddItemDidNotSort(manager: ItemManager, container: IContainer): void;
     protected onTransformItem(item: Item, newType: ItemType, oldType: ItemType): void;
     protected onStack(manager: ItemManager, container: IContainer, type: ItemType): void;
     protected onUnstack(manager: ItemManager, container: IContainer, type: ItemType): void;

package/definitions/game/utilities/dev/Debug.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * 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
+ */
+declare namespace Debug {
+    function typeIfRelevant(type: string, name: string): string | undefined;
+    function where(thing: unknown): string | undefined;
+}
+export default Debug;

package/definitions/utilities/console/ConsoleUtility.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * 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
+ */
+export type ConsoleCreateMagic = <HOST extends WeakKey>(value: HOST, getter?: (value?: HOST) => any) => void;
+export interface ConsoleMagic extends Record<string, any> {
+    magic: Record<string, ConsoleCreateMagic>;
+}
+/**
+ * A proxy for `window` when it's available. Assigning to this does nothing when it's not.
+ * Used to add utilities availble in the console
+ */
+declare const _default: ConsoleMagic;
+export default _default;

package/package.json

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