@wayward/types 2.13.0-beta.dev.20230512.1 → 2.13.1-beta.dev.20230513.2

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

@@ -121,6 +121,7 @@ export default class Doodad extends Entity<IDoodadDescription, DoodadType, Dooda
     get asPlayer(): undefined;
     get asTileEvent(): undefined;
     get asItem(): undefined;
+    get asContainer(): this & IContainer | undefined;
     toString(): string;
     getRegistrarId(): number;
     /**

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

@@ -97,14 +97,16 @@ export interface IHumanEvents extends Events<EntityWithStats>, ISkillEvents {
      */
     canConsumeItem(itemType: ItemType, actionType: ActionType): boolean | undefined;
     /**
-     * Called when an item is being dropped
-     * @param item The item to be dropped
-     * @param tile The tile the item will be dropped on
-     * @param dropAll True if all items of this type will be dropped
-     * @param dropAllQuality If not undefined, all items of this quality will be dropped
-     * @returns True if the item can be dropped, false if the item can not be dropped, or undefined to use the default logic
+     * @deprecated Use filterDroppable
      */
     canDropItem(item: Item, tile: Tile, dropAll: boolean, dropAllQuality: Quality | undefined): boolean | undefined;
+    /**
+     * Called in `Drop.canUse()`
+     * @param items The items that will be dropped
+     * @param tile The tile the items will be dropped on
+     * @returns an `Item[]` if filtering, `undefined` to allow all of these items to be dropped
+     */
+    filterDroppable(items: Item[], tile: Tile): Item[] | undefined;
     /**
      * Called before an npc attacks
      * @param weapon The weapon used to attack

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

@@ -41,7 +41,12 @@ export declare const actionDescriptionsSlow: {
     }, [import("../../item/Item").default]>;
     62: import("./Action").Action<[], import("../Human").default<number>, void, import("game/entity/action/actions/DrinkInFront").IDrinkInFrontCanUse, []>;
     8: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../Human").default<number>, void, import("./actions/ConsumeItem").IConsumeItemCanUse, [import("../../item/Item").default]>;
-    56: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, [import("game/entity/action/IAction").ActionArgument.Boolean, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.Boolean, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.String, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default<number>, void, import("game/entity/action/IAction").IActionUsable, [import("../../item/Item").default, (boolean | undefined)?, (boolean | undefined)?, (string | undefined)?]>;
+    56: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.Undefined, import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.ItemArrayNearby, 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("game/entity/action/IAction").ActionArgument.Integer32], [import("game/entity/action/IAction").ActionArgument.Undefined, import("game/entity/action/IAction").ActionArgument.Container]], import("../Human").default<number>, void, {
+        usable: true;
+        items: import("../../item/Item").default[];
+        into: import("../../item/IItem").IContainer | undefined;
+        tile: import("../../tile/Tile").default;
+    }, [(import("../../item/Item").default | import("../../item/IItem").ItemType | import("../../item/Item").default[] | undefined)?, (import("../../IObject").Quality | undefined)?, (string | undefined)?, (number | undefined)?, (import("../../item/IItem").IContainer | undefined)?]>;
     7: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../Human").default<number>, void, import("./actions/ConsumeItem").IConsumeItemCanUse, [import("../../item/Item").default]>;
     83: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, [import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default<number>, void, import("game/entity/action/actions/Enchant").IEnchantCanUse, [import("../../item/Item").default, (import("../../item/Item").default | undefined)?]>;
     93: 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<number>, void, import("game/entity/action/actions/Enhance").IEnhanceCanUse, [import("../../item/Item").default, (import("../../item/Item").default | undefined)?]>;

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

@@ -8,8 +8,27 @@
  * 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 { Quality } from "game/IObject";
+import type Human from "game/entity/Human";
 import { Action } from "game/entity/action/Action";
 import { ActionArgument } from "game/entity/action/IAction";
+import type { IContainer } from "game/item/IItem";
 import type Item from "game/item/Item";
-declare const _default: Action<[ActionArgument.ItemNearby, [ActionArgument.Boolean, ActionArgument.Undefined], [ActionArgument.Boolean, ActionArgument.Undefined], [ActionArgument.String, ActionArgument.Undefined]], import("../../Human").default<number>, void, import("game/entity/action/IAction").IActionUsable, [Item, (boolean | undefined)?, (boolean | undefined)?, (string | undefined)?]>;
+import type Tile from "game/tile/Tile";
+export declare enum DropAllowProtected {
+    Disallow = 0,
+    AllowSafe = 1,
+    AllowDangerous = 2
+}
+export interface IDropCanUse {
+    items: Item[];
+    tile: Tile;
+    into?: IContainer;
+}
+declare const _default: Action<[[ActionArgument.Undefined, ActionArgument.ItemNearby, ActionArgument.ItemArrayNearby, ActionArgument.ItemType], [ActionArgument.Undefined, ActionArgument.Quality], [ActionArgument.Undefined, ActionArgument.String], [ActionArgument.Undefined, ActionArgument.Integer32], [ActionArgument.Undefined, ActionArgument.Container]], Human<number>, void, {
+    usable: true;
+    items: Item[];
+    into: IContainer | undefined;
+    tile: Tile;
+}, [(Item | import("game/item/IItem").ItemType | Item[] | undefined)?, (Quality | undefined)?, (string | undefined)?, (number | undefined)?, (IContainer | undefined)?]>;
 export default _default;

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

@@ -40,6 +40,7 @@ export interface IUsableActionRequirement<TYPE> {
 export interface IUsableActionItemRequirement extends Omit<IUsableActionRequirement<Item>, "find"> {
     allowOnlyItemType?(player: Player, type: ItemType): boolean;
     finder?(player: Player): ItemFinder | undefined;
+    requiresQuality?: true;
 }
 export declare namespace IUsableActionRequirement {
     interface Maybe<TYPE> {
@@ -66,7 +67,7 @@ export interface IUsableActionPossibleUsing {
 export interface IUsableActionUsing<REQUIREMENTS extends IUsableActionRequirements> {
     item: ((REQUIREMENTS["item"] extends true ? Item : never) | (undefined extends REQUIREMENTS["item"] ? undefined : never) | (REQUIREMENTS["item"] extends {
         allowNone: true;
-    } ? undefined : never) | (REQUIREMENTS["item"] extends {
+    } ? Item | undefined : never) | (REQUIREMENTS["item"] extends {
         validate(player: Player, value: Item): boolean;
     } ? Item : never) | (REQUIREMENTS["item"] extends {
         finder: ItemFinder;
@@ -74,14 +75,23 @@ export interface IUsableActionUsing<REQUIREMENTS extends IUsableActionRequiremen
         allowOnlyItemType(player: Player, type: ItemType): boolean;
     } ? undefined : never));
     itemType: ((REQUIREMENTS["item"] extends true ? ItemType : never) | (undefined extends REQUIREMENTS["item"] ? undefined : never) | (REQUIREMENTS["item"] extends {
-        allowNone: true;
-    } ? undefined : never) | (REQUIREMENTS["item"] extends {
+        allowOnlyItemType(player: Player, type: ItemType): boolean;
+    } ? ItemType : never) | (REQUIREMENTS["item"] extends {
         validate(player: Player, value: Item): boolean;
     } ? ItemType | undefined : never) | (REQUIREMENTS["item"] extends {
         finder: ItemFinder;
     } ? ItemType : never) | (REQUIREMENTS["item"] extends {
+        allowNone: true;
+    } ? undefined : never));
+    itemQuality: ((REQUIREMENTS["item"] extends true ? Quality : never) | (undefined extends REQUIREMENTS["item"] ? undefined : never) | (REQUIREMENTS["item"] extends {
+        allowNone: true;
+    } ? undefined : never) | (REQUIREMENTS["item"] extends {
+        validate(player: Player, value: Item): boolean;
+    } ? Quality | undefined : never) | (REQUIREMENTS["item"] extends {
+        finder: ItemFinder;
+    } ? Quality : never) | (REQUIREMENTS["item"] extends {
         allowOnlyItemType(player: Player, type: ItemType): boolean;
-    } ? ItemType : never));
+    } ? Quality : never));
     doodad: ((REQUIREMENTS["doodad"] extends true ? Doodad : never) | (undefined extends REQUIREMENTS["doodad"] ? undefined : never) | (REQUIREMENTS["doodad"] extends {
         allowNone: true;
     } ? undefined : never) | (REQUIREMENTS["doodad"] extends {
@@ -123,8 +133,9 @@ export declare namespace IUsableActionNotUsable {
 }
 export type UsableActionUsability<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> = IUsableActionUsable<REQUIREMENTS> | IUsableActionNotUsable;
 export declare enum UsableActionExecutionContext {
-    ContextMenu = 0,
-    ActionBar = 1
+    Generic = 0,
+    ContextMenu = 1,
+    ActionBar = 2
 }
 export interface IUsableActionExecutionContext {
     context: UsableActionExecutionContext;
@@ -193,7 +204,7 @@ export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionR
      * @param player The player executing this action. This isn't always the local player!
      * @param using What the player is using — items, doodads, etc.
      */
-    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: UsableActionExecutionContext | IUsableActionExecutionContext): ReturnableUsableActionUsability;
     /**
      * Marks this "action" as a submenu container instead of an executable. Is a generator for the submenu.
      * @param registrar The registrar that submenu actions should be appended to.
@@ -215,22 +226,28 @@ export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionR
      * @param using What the player is using — items, doodads, etc.
      * @param context Context to do with this action execution — where it's executed from, etc.
      */
-    execute?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): any;
+    execute?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: UsableActionExecutionContext | IUsableActionExecutionContext): any;
     /**
      * Marks this usable action as only executable client-side. This disables support for "use when moving" in action slots.
      */
     clientSide?: true;
     /**
      * Marks this usable action as, when slotted in the action bar on an item, the item should be ignored and instead the type should be used.
+     * Compatible with onlySlotItemQuality
      */
     onlySlotItemType?: true;
+    /**
+     * Marks this usable action as, when slotted in the action bar on an item, the item should be ignored and instead the quality should be used.
+     * Compatible with onlySlotItemType
+     */
+    onlySlotItemQuality?: true;
     tooltip?(tooltip: Tooltip): any;
     forceDisplayWhenEmpty?: true;
 }
 export interface IUsableActionDefinitionSubmenu<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> extends IUsableActionDefinitionBase<REQUIREMENTS> {
     submenu(registrar: UsableActionRegistrar, using: IUsableActionUsing<REQUIREMENTS>): UsableActionRegistrar | void;
     execute?: undefined;
-    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): ReturnableUsableActionUsability;
     slottable?: undefined;
     forceDisplayWhenEmpty?: true;
 }
@@ -240,7 +257,7 @@ export interface IUsableActionDefinitionExecutable<REQUIREMENTS extends IUsableA
     submenu?: undefined;
     forceDisplayWhenEmpty?: undefined;
     execute(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): any;
-    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): ReturnableUsableActionUsability;
 }
 export type IUsableActionDefinition<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> = IUsableActionDefinitionSubmenu<REQUIREMENTS> | IUsableActionDefinitionExecutable<REQUIREMENTS>;
 export type ActionId = string | ActionType | UsableActionType;

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

@@ -10,7 +10,7 @@
  */
 import EventEmitter from "event/EventEmitter";
 import type { ActionId, IUsableActionDefinition, IUsableActionDefinitionExecutable, IUsableActionExecutionContext, IUsableActionPossibleUsing, IUsableActionRequirements, IUsableActionUsing, UsableActionUsability } from "game/entity/action/usable/IUsableAction";
-import { IUsableActionNotUsable, UsableActionDisplayContext } from "game/entity/action/usable/IUsableAction";
+import { IUsableActionNotUsable, UsableActionDisplayContext, UsableActionExecutionContext } from "game/entity/action/usable/IUsableAction";
 import UsableActionRegistrar from "game/entity/action/usable/UsableActionRegistrar";
 import type { ActionWhichTranslation } from "game/entity/action/usable/UsableActionTranslator";
 import type Player from "game/entity/player/Player";
@@ -43,9 +43,9 @@ declare class UsableAction<REQUIREMENTS extends IUsableActionRequirements = IUsa
     id: ActionId;
     constructor(requirements: REQUIREMENTS, definition: DEFINITION);
     isExecutable(): this is UsableAction<REQUIREMENTS, IUsableActionDefinitionExecutable<REQUIREMENTS>>;
-    execute(player: Player, provided: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): boolean;
+    execute(player: Player, provided: IUsableActionUsing<REQUIREMENTS>, context: UsableActionExecutionContext | IUsableActionExecutionContext): boolean;
     resolveUsing(player: Player, using: IUsableActionUsing<REQUIREMENTS>): false | IUsableActionUsing<REQUIREMENTS>;
-    isUsable(player: Player, provided: IUsableActionUsing<REQUIREMENTS>): UsableActionUsability<REQUIREMENTS>;
+    isUsable(player: Player, provided: IUsableActionUsing<REQUIREMENTS>, context: UsableActionExecutionContext | IUsableActionExecutionContext): UsableActionUsability<REQUIREMENTS>;
     isApplicable(player: Player, provided?: IUsableActionPossibleUsing, fullUsabilityCheck?: boolean): provided is IUsableActionUsing<REQUIREMENTS>;
     private isItemApplicable;
     private isDoodadApplicable;

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

@@ -9,15 +9,15 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { IEventEmitter } from "event/EventEmitter";
-import { CreatureType } from "game/entity/creature/ICreature";
+import { TileUpdateType } from "game/IGame";
 import Human from "game/entity/Human";
 import { EntityType } from "game/entity/IEntity";
 import { SkillType } from "game/entity/IHuman";
+import { CreatureType } from "game/entity/creature/ICreature";
 import type { IMovementIntent, IPlayerEvents } from "game/entity/player/IPlayer";
 import MessageManager from "game/entity/player/MessageManager";
 import NoteManager from "game/entity/player/note/NoteManager";
 import QuestManager from "game/entity/player/quest/QuestManager";
-import { TileUpdateType } from "game/IGame";
 import type { IslandId } from "game/island/IIsland";
 import type { IContainer } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";

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

@@ -103,6 +103,7 @@ export interface IMoveItemOptions {
     skipWeightChecks?: boolean;
     suspendNotifier?: boolean;
     moveToTileOptions?: IMoveToTileOptions;
+    dryRun?: true;
 }
 export interface IPlaceOnTileOptions {
     force?: boolean;

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

@@ -10,7 +10,7 @@
  */
 import type { BiomeType } from "game/biome/IBiome";
 import Doodad from "game/doodad/Doodad";
-import type { IActionHandlerApi } from "game/entity/action/IAction";
+import type { IActionHandlerApi, IActionNotUsable } from "game/entity/action/IAction";
 import { ActionType } from "game/entity/action/IAction";
 import Human from "game/entity/Human";
 import type NPC from "game/entity/npc/NPC";
@@ -168,6 +168,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
      * @returns Result that tells you what moved
      */
     moveItemsToContainer(human: Human | undefined, items: Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult;
+    tryMoveItemsToContainer(human: Human | undefined, items: Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult | IActionNotUsable;
     removeContainerItems(container: IContainer, removeContainedItems?: boolean): void;
     exists(item: Item): boolean;
     remove(item: Item, removeContainedItems?: boolean, extinguishTorches?: boolean): void;