@wayward/types 2.14.3-beta.dev.20241223.1 → 2.14.3-beta.dev.20241224.1

package/definitions/game/event/EventBuses.d.ts

@@ -44,6 +44,7 @@ import type SaveManager from "@wayward/game/save/SaveManager";
 import type Steamworks from "@wayward/game/steamworks/Steamworks";
 import type ScreenManager from "@wayward/game/ui/screen/ScreenManager";
 import type GameScreen from "@wayward/game/ui/screen/screens/GameScreen";
+import type ItemComponentEventBus from "@wayward/game/ui/screen/screens/game/component/item/ItemComponentEventBus";
 import type ActionBar from "@wayward/game/ui/screen/screens/game/static/ActionBar";
 import type HoveredTileTracker from "@wayward/game/ui/screen/screens/game/util/HoveredTileTracker";
 import type ActionMenuHandler from "@wayward/game/ui/screen/screens/game/util/movement/ActionMenuHandler";
@@ -93,10 +94,11 @@ export declare enum EventBus {
     UiGameScreen = 38,
     UiHoveredTileTracker = 39,
     UiInteractionManager = 40,
-    UiMovementHandler = 41,
-    UiPathingHandler = 42,
-    UsableActions = 43,
-    WorldRenderer = 44
+    UiItemComponentStatic = 41,
+    UiMovementHandler = 42,
+    UiPathingHandler = 43,
+    UsableActions = 44,
+    WorldRenderer = 45
 }
 declare const eventBuses: {
     [EventBus.Actions](): ActionExecutor<any, any, any, any, any>;
@@ -140,6 +142,7 @@ declare const eventBuses: {
     [EventBus.UiGameScreen](): GameScreen;
     [EventBus.UiHoveredTileTracker](): HoveredTileTracker;
     [EventBus.UiInteractionManager](): InteractionManager;
+    [EventBus.UiItemComponentStatic](): ItemComponentEventBus;
     [EventBus.UiMovementHandler](): MovementHandler;
     [EventBus.UiPathingHandler](): PathingHandler;
     [EventBus.UsableActions](): UsableAction;
@@ -188,10 +191,11 @@ export declare const eventBusManager: EventBusManager<EventBus, {
     38(): GameScreen;
     39(): HoveredTileTracker;
     40(): InteractionManager;
-    41(): MovementHandler;
-    42(): PathingHandler;
-    43(): UsableAction;
-    44(): WorldRenderer;
+    41(): ItemComponentEventBus;
+    42(): MovementHandler;
+    43(): PathingHandler;
+    44(): UsableAction;
+    45(): WorldRenderer;
 }>;
 /**
  * For backwards compat / ease of use

package/definitions/game/event/EventManager.d.ts

@@ -57,10 +57,11 @@ export declare const eventManager: EventManager<EventBus, {
     38(): import("../ui/screen/screens/GameScreen").default;
     39(): import("../ui/screen/screens/game/util/HoveredTileTracker").default;
     40(): import("../ui/screen/screens/game/util/movement/InteractionManager").default;
-    41(): import("../ui/screen/screens/game/util/movement/MovementHandler").default;
-    42(): import("../ui/screen/screens/game/util/movement/PathingHandler").default;
-    43(): import("../game/entity/action/usable/UsableAction").default;
-    44(): import("../renderer/world/WorldRenderer").WorldRenderer;
+    41(): import("../ui/screen/screens/game/component/item/ItemComponentEventBus").default;
+    42(): import("../ui/screen/screens/game/util/movement/MovementHandler").default;
+    43(): import("../ui/screen/screens/game/util/movement/PathingHandler").default;
+    44(): import("../game/entity/action/usable/UsableAction").default;
+    45(): import("../renderer/world/WorldRenderer").WorldRenderer;
 }>;
 /**
  * EventHandler that is typed with the games event buses

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

@@ -34,6 +34,7 @@ import type TileEvent from "@wayward/game/game/tile/TileEvent";
 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 { Renderer } from "@wayward/game/renderer/Renderer";
 import type { INotificationLocation, ItemNotifierType, MarkerIconType, StatNotificationType } from "@wayward/game/renderer/notifier/INotifier";
 import type { IVector3 } from "@wayward/game/utilities/math/IVector";
 import type { IVector4 } from "@wayward/game/utilities/math/Vector4";
@@ -44,21 +45,18 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
     abstract readonly tileUpdateType: TileUpdateType;
     id: number;
     type: TypeType;
+    historicalActions?: PartialRecord<ActionType, number>;
     referenceId?: number;
     renamed?: string | ISerializedTranslation;
     x: number;
     y: number;
     z: WorldZ;
     private _data?;
+    private _persistentMarker?;
+    private _persistentMarkerHidden?;
     private _tags?;
-    historicalActions?: PartialRecord<ActionType, number>;
     islandId: IslandId;
     preventRendering?: boolean;
-    /**
-     * Notifier marker assigned to this entity
-     */
-    private persistentMarker;
-    private persistentMarkerHidden;
     private _humansWithinBound?;
     /**
      * Cached tile the entity is on.
@@ -119,7 +117,10 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
     updateView(source: RenderSource, updateFov?: boolean | UpdateRenderFlag.FieldOfView | UpdateRenderFlag.FieldOfViewSkipTransition): void;
     notifyItem(itemNotifierType: ItemNotifierType, item: Item): void;
     notifyStat(type: StatNotificationType, value: number): void;
-    initMarker(): void;
+    /**
+     * This is called clientside the first time the renderer seens the entity
+     */
+    onFirstRender(renderer: Renderer): void;
     getCurrentMarkerIconType(): MarkerIconType | undefined;
     setMarkerIconHidden(hidden: boolean): void;
     addMarkerIcon(type: MarkerIconType): void;

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

@@ -25,7 +25,8 @@ import type Item from "@wayward/game/game/item/Item";
 import type Tile from "@wayward/game/game/tile/Tile";
 import type TileEvent from "@wayward/game/game/tile/TileEvent";
 import type { Direction } from "@wayward/game/utilities/math/Direction";
-export interface IEntityEvents {
+import type { IEventSubscriberEvents } from "@wayward/utilities/event/EventEmitter";
+export interface IEntityEvents extends IEventSubscriberEvents {
     /**
      * Called when an entity is killed by another entity.
      */

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

@@ -76,7 +76,6 @@ export default abstract class NPC extends Human<INPCDescription, NPCType, Refere
     addMilestone(): void;
     protected getStatusApplicability(): StatusApplicability | undefined;
     get isValid(): boolean;
-    load(): void;
     /**
      * Creates inventory, equips items, and scales stats
      */

package/definitions/game/game/inspection/InfoProvider.d.ts

@@ -21,8 +21,9 @@ import type { ISerializedImagePath } from "@wayward/game/ui/util/ImagePath";
 import ImagePath from "@wayward/game/ui/util/ImagePath";
 import BaseObserver from "@wayward/game/utilities/Observer";
 import type { IStringSection } from "@wayward/game/utilities/string/Interpolator";
+import type { IEventSubscriberEvents } from "@wayward/utilities/event/EventEmitter";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
-export interface IInfoProviderEvents {
+export interface IInfoProviderEvents extends IEventSubscriberEvents {
     /**
      * Should be emitted when the info provider is starting to initialize its component.
      */

package/definitions/game/game/inspection/InspectionsHandler.d.ts

@@ -13,8 +13,9 @@ import type { InfoProviderContext } from "@wayward/game/game/inspection/InfoProv
 import type Inspection from "@wayward/game/game/inspection/Inspection";
 import type { ResolvedInspection } from "@wayward/game/game/inspection/InspectionTypeMap";
 import HashSet from "@wayward/utilities/collection/set/HashSet";
+import type { IEventSubscriberEvents } from "@wayward/utilities/event/EventEmitter";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
-export interface IInspectionsHandlerEvents {
+export interface IInspectionsHandlerEvents extends IEventSubscriberEvents {
     updatedInspections(type: InspectType, newInspections: HashSet<Inspection<any>>, oldInspections?: HashSet<Inspection<any>>): any;
 }
 export default abstract class InspectionsHandler extends EventEmitter.Host<IInspectionsHandlerEvents> {

package/definitions/game/mod/IMod.d.ts

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Version from "@wayward/game/utilities/Version";
+import type { IEventSubscriberEvents } from "@wayward/utilities/event/EventEmitter";
 export declare enum MultiplayerCompatibility {
     Clientside = "clientside",
     Serverside = "serverside",
@@ -35,7 +36,7 @@ export interface IModConfig {
     readonly github?: string;
     readonly saveGameData?: boolean;
 }
-export interface IModEvents {
+export interface IModEvents extends IEventSubscriberEvents {
     unload(): any;
     initialize(): any;
     uninitialize(): any;

package/definitions/game/renderer/world/WorldRenderer.d.ts

@@ -144,6 +144,10 @@ export declare class WorldRenderer extends EventEmitter.Host<IWorldRendererEvent
     private overlayBatch;
     private vehicleBatch;
     private readonly entitiesInViewport;
+    /**
+     * A set of entities seen before (rendered on screen at least once)
+     */
+    private entititiesRenderedBefore;
     private viewportSpritesDirty;
     private cachedBounds;
     private cachedBoundsTimestamp;

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

@@ -14,7 +14,7 @@ import Component from "@wayward/game/ui/component/Component";
 import type { TranslationGenerator } from "@wayward/game/ui/component/IComponent";
 import Text, { Heading } from "@wayward/game/ui/component/Text";
 import Bindable from "@wayward/game/ui/input/Bindable";
-import type { ItemComponentHandler } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import type { ItemComponentHandler } from "@wayward/game/ui/screen/screens/game/component/item/ItemComponentHandler";
 import type Tooltip from "@wayward/game/ui/tooltip/Tooltip";
 import type { IDraggableComponent, IDraggableEvents } from "@wayward/game/ui/util/Draggable";
 import Draggable from "@wayward/game/ui/util/Draggable";

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

@@ -14,7 +14,8 @@ import type { ISerializedTranslation } from "@wayward/game/language/ITranslation
 import type Translation from "@wayward/game/language/Translation";
 import type Component from "@wayward/game/ui/component/Component";
 import type { IStringSection } from "@wayward/game/utilities/string/Interpolator";
-export interface IComponentEvents {
+import type { IEventSubscriberEvents } from "@wayward/utilities/event/EventEmitter";
+export interface IComponentEvents extends IEventSubscriberEvents {
     show(): any;
     hide(): any;
     toggleVisible(visible: boolean): any;

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

@@ -8,29 +8,23 @@
  * 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 { Quality } from "@wayward/game/game/IObject";
 import { EquipType } from "@wayward/game/game/entity/IHuman";
 import type { ActionId } from "@wayward/game/game/entity/action/usable/IUsableAction";
-import type UsableAction from "@wayward/game/game/entity/action/usable/UsableAction";
-import type MerchantNPC from "@wayward/game/game/entity/npc/npcs/Merchant";
-import type { IContainer, ItemTypeExtra } from "@wayward/game/game/item/IItem";
 import { ItemType } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 import type MagicalPropertyManager from "@wayward/game/game/magic/MagicalPropertyManager";
 import Component from "@wayward/game/ui/component/Component";
 import type ContextMenu from "@wayward/game/ui/component/ContextMenu";
 import Bindable from "@wayward/game/ui/input/Bindable";
+import { ItemComponentHandler } from "@wayward/game/ui/screen/screens/game/component/item/ItemComponentHandler";
 import type ActionBar from "@wayward/game/ui/screen/screens/game/static/ActionBar";
 import type { ActionSlot } from "@wayward/game/ui/screen/screens/game/static/actions/ActionSlot";
 import type { IDraggableEvents } from "@wayward/game/ui/util/Draggable";
 import Draggable from "@wayward/game/ui/util/Draggable";
-import type Sortable from "@wayward/game/ui/util/Sortable";
 import type { ISortableDraggableEvents } from "@wayward/game/ui/util/Sortable";
 import PerfCache from "@wayward/game/utilities/PerfCache";
 import Vector2 from "@wayward/game/utilities/math/Vector2";
-import WeakishSet from "@wayward/utilities/collection/set/WeakishSet";
 import type { Events, IEventEmitter } from "@wayward/utilities/event/EventEmitter";
-import EventEmitter from "@wayward/utilities/event/EventEmitter";
 type ItemSlotExtend = Omit<Component, "event"> & {
     event: IEventEmitter<Component, IItemSlotEvents>;
 };
@@ -104,33 +98,6 @@ export declare enum ItemClasses {
 export declare namespace ItemClasses {
     const IconLocation: (enumValue: ItemDetailIconLocation) => "item-component-icon-location-topleft" | "item-component-icon-location-bottomright";
 }
-export interface IItemComponentHandlerDescription {
-    noDrag?: true;
-    equipSlot?: EquipType;
-    hasHighlight?: SupplierOr<boolean>;
-    getItem?(): Item | undefined;
-    getItemType?(): ItemType | ItemTypeExtra | undefined;
-    getItemQuality?(): ArrayOr<Quality> | undefined;
-    getAction?(): UsableAction | undefined;
-    getActionSlot?(): ActionSlot | undefined;
-    getBindables?(bindables: Bindable[]): Bindable[];
-    getSortable?(): Sortable;
-    getStackQuantity?(): number;
-    getContainer?(): IContainer | undefined;
-    getStackItems?(): readonly Item[];
-    getStackDisplayItem?(): Item | undefined;
-    getDisplayItem?(): Item | undefined;
-    getDurability?(): number;
-    getCooldown?(): number;
-    isDamaged?(): boolean;
-    isDecayed?(): boolean;
-}
-export interface ItemComponentHandler extends IItemComponentHandlerDescription {
-}
-export declare class ItemComponentHandler {
-    readonly isItemComponentHandler = true;
-    constructor(description?: IItemComponentHandlerDescription);
-}
 export declare enum ItemTradeType {
     None = "",
     ToMerchant = "To",
@@ -164,19 +131,10 @@ export interface IItemComponentStaticEvents {
 }
 export default class ItemComponent extends Component implements ItemSlot {
     readonly handler: ItemComponentHandler;
-    static readonly eventGlobal: EventEmitter<null, IItemComponentStaticEvents>;
     static create<C extends ItemComponent = ItemComponent>(handler: ItemComponentHandler, ...params: any[]): C | undefined;
     static registerSlot(slot: ItemSlot): void;
     static getHovered(): ItemComponent | undefined;
     static QUALITY_CLASS_NAMES: PerfCache<string[]>;
-    private static readonly tradingByItem;
-    private static readonly tradingToMerchant;
-    private static readonly tradingFromMerchant;
-    static getTrading(merchant: MerchantNPC, type: ItemTradeType): WeakishSet<Item> | undefined;
-    static isTrading(item: Item, merchant: MerchantNPC): boolean;
-    static toggleTrading(items: Item[], merchant: MerchantNPC, trading: ItemTradeType): ItemTradeType;
-    private static sendMerchantChatMessage;
-    static clearTrading(merchant?: MerchantNPC): void;
     event: IEventEmitter<this, IItemComponentEvents>;
     readonly magicalIcon: Component<HTMLElement> | undefined;
     readonly protectedIcon: Component<HTMLElement> | undefined;
@@ -228,6 +186,7 @@ export default class ItemComponent extends Component implements ItemSlot {
     protected onUpdateDecay(): void;
     protected onUpdateQuality(): void;
     protected onTickEnd(): void;
+    protected onRooted(): void;
     protected onRootedAndAppend(): void;
     protected onLoadedOnIsland(): void;
     protected onActionBarItemSlottedMapUpdate(): void;

package/definitions/game/ui/screen/screens/game/component/item/ItemComponentEventBus.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * 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 { ItemRefreshType } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import type ItemComponent from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import type ActionBar from "@wayward/game/ui/screen/screens/game/static/ActionBar";
+import type { ActionSlot } from "@wayward/game/ui/screen/screens/game/static/actions/ActionSlot";
+import EventEmitter from "@wayward/utilities/event/EventEmitter";
+interface IItemComponentEventBusEvents {
+    update(type: ItemRefreshType): any;
+    changeHovered(): any;
+}
+declare namespace _ {
+    class ItemComponentEventBus extends EventEmitter.Host<IItemComponentEventBusEvents> {
+        private readonly items;
+        private readonly itemsForTickEndEvents;
+        registerItem(component: ItemComponent): void;
+        registerForTickEndEvents(component: ItemComponent): void;
+        deregisterForTickEndEvents(component: ItemComponent): void;
+        protected onUpdate(type: ItemRefreshType): void;
+        protected onSlotUpdate(actionBar: ActionBar, slot: ActionSlot): void;
+        protected onTickEnd(): void;
+        protected onLoadedOnIsland(): void;
+        protected onActionBarItemSlottedMapUpdate(): void;
+    }
+}
+type ItemComponentEventBus = _.ItemComponentEventBus;
+declare function ItemComponentEventBus(): ItemComponentEventBus;
+export default ItemComponentEventBus;

package/definitions/game/ui/screen/screens/game/component/item/ItemComponentHandler.d.ts

@@ -0,0 +1,46 @@
+/*!
+ * 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 UsableAction from "@wayward/game/game/entity/action/usable/UsableAction";
+import type { EquipType } from "@wayward/game/game/entity/IHuman";
+import type { Quality } from "@wayward/game/game/IObject";
+import type { ItemTypeExtra, IContainer } from "@wayward/game/game/item/IItem";
+import { ItemType } from "@wayward/game/game/item/IItem";
+import type Item from "@wayward/game/game/item/Item";
+import type Bindable from "@wayward/game/ui/input/Bindable";
+import type { ActionSlot } from "@wayward/game/ui/screen/screens/game/static/actions/ActionSlot";
+import type Sortable from "@wayward/game/ui/util/Sortable";
+export interface IItemComponentHandlerDescription {
+    noDrag?: true;
+    equipSlot?: EquipType;
+    hasHighlight?: SupplierOr<boolean>;
+    getItem?(): Item | undefined;
+    getItemType?(): ItemType | ItemTypeExtra | undefined;
+    getItemQuality?(): ArrayOr<Quality> | undefined;
+    getAction?(): UsableAction | undefined;
+    getActionSlot?(): ActionSlot | undefined;
+    getBindables?(bindables: Bindable[]): Bindable[];
+    getSortable?(): Sortable;
+    getStackQuantity?(): number;
+    getContainer?(): IContainer | undefined;
+    getStackItems?(): readonly Item[];
+    getStackDisplayItem?(): Item | undefined;
+    getDisplayItem?(): Item | undefined;
+    getDurability?(): number;
+    getCooldown?(): number;
+    isDamaged?(): boolean;
+    isDecayed?(): boolean;
+}
+export interface ItemComponentHandler extends IItemComponentHandlerDescription {
+}
+export declare class ItemComponentHandler {
+    readonly isItemComponentHandler = true;
+    constructor(description?: IItemComponentHandlerDescription);
+}

package/definitions/game/ui/screen/screens/game/component/item/ItemComponentTradeManager.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * 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 Human from "@wayward/game/game/entity/Human";
+import type MerchantNPC from "@wayward/game/game/entity/npc/npcs/Merchant";
+import type Item from "@wayward/game/game/item/Item";
+import { ItemTradeType } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import WeakishSet from "@wayward/utilities/collection/set/WeakishSet";
+declare namespace _ {
+    class ItemComponentTradeManager {
+        private readonly tradingByItem;
+        private readonly tradingToMerchant;
+        private readonly tradingFromMerchant;
+        getTrading(merchant: MerchantNPC, type: ItemTradeType): WeakishSet<Item> | undefined;
+        getTradeType(item: Item): ItemTradeType | undefined;
+        isTrading(item: Item, merchant: MerchantNPC): boolean;
+        toggleTrading(items: Item[], merchant: MerchantNPC, trading: ItemTradeType): ItemTradeType;
+        private sendMerchantChatMessage;
+        clearTrading(merchant?: MerchantNPC): void;
+        onTrade(merchant: MerchantNPC, human: Human): void;
+    }
+}
+type ItemComponentTradeManager = _.ItemComponentTradeManager;
+declare function ItemComponentTradeManager(): ItemComponentTradeManager;
+export default ItemComponentTradeManager;

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

@@ -14,8 +14,8 @@ import Component from "@wayward/game/ui/component/Component";
 import type { IBindHandlerApi } from "@wayward/game/ui/input/Bind";
 import Bindable from "@wayward/game/ui/input/Bindable";
 import Dialog from "@wayward/game/ui/screen/screens/game/component/Dialog";
-import type { IItemDropApi, IItemPickUpApi, ItemSlot } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
-import ItemComponent, { ItemRefreshType } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import { ItemRefreshType, type IItemDropApi, type IItemPickUpApi, type ItemSlot } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import ItemComponent from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
 import EquipmentSlotTooltipHandler from "@wayward/game/ui/screen/screens/game/dialog/equipment/EquipmentSlotTooltip";
 import { MenuBarButtonType } from "@wayward/game/ui/screen/screens/game/static/menubar/IMenuBarButton";
 export declare enum EquipmentClasses {

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

@@ -25,8 +25,9 @@ import Component from "@wayward/game/ui/component/Component";
 import type { IRefreshable } from "@wayward/game/ui/component/Refreshable";
 import Text from "@wayward/game/ui/component/Text";
 import type { IBindHandlerApi } from "@wayward/game/ui/input/Bind";
-import type { IItemSlotEvents, ItemSlot } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
-import ItemComponent, { ItemComponentHandler } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import { type IItemSlotEvents, type ItemSlot } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import ItemComponent from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import { ItemComponentHandler } from "@wayward/game/ui/screen/screens/game/component/item/ItemComponentHandler";
 import type ActionBar from "@wayward/game/ui/screen/screens/game/static/ActionBar";
 import { ActionSlotUpdateReason, IActionBarSlotData } from "@wayward/game/ui/screen/screens/game/static/actions/IActionBar";
 import type TooltipLocationHandler from "@wayward/game/ui/tooltip/TooltipLocationHandler";

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

@@ -22,8 +22,9 @@ import HorizontalLine from "@wayward/game/ui/component/HorizontalLine";
 import RangeChoiceList from "@wayward/game/ui/component/RangeChoiceList";
 import Text, { Heading, Paragraph } from "@wayward/game/ui/component/Text";
 import ItemDropdown from "@wayward/game/ui/component/dropdown/ItemDropdown";
-import type { IItemComponentHandlerDescription, IItemDropApi, IItemSlotEvents, ItemSlot } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import type { IItemDropApi, ItemSlot, IItemSlotEvents } from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
 import ItemComponent from "@wayward/game/ui/screen/screens/game/component/ItemComponent";
+import type { IItemComponentHandlerDescription } from "@wayward/game/ui/screen/screens/game/component/item/ItemComponentHandler";
 import type { Events, IEventEmitter } from "@wayward/utilities/event/EventEmitter";
 export declare enum ActionSlotConfigurationColumnClasses {
     Main = "game-action-configuration-drawer-configuration-column",

package/definitions/utilities/collection/map/IterableWeakMap.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * 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
+ */
+/**
+ * Strong keys are stored in a Map.
+ * Weak keys are stored in a WeakMap.
+ * Based on https://github.com/tc39/proposal-weakrefs?tab=readme-ov-file#iterable-weakmaps
+ */
+export declare class IterableWeakMap<K, V> implements Iterable<[K, V]> {
+    #private;
+    constructor(iterable?: Iterable<[K, V]>);
+    /**
+     * This is more of an estimate since we might be waiting for some garbage collection to happen
+     */
+    get size(): number;
+    /**
+     * This will cause keys that are cleaned up via garbage collection to be logged
+     */
+    enableLogging(): IterableWeakMap<K, V>;
+    get(key: K): V | undefined;
+    set(key: K, value: V): this;
+    delete(key: K): boolean;
+    [Symbol.iterator](): Generator<[K, V]>;
+    entries(): IterableIterator<[K, V]>;
+    keys(): IterableIterator<K>;
+    values(): IterableIterator<V>;
+    private isWeakKey;
+}

package/definitions/utilities/event/EventEmitter.d.ts

@@ -8,6 +8,7 @@
  * 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 { IterableWeakMap } from "@wayward/utilities/collection/map/IterableWeakMap";
 import { PriorityMap } from "@wayward/utilities/collection/map/PriorityMap";
 export declare enum Priority {
     Lowest = -2000,
@@ -24,12 +25,16 @@ type Abstract<T> = Function & {
 };
 type Constructor<T> = new (...args: any[]) => T;
 type ClassOrAbstractClass<T> = Abstract<T> | Constructor<T>;
+export interface IEventSubscriberEvents {
+    releaseEventSubscriptions(): any;
+}
 export interface IEventEmitterHost<E> {
     event: IEventEmitter<this | null, E>;
 }
 export type IEventEmitterHostClass<E> = ClassOrAbstractClass<IEventEmitterHost<E>>;
 export type Events<T> = T extends IEventEmitterHost<infer E> ? E : T extends IEventEmitterHostClass<infer E> ? E : never;
-export type EventPriorityMap = PriorityMap<Map<string | Handler<any, any>, string | Handler<any, any>>>;
+export type EventPriorityMapKV = string | Handler<any, any>;
+export type EventPriorityMap = PriorityMap<Map<EventPriorityMapKV, EventPriorityMapKV> | IterableWeakMap<EventPriorityMapKV, EventPriorityMapKV>>;
 export interface ITrueEventEmitterHostClass<E> extends Class<any> {
     [SYMBOL_SUPERCLASSES]: Array<ITrueEventEmitterHostClass<E>>;
     [SYMBOL_SUBSCRIPTIONS]: Map<any, Map<keyof E, EventPriorityMap>>;
@@ -59,8 +64,14 @@ export interface IEventEmitter<H = any, E = any> {
     emitAsyncParallel<K extends keyof E>(event: K, ...args: ArgsOf<E[K]>): Promise<Array<(Extract<ReturnOf<E[K]>, Promise<any>> extends Promise<infer R> ? R : never) | Exclude<ReturnOf<E[K]>, Promise<any>>>> & {
         isResolved?: true;
     };
+    subscribe<K extends ArrayOr<keyof E>>(host: IEventEmitterHost<IEventSubscriberEvents>, event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
+    /** @deprecated */
     subscribe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
+    subscribeUnsafe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
+    subscribeNext<K extends ArrayOr<keyof E>>(host: IEventEmitterHost<IEventSubscriberEvents>, event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    /** @deprecated */
     subscribeNext<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    subscribeNextUnsafe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
     unsubscribe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): boolean;
     waitFor<K extends ArrayOr<keyof E>>(events: K, priority?: number): Promise<ArgsOf<K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>>;
     race<K extends ArrayOr<keyof E>>(raceWith: Promise<any>, events: K, priority?: number): Promise<ArgsOf<K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>>;
@@ -72,8 +83,14 @@ export interface IEventEmitter<H = any, E = any> {
 export interface IUntilSubscriber<H, E> {
     until(promise: Promise<any>): this;
     until<E2>(emitter: IEventEmitterHost<E2>, ...events: Array<keyof E2>): this;
+    subscribe<K extends ArrayOr<keyof E>>(host: IEventEmitterHost<IEventSubscriberEvents>, event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    /** @deprecated */
     subscribe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    subscribeUnsafe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    subscribeNext<K extends ArrayOr<keyof E>>(host: IEventEmitterHost<IEventSubscriberEvents>, event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    /** @deprecated */
     subscribeNext<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    subscribeNextUnsafe<K extends ArrayOr<keyof E>>(event: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
 }
 declare class EventEmitter<H, E> {
     private readonly host;
@@ -92,8 +109,15 @@ declare class EventEmitter<H, E> {
     emitReduce<K extends keyof E, A extends ReturnOf<E[K]> & Head<ArgsOf<E[K]>>>(event: K, arg: A, ...args: Tail<ArgsOf<E[K]>>): Extract<ReturnOf<E[K]> & Head<ArgsOf<E[K]>>, undefined> extends undefined ? (undefined extends A ? ReturnOf<E[K]> : A) : ReturnOf<E[K]>;
     emitAsync<K extends keyof E>(event: K, ...args: ArgsOf<E[K]>): Promise<any[]>;
     emitAsyncParallel<K extends keyof E>(event: K, ...args: ArgsOf<E[K]>): Promise<any[]>;
-    subscribe<K extends ArrayOr<keyof E>>(events: K, handler: keyof H | Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
-    subscribeNext<K extends ArrayOr<keyof E>>(events: K, handler: keyof H | Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    subscribeUnsafe<K extends ArrayOr<keyof E>>(events: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
+    subscribe<K extends ArrayOr<keyof E>>(host: IEventEmitterHost<IEventSubscriberEvents>, events: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
+    /** @deprecated */
+    subscribe<K extends ArrayOr<keyof E>>(events: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number, once?: boolean): H;
+    private subscribeInternal;
+    subscribeNextUnsafe<K extends ArrayOr<keyof E>>(events: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    subscribeNext<K extends ArrayOr<keyof E>>(host: IEventEmitterHost<IEventSubscriberEvents>, events: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
+    /** @deprecated */
+    subscribeNext<K extends ArrayOr<keyof E>>(events: K, handler: Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): H;
     unsubscribe<K extends ArrayOr<keyof E>>(events: K, handler: keyof H | Handler<H, K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>, priority?: number): boolean;
     waitFor<K extends ArrayOr<keyof E>>(events: K, priority?: number): Promise<ArgsOf<K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>>;
     race<K extends ArrayOr<keyof E>>(raceWith: number | Promise<any>, events: K, priority?: number): Promise<ArgsOf<K extends any[] ? E[K[number]] : E[Extract<K, keyof E>]>>;

package/definitions/utilities/event/EventManager.d.ts

@@ -10,7 +10,7 @@
  */
 import type { EventBusManager } from "@wayward/utilities/event/EventBusManager";
 import type EventEmitter from "@wayward/utilities/event/EventEmitter";
-import type { Events, IEventEmitterHost, IEventEmitterHostClass } from "@wayward/utilities/event/EventEmitter";
+import type { Events, IEventEmitterHost, IEventEmitterHostClass, IEventSubscriberEvents } from "@wayward/utilities/event/EventEmitter";
 type HostOrHostClass = IEventEmitterHost<any> | IEventEmitterHostClass<any>;
 type HostFromHostOrHostClass<H> = H extends {
     event: EventEmitter<null, any>;
@@ -55,7 +55,17 @@ export declare class EventManager<EventBus extends number, EventBuses extends Re
     waitFor<E extends EmitterOrBus<EventBus>, K extends Event<EventBus, EventBuses, E>>(emitter: E, event: K, priority?: number): Promise<Parameters<Handler<EventBus, EventBuses, E, K>>>;
     until<E2>(emitter: IEventEmitterHost<E2>, ...events: Array<keyof E2>): IEventManagerUntil<EventBus, EventBuses>;
     until(promise: Promise<any>): IEventManagerUntil<EventBus, EventBuses>;
+    registerEventBusSubscriber(subscriber: IEventEmitterHost<IEventSubscriberEvents>): void;
+    /**
+     * @deprecated This subscriber object will not be automatically cleaned up!
+     *
+     * If this is intentional, switch to {@link registerEventBusSubscriberUnsafe}.
+     *
+     *  Otherwise, this subscriber object needs to be an {@link IEventEmitterHost}<{@link IEventSubscriberEvents}> —
+     * the `"releaseEventSubscriptions"` call will automatically clean up this subscriber.
+     */
     registerEventBusSubscriber(subscriber: object): void;
+    registerEventBusSubscriberUnsafe(subscriber: object): void;
     deregisterEventBusSubscriber(subscriber: object): boolean;
 }
 declare const SYMBOL_EVENT_HANDLERS: unique symbol;

package/package.json

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