@wayward/types 2.12.0-beta.dev.20220927.1 → 2.12.0-beta.dev.20220929.2

package/definitions/game/game/Game.d.ts

@@ -138,7 +138,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
      * Marks that the human had a turn
      * In manual turn mode, it will tick the humans stat timers & the game
      */
-    passTurn(human: Human, turnType?: TurnTypeFlag): void;
+    passTurn(human: Human, turnType?: TurnTypeFlag, dueToAction?: boolean): void;
     tickRealtime(): void;
     updateTablesAndWeight(): void;
     /**
@@ -157,11 +157,11 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     /**
      * Collection of things to perform on each tick
      */
-    tick(ticks?: number, playingHumans?: Human[], tickFlag?: TickFlag): void;
+    tick(ticks?: number, playingHumans?: Human[], tickFlag?: TickFlag, dueToAction?: boolean): void;
     /**
      * Collection of things to perform on each tick
      */
-    tickAsync(island: Island, ticks: number, playingHumans: Human[] | undefined, tickFlag: TickFlag | undefined, onProgress: (progess: number) => Promise<void>): Promise<void>;
+    tickAsync(island: Island, ticks: number, playingHumans: Human[] | undefined, tickFlag: TickFlag | undefined, onProgress: (progess: number) => Promise<void>, dueToAction?: boolean): Promise<void>;
     createRenderer(entity: Entity): void;
     /**
      * Resets the game state. This should be called when returning to the main menu from a game and/or right before starting/joining a game.

package/definitions/game/game/IGame.d.ts

@@ -68,8 +68,8 @@ export interface IGameEvents {
     getBiomeType(positon: IVector2, biomeType: BiomeTypes): BiomeTypes | undefined;
     pause(): any;
     resume(): any;
-    tickStart(tickFlag: TickFlag, ticks: number): any;
-    tickEnd(tickFlag: TickFlag, ticks: number): any;
+    tickStart(tickFlag: TickFlag, ticks: number, dueToAction: boolean): any;
+    tickEnd(tickFlag: TickFlag, ticks: number, dueToAction: boolean): any;
     /**
      * Called when the playing entity count changes
      */

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

@@ -44,7 +44,7 @@ export declare const actionDescriptionsSlow: {
     63: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.EquipType], import("../Human").default, boolean, import("game/entity/action/IAction").IActionUsable, [import("../../item/Item").default, import("../IHuman").EquipType]>;
     38: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemInventory], import("../Human").default, void, import("game/entity/action/IAction").IActionUsable, [import("../../item/Item").default]>;
     110: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemInventory, [import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/Exude").IExudeCanUse, [import("../../item/Item").default, (import("../../item/Item").default | undefined)?]>;
-    36: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemInventory], import("../Human").default, void, import("game/entity/action/IAction").IActionUsable, [import("../../item/Item").default]>;
+    36: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemInventory], import("../Human").default, void, import("game/entity/action/actions/Attack").IAttackCloseUpCanUse | import("game/entity/action/actions/Attack").IAttackThrowItemCanUse | import("game/entity/action/actions/Attack").IAttackRangedWeaponCanUse, [import("../../item/Item").default]>;
     22: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/Gather").IGatherCanUse, [(import("../../item/Item").default | undefined)?]>;
     15: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../Human").default, void, import("game/entity/action/actions/GatherLiquid").IGatherLiquidCanUse, [import("../../item/Item").default]>;
     86: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemNearbyIncludingTradeContainer, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.Container, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.ItemType, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.Quality, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.String, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/MoveItem").MoveItemCanUse, [(import("../../item/Item").default | undefined)?, (import("../../item/IItem").IContainer | undefined)?, (import("../../item/IItem").ItemType | undefined)?, (import("../../IObject").Quality | undefined)?, (string | undefined)?]>;

package/definitions/game/game/entity/action/actions/Fire.d.ts

@@ -13,5 +13,5 @@ import { ActionArgument } from "game/entity/action/IAction";
 /**
  * Firing a weapon (like a bow)
  */
-declare const _default: Action<[ActionArgument.ItemInventory], import("../../Human").default, void, import("game/entity/action/IAction").IActionUsable, [import("../../../item/Item").default]>;
+declare const _default: Action<[ActionArgument.ItemInventory], import("../../Human").default, void, import("game/entity/action/actions/Attack").IAttackCloseUpCanUse | import("game/entity/action/actions/Attack").IAttackThrowItemCanUse | import("game/entity/action/actions/Attack").IAttackRangedWeaponCanUse, [import("../../../item/Item").default]>;
 export default _default;

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

@@ -23,6 +23,7 @@ import type Inspection from "game/inspection/Inspection";
 import type { Quality } from "game/IObject";
 import type { ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
+import type ItemFinder from "game/item/ItemFinder";
 import type Message from "language/dictionary/Message";
 import Translation from "language/Translation";
 import type Bindable from "ui/input/Bindable";
@@ -36,8 +37,9 @@ export interface IUsableActionRequirement<TYPE> {
     find?(player: Player): TYPE | undefined;
     getMissingName?(): Translation;
 }
-export interface IUsableActionItemRequirement extends IUsableActionRequirement<Item> {
+export interface IUsableActionItemRequirement extends Omit<IUsableActionRequirement<Item>, "find"> {
     allowOnlyItemType?(player: Player, type: ItemType): boolean;
+    finder?(player: Player): ItemFinder | undefined;
 }
 export declare namespace IUsableActionRequirement {
     interface Maybe<TYPE> {
@@ -66,7 +68,7 @@ export interface IUsableActionUsing<REQUIREMENTS extends IUsableActionRequiremen
     } ? undefined : never) | (REQUIREMENTS["item"] extends {
         validate(player: Player, value: Item): boolean;
     } ? Item : never) | (REQUIREMENTS["item"] extends {
-        find(player: Player): Item;
+        finder: ItemFinder;
     } ? Item : never) | (REQUIREMENTS["item"] extends {
         allowOnlyItemType(player: Player, type: ItemType): boolean;
     } ? undefined : never));
@@ -75,7 +77,7 @@ export interface IUsableActionUsing<REQUIREMENTS extends IUsableActionRequiremen
     } ? undefined : never) | (REQUIREMENTS["item"] extends {
         validate(player: Player, value: Item): boolean;
     } ? ItemType | undefined : never) | (REQUIREMENTS["item"] extends {
-        find(player: Player): Item;
+        finder: ItemFinder;
     } ? ItemType : never) | (REQUIREMENTS["item"] extends {
         allowOnlyItemType(player: Player, type: ItemType): boolean;
     } ? ItemType : never));

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

@@ -12,7 +12,6 @@ import type { ActionId, IUsableActionDefinition, IUsableActionDefinitionExecutab
 import { IUsableActionNotUsable } from "game/entity/action/usable/IUsableAction";
 import type Player from "game/entity/player/Player";
 import type { IIcon } from "game/inspection/InfoProvider";
-import type { IGetBestItemsOptions } from "game/item/IItemManager";
 import type Item from "game/item/Item";
 import { ActionTranslation } from "language/dictionary/Misc";
 import type Translation from "language/Translation";
@@ -47,6 +46,10 @@ declare class UsableAction<REQUIREMENTS extends IUsableActionRequirements = IUsa
     private readonly findItemCannotUse;
     getFindItemCannotUse(): IUsableActionNotUsable[];
     getItem(player: Player, provided?: IUsableActionPossibleUsing, fullUsabilityCheck?: boolean): Item | false | undefined;
+    private requirementsItemFinders?;
+    private getItemFinder;
+    private itemFinderFullCheck?;
+    private itemFinderSimpleCheck?;
     private getItemByType;
     getDoodad(player: Player, provided?: IUsableActionPossibleUsing): false | import("../../../doodad/Doodad").default | undefined;
     getCreature(player: Player, provided?: IUsableActionPossibleUsing): false | import("../../creature/Creature").default | undefined;
@@ -63,6 +66,5 @@ export interface IUsableActionFactory<REQUIREMENTS extends IUsableActionRequirem
 declare namespace UsableAction {
     function requiring<REQUIREMENTS1 extends IUsableActionRequirements>(requirements: REQUIREMENTS1): IUsableActionFactory<REQUIREMENTS1>;
     function create<DEFINITION extends IUsableActionDefinition<{}>>(action: DEFINITION): UsableAction<{}, DEFINITION>;
-    function getBestSafeItemInInventory(player: Player, options?: Partial<IGetBestItemsOptions>): Item | undefined;
 }
 export default UsableAction;

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

@@ -0,0 +1,16 @@
+/*!
+ * 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 type Player from "game/entity/player/Player";
+import type { IItemFinderOptions } from "game/item/ItemFinder";
+import ItemFinder from "game/item/ItemFinder";
+export default class UsableActionItemFinder extends ItemFinder {
+    constructor(player: Player, options?: IItemFinderOptions);
+}

package/definitions/game/game/entity/action/usable/actions/item/UsableActionsUseItem.d.ts

@@ -11,7 +11,7 @@
 import { ActionType } from "game/entity/action/IAction";
 import type { IUsableActionDynamicDefinition } from "game/entity/action/usable/actions/UsableActionsDynamic";
 import UsableActionsDynamic from "game/entity/action/usable/actions/UsableActionsDynamic";
-import type { IUsableActionRequirement, IUsableActionRequirements } from "game/entity/action/usable/IUsableAction";
+import type { IUsableActionItemRequirement, IUsableActionRequirements } from "game/entity/action/usable/IUsableAction";
 import type { IGetBestItemsOptions } from "game/item/IItemManager";
 import type Item from "game/item/Item";
 export interface IUseItemAction extends IUsableActionDynamicDefinition {
@@ -24,7 +24,7 @@ export interface IUseItemAction extends IUsableActionDynamicDefinition {
 }
 export declare namespace IUseItemAction {
     function getGetItemOptions(actionType: ActionType, useItemAction?: Omit<IUseItemAction, keyof IUsableActionDynamicDefinition>): Partial<IGetBestItemsOptions>;
-    function getItemRequirement(actionType: ActionType, useItemAction?: Omit<IUseItemAction, keyof IUsableActionDynamicDefinition>, getItemOptions?: Partial<IGetBestItemsOptions>): IUsableActionRequirement<Item>;
+    function getItemRequirement(actionType: ActionType, useItemAction?: Omit<IUseItemAction, keyof IUsableActionDynamicDefinition>, getItemOptions?: Partial<IGetBestItemsOptions>): IUsableActionItemRequirement;
 }
 declare const _default: UsableActionsDynamic<IUseItemAction, IUsableActionRequirements>;
 export default _default;

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

@@ -48,7 +48,7 @@ export interface IGetItemsOptions extends IGetItemOptions {
 }
 export interface IGetBestItemsOptions extends IGetItemsOptions {
     action: ActionType;
-    actionWith: Item;
+    actionWith: Item | (() => Item | undefined);
     filterType: ItemType;
     filterQuality: Quality;
     filterGroup: ItemTypeGroup;

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

@@ -13,6 +13,10 @@ import type { IContainer } from "game/item/IItem";
 import type { IGetBestItemsOptions } from "game/item/IItemManager";
 import type Item from "game/item/Item";
 import type ItemManager from "game/item/ItemManager";
+export interface IItemFinderOptions extends Partial<IGetBestItemsOptions> {
+    replace?(): Item[] | undefined;
+    fallback?: ItemFinder;
+}
 export default class ItemFinder {
     private readonly options;
     private readonly human;
@@ -20,10 +24,11 @@ export default class ItemFinder {
     private trackedContainers?;
     private trackedItems?;
     private foundItemIds?;
-    constructor(human: Human, container: IContainer, options?: Partial<IGetBestItemsOptions>);
-    get(): Item[];
-    track(): void;
-    dispose(): void;
+    constructor(human: Human, container: IContainer, options?: IItemFinderOptions);
+    best(): Item | undefined;
+    all(): Item[];
+    track(): this;
+    dispose(): this;
     markDirty(): void;
     private compute;
     protected onItemStateChange(item: Item): void;

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

@@ -330,7 +330,7 @@ export default class Component<E extends HTMLElement = HTMLElement> extends Even
     protected onContextMenu(api: IBindHandlerApi): boolean;
     protected onEnter(reason: "mouse" | "focus"): void;
     private menuCancelHideTooltip;
-    protected onLeave(reason: "mouse" | "focus"): void;
+    protected onLeave(reason: "mouse" | "focus" | "remove"): void;
     /**
      * @returns a promise that resolves when either the given time has passed, or this component has been removed.
      * Returns `true` if this component exists, `false` if it has been removed.

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

@@ -30,7 +30,7 @@ export interface IComponentEvents {
     willRemove(): boolean | void;
     regenerateBox(box: IBox): any;
     enter(reason: "mouse" | "focus"): any;
-    leave(reason: "mouse" | "focus"): any;
+    leave(reason: "mouse" | "focus" | "remove"): any;
     focus(): any;
     blur(): any;
     removeContextMenu(): any;

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

@@ -121,8 +121,11 @@ export default class InGameScreen extends BaseScreen {
     clampDialogs(): void;
     getItemClass(item?: Item, itemType?: ItemType): string;
     createItemString(itemType: ItemType, item?: Item, extraClass?: string): string;
+    private readonly itemElementsCollections;
     getItemElements(item: Item | number): HTMLCollectionOf<HTMLElement>;
     syncItemElements(itemIds: number | number[], forceSyncDecay?: boolean): void;
+    private readonly SYMBOL_LAST_NEARLY_DESTROYED;
+    private readonly SYMBOL_LAST_NEARLY_DECAYED;
     private readonly SYMBOL_LAST_DECAY;
     syncDecayBar(item: Item, force?: boolean, elements?: HTMLCollectionOf<HTMLElement>): void;
     addItemToContainer(item: Item, container: IContainer, _internal?: boolean, isAddingMultipleItems?: boolean, updateTables?: boolean): void;

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

@@ -123,4 +123,6 @@ export default class ItemComponent extends Component {
     private refreshDecayBar;
     private lastDurability;
     private refreshDurabilityBar;
+    private lastActionIcon?;
+    private refreshActionIcon;
 }

package/definitions/game/ui/screen/screens/game/static/ActionBar.d.ts

@@ -12,6 +12,8 @@ import type { Events, IEventEmitter } from "event/EventEmitter";
 import type { IActionApi } from "game/entity/action/IAction";
 import type { IUsableActionPossibleUsing, IUsableActionRequirements, ReturnableUsableActionUsability } from "game/entity/action/usable/IUsableAction";
 import type Player from "game/entity/player/Player";
+import type { Game } from "game/Game";
+import type { TickFlag } from "game/IGame";
 import type Item from "game/item/Item";
 import Button from "ui/component/Button";
 import Component from "ui/component/Component";
@@ -111,6 +113,7 @@ export declare class ActionSlot extends Button implements IRefreshable {
     configure(emitToActionBar?: boolean): void;
     protected onAppend(): void;
     protected onItemMaybeInaccessible(): void;
+    protected onTickEnd(game: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean): void;
     postExecuteAction(action: IActionApi): void;
     protected playSound(): void;
     private lastClickUseWhenMoving;
@@ -121,7 +124,7 @@ export declare class ActionSlot extends Button implements IRefreshable {
     onActivate(nonClick?: IBindHandlerApi | true, silent?: true): boolean;
     protected onGetOrRemoveItemInInventory(player: Player, item: Item): void;
     onToggle(api: IBindHandlerApi): boolean;
-    protected onLeave(reason: "mouse" | "focus"): void;
+    protected onLeave(reason: "mouse" | "focus" | "remove"): void;
     private getTooltipLocation;
     getAction(): import("../../../../../game/entity/action/usable/UsableAction").default<IUsableActionRequirements, import("game/entity/action/usable/IUsableAction").IUsableActionDefinition<IUsableActionRequirements>> | undefined;
     getUsing(): IUsableActionPossibleUsing;

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

@@ -35,6 +35,7 @@ export default class ImagePath<PATHTYPE extends PathType = PathType> {
     private readonly applications;
     private args?;
     private constructor();
+    static equals(imagePath?: ImagePath | ISerializedImagePath | string, imagePath2?: ImagePath | ISerializedImagePath | string): boolean;
     serialize(): ISerializedImagePath;
     setExtension(extension?: string): this;
     setArgs(args?: ResourceOptionsMap[PATHTYPE]): this;

package/package.json

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