@wayward/types 2.14.4-beta.dev.20250501.1 → 2.14.4-beta.dev.20250506.1

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

@@ -190,4 +190,5 @@ export declare const actionDescriptionsSlow: {
     138: import("./Action").Action<[import("@wayward/game/game/entity/action/IAction").ActionArgument.Tile], import("../Human").default<unknown, number, import("../../reference/IReferenceManager").ReferenceType.NPC | import("../../reference/IReferenceManager").ReferenceType.Player>, void, {
         usable: true;
     }, [import("../../tile/Tile").default]>;
+    141: import("./Action").Action<[[arg1: import("@wayward/game/game/entity/action/IAction").ActionArgument.Undefined, import("@wayward/game/game/entity/action/IAction").ActionArgument.ItemInventory]], import("../Human").default<unknown, number, import("../../reference/IReferenceManager").ReferenceType.NPC | import("../../reference/IReferenceManager").ReferenceType.Player>, void, import("@wayward/game/game/entity/action/actions/ExcavateCollapse").IExcavateCollapseTile, [(import("../../item/Item").default | undefined)?]>;
 };

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

@@ -185,7 +185,8 @@ export declare enum ActionType {
     CraftingIngredient = 137,
     ViewItems = 138,
     AscendDescend = 139,
-    DiscoverRecipe = 140
+    DiscoverRecipe = 140,
+    ExcavateCollapse = 141
 }
 export declare const ACTIONS_RECOMMENDED: ActionType[];
 export declare enum ActionUsability {

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

@@ -0,0 +1,24 @@
+/*!
+ * 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 { Action } from "@wayward/game/game/entity/action/Action";
+import type { IActionUsable } from "@wayward/game/game/entity/action/IAction";
+import { ActionArgument } from "@wayward/game/game/entity/action/IAction";
+import { UsableActionType } from "@wayward/game/game/entity/action/usable/UsableActionType";
+import { type ITerrainDescription } from "@wayward/game/game/tile/ITerrain";
+import type Tile from "@wayward/game/game/tile/Tile";
+export interface IExcavateCollapseTile extends IActionUsable {
+    type: "Tile";
+    tile: Tile;
+    terrainDescription?: ITerrainDescription;
+    actionType: UsableActionType;
+}
+declare const _default: Action<[[arg1: ActionArgument.Undefined, ActionArgument.ItemInventory]], import("../../Human").default<unknown, number, import("../../../reference/IReferenceManager").ReferenceType.NPC | import("../../../reference/IReferenceManager").ReferenceType.Player>, void, IExcavateCollapseTile, [(import("../../../item/Item").default | undefined)?]>;
+export default _default;

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

@@ -103,7 +103,9 @@ export declare enum UsableActionType {
     CommandAllAttack = 100081,
     CommandAllHeel = 100082,
     Ascend = 100083,
-    Descend = 100084
+    Descend = 100084,
+    Excavate = 100085,
+    Collapse = 100086
 }
 export declare enum UsableActionTypePlaceholder {
     TradeItem = 200000,

package/definitions/game/game/entity/action/usable/actions/UsableActionsWorld.d.ts

@@ -17,7 +17,7 @@ export declare enum WorldContextMenuClasses {
     OptionText = "world-context-menu-option-text"
 }
 export declare namespace WorldContextMenuClasses {
-    const OptionSpecific: (enumValue: UsableActionType) => "world-context-menu-option-none" | "world-context-menu-option-actions" | "world-context-menu-option-move" | "world-context-menu-option-use" | "world-context-menu-option-unused" | "world-context-menu-option-commandattack" | "world-context-menu-option-commanddefend" | "world-context-menu-option-commandfollowclose" | "world-context-menu-option-commandfollowfar" | "world-context-menu-option-commandheel" | "world-context-menu-option-commandstay" | "world-context-menu-option-quickslotremove" | "world-context-menu-option-quickslotadd" | "world-context-menu-option-quickslotaddtofree" | "world-context-menu-option-quickslotaddtoslot" | "world-context-menu-option-movetoinventory" | "world-context-menu-option-dropmenu" | "world-context-menu-option-dropall" | "world-context-menu-option-dropallofsamequality" | "world-context-menu-option-repairwithitem" | "world-context-menu-option-reinforcewithitem" | "world-context-menu-option-enhancewithitem" | "world-context-menu-option-enchantwithitem" | "world-context-menu-option-transmogrifywithitem" | "world-context-menu-option-upgradewithitem" | "world-context-menu-option-alterwithitem" | "world-context-menu-option-refinewithitem" | "world-context-menu-option-preservewithitem" | "world-context-menu-option-addfuelwithitem" | "world-context-menu-option-ignitewithitem" | "world-context-menu-option-absorbwithitem" | "world-context-menu-option-exudewithitem" | "world-context-menu-option-movetoinventorymenu" | "world-context-menu-option-movetoactivecontainermenu" | "world-context-menu-option-movetofacingcontainermenu" | "world-context-menu-option-moveall" | "world-context-menu-option-moveallofsamequality" | "world-context-menu-option-tradetradersell" | "world-context-menu-option-tradetraderbuy" | "world-context-menu-option-itemactions" | "world-context-menu-option-gatherwithhands" | "world-context-menu-option-harvestwithhands" | "world-context-menu-option-digwithhands" | "world-context-menu-option-tillwithhands" | "world-context-menu-option-pickupexcrementwithhands" | "world-context-menu-option-equipheld" | "world-context-menu-option-equiplegs" | "world-context-menu-option-equipchest" | "world-context-menu-option-equiphead" | "world-context-menu-option-equipwaist" | "world-context-menu-option-equipfeet" | "world-context-menu-option-equipneck" | "world-context-menu-option-equiphands" | "world-context-menu-option-equipback" | "world-context-menu-option-equipmainhand" | "world-context-menu-option-equipoffhand" | "world-context-menu-option-restonground" | "world-context-menu-option-sleeponground" | "world-context-menu-option-commandmenu" | "world-context-menu-option-displayheld" | "world-context-menu-option-displaylegs" | "world-context-menu-option-displaychest" | "world-context-menu-option-displayhead" | "world-context-menu-option-displaywaist" | "world-context-menu-option-displayfeet" | "world-context-menu-option-displayneck" | "world-context-menu-option-displayhands" | "world-context-menu-option-displayback" | "world-context-menu-option-displaymainhand" | "world-context-menu-option-displayoffhand" | "world-context-menu-option-reshapewithitem" | "world-context-menu-option-movecontentsmenu" | "world-context-menu-option-movecontentstoinventory" | "world-context-menu-option-movecontentstoactivecontainer" | "world-context-menu-option-movecontentstofacingcontainer" | "world-context-menu-option-movecontentsofactivecontainermenu" | "world-context-menu-option-movecontentsoffacingcontainermenu" | "world-context-menu-option-commandmenuall" | "world-context-menu-option-commandallfollowclose" | "world-context-menu-option-commandallfollowfar" | "world-context-menu-option-commandallstay" | "world-context-menu-option-commandalldefend" | "world-context-menu-option-commandallattack" | "world-context-menu-option-commandallheel" | "world-context-menu-option-ascend" | "world-context-menu-option-descend";
+    const OptionSpecific: (enumValue: UsableActionType) => "world-context-menu-option-none" | "world-context-menu-option-actions" | "world-context-menu-option-move" | "world-context-menu-option-use" | "world-context-menu-option-unused" | "world-context-menu-option-commandattack" | "world-context-menu-option-commanddefend" | "world-context-menu-option-commandfollowclose" | "world-context-menu-option-commandfollowfar" | "world-context-menu-option-commandheel" | "world-context-menu-option-commandstay" | "world-context-menu-option-collapse" | "world-context-menu-option-quickslotremove" | "world-context-menu-option-quickslotadd" | "world-context-menu-option-quickslotaddtofree" | "world-context-menu-option-quickslotaddtoslot" | "world-context-menu-option-movetoinventory" | "world-context-menu-option-dropmenu" | "world-context-menu-option-dropall" | "world-context-menu-option-dropallofsamequality" | "world-context-menu-option-repairwithitem" | "world-context-menu-option-reinforcewithitem" | "world-context-menu-option-enhancewithitem" | "world-context-menu-option-enchantwithitem" | "world-context-menu-option-transmogrifywithitem" | "world-context-menu-option-upgradewithitem" | "world-context-menu-option-alterwithitem" | "world-context-menu-option-refinewithitem" | "world-context-menu-option-preservewithitem" | "world-context-menu-option-addfuelwithitem" | "world-context-menu-option-ignitewithitem" | "world-context-menu-option-absorbwithitem" | "world-context-menu-option-exudewithitem" | "world-context-menu-option-movetoinventorymenu" | "world-context-menu-option-movetoactivecontainermenu" | "world-context-menu-option-movetofacingcontainermenu" | "world-context-menu-option-moveall" | "world-context-menu-option-moveallofsamequality" | "world-context-menu-option-tradetradersell" | "world-context-menu-option-tradetraderbuy" | "world-context-menu-option-itemactions" | "world-context-menu-option-gatherwithhands" | "world-context-menu-option-harvestwithhands" | "world-context-menu-option-digwithhands" | "world-context-menu-option-tillwithhands" | "world-context-menu-option-pickupexcrementwithhands" | "world-context-menu-option-equipheld" | "world-context-menu-option-equiplegs" | "world-context-menu-option-equipchest" | "world-context-menu-option-equiphead" | "world-context-menu-option-equipwaist" | "world-context-menu-option-equipfeet" | "world-context-menu-option-equipneck" | "world-context-menu-option-equiphands" | "world-context-menu-option-equipback" | "world-context-menu-option-equipmainhand" | "world-context-menu-option-equipoffhand" | "world-context-menu-option-restonground" | "world-context-menu-option-sleeponground" | "world-context-menu-option-commandmenu" | "world-context-menu-option-displayheld" | "world-context-menu-option-displaylegs" | "world-context-menu-option-displaychest" | "world-context-menu-option-displayhead" | "world-context-menu-option-displaywaist" | "world-context-menu-option-displayfeet" | "world-context-menu-option-displayneck" | "world-context-menu-option-displayhands" | "world-context-menu-option-displayback" | "world-context-menu-option-displaymainhand" | "world-context-menu-option-displayoffhand" | "world-context-menu-option-reshapewithitem" | "world-context-menu-option-movecontentsmenu" | "world-context-menu-option-movecontentstoinventory" | "world-context-menu-option-movecontentstoactivecontainer" | "world-context-menu-option-movecontentstofacingcontainer" | "world-context-menu-option-movecontentsofactivecontainermenu" | "world-context-menu-option-movecontentsoffacingcontainermenu" | "world-context-menu-option-commandmenuall" | "world-context-menu-option-commandallfollowclose" | "world-context-menu-option-commandallfollowfar" | "world-context-menu-option-commandallstay" | "world-context-menu-option-commandalldefend" | "world-context-menu-option-commandallattack" | "world-context-menu-option-commandallheel" | "world-context-menu-option-ascend" | "world-context-menu-option-descend" | "world-context-menu-option-excavate";
 }
 export declare const UsableActionsWorldActions: UsableActionGenerator<[]>;
 export declare const UsableActionsWorldItemActions: UsableActionGenerator<[]>;

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

@@ -52,6 +52,20 @@ export interface ITileGetNameOptions {
     includeCoordinates?: boolean;
     magic?: boolean;
 }
+export interface IMakeCaveOptions {
+    /**
+     * Set to true if we want to reveal failure messages to the player.
+     */
+    failureMessages?: boolean;
+    /**
+     * Set to true if we are allowed to make caves upwards (while we are in caves).
+     */
+    allowInCaves?: boolean;
+    /**
+     * The range of tiles outward to check for another cave so we don't create them too close together.
+     */
+    rangeCheck?: number;
+}
 /**
  * Tile class
  */
@@ -373,12 +387,20 @@ export default class Tile implements IVector4, Partial<ITileContainer>, IFieldOf
      * Checks if another cave entrance is nearby.
      * @returns True if it created cave entrances
      */
-    isCaveEntranceNearby(): boolean;
+    isCaveEntranceNearby(tileRange?: number): boolean;
+    /**
+     * Used to check if we can actually make a chave entrance on the tile.
+     * @returns True if we can make a cave entrance
+     */
+    canMakeCaveEntrance(source: Human | undefined, entranceZ?: WorldZ, options?: IMakeCaveOptions): boolean;
     /**
      * Used to genererate and find appropriate cave entrances
+     * @param source The player that created the cave entrance
+     * @param chance The chance of creating a cave entrance (default 5%)
+     * @param entranceZ The direction of the cave entrance (default down)
      * @returns True if it created cave entrances
      */
-    makeCaveEntrance(source: Human | undefined, chance?: number): boolean;
+    makeCaveEntrance(source: Human | undefined, chance?: number, entranceZ?: WorldZ, options?: IMakeCaveOptions): boolean;
     /**
      * Create puddles around a point and limit them (so they can't expand infinitely)
      */