@wayward/types 2.15.0-beta.dev.20251009.1 → 2.15.0-beta.dev.20251011.1

package/definitions/game/audio/IAudio.d.ts

@@ -13,66 +13,70 @@ export declare enum SfxType {
     Bow = 1,
     Chat = 2,
     Craft = 3,
-    CreatureHit = 4,
-    CreatureNoise = 5,
-    Damaged = 6,
-    DangerousMove = 7,
-    Death = 8,
-    Eating = 9,
-    Encumbered = 10,
-    Exceptional = 11,
-    Extinguish = 12,
-    Fail = 13,
-    FluteNoteA = 14,
-    FluteNoteB = 15,
-    FluteNoteC = 16,
-    FluteNoteD = 17,
-    FluteNoteE = 18,
-    FluteNoteF = 19,
-    FluteNoteG = 20,
-    FluteNoteH = 21,
-    FluteNoteI = 22,
-    GraniteHit = 23,
-    Hit = 24,
-    Hurt = 25,
-    InvokeChaos = 26,
-    InvokeEvil = 27,
-    InvokeGood = 28,
-    Minecart = 29,
-    Miss = 30,
-    Overburdened = 31,
-    PickUp = 32,
-    Sacrifice = 33,
-    SandstoneHit = 34,
-    Slip = 35,
-    Swim = 36,
-    Throw = 37,
-    Trample = 38,
-    TreeHit = 39,
-    UiActivate = 40,
-    UiChoose = 41,
-    UiClose = 42,
-    UiDisable = 43,
-    UiEnable = 44,
-    UiEquip = 45,
-    UiInput = 46,
-    UiInputdelete = 47,
-    UiInvalid = 48,
-    UiOpen = 49,
-    UiOpensmall = 50,
-    UiProtect = 51,
-    UiReorder = 52,
-    UiSelect = 53,
-    UiSort = 54,
-    UiStack = 55,
-    UiTrade = 56,
-    UiUnequip = 57,
-    UiUnprotect = 58,
-    UiUnstack = 59,
-    Walk = 60,
-    Water = 61,
-    Wheelbarrow = 62,
-    CraftFail = 63
+    CraftFail = 4,
+    CreatureHit = 5,
+    CreatureNoise = 6,
+    Damaged = 7,
+    DangerousMove = 8,
+    Death = 9,
+    Eating = 10,
+    Encumbered = 11,
+    Exceptional = 12,
+    Extinguish = 13,
+    Fail = 14,
+    FluteNoteA = 15,
+    FluteNoteB = 16,
+    FluteNoteC = 17,
+    FluteNoteD = 18,
+    FluteNoteE = 19,
+    FluteNoteF = 20,
+    FluteNoteG = 21,
+    FluteNoteH = 22,
+    FluteNoteI = 23,
+    GraniteHit = 24,
+    Hit = 25,
+    Hurt = 26,
+    InvokeChaos = 27,
+    InvokeEvil = 28,
+    InvokeGood = 29,
+    Minecart = 30,
+    Miss = 31,
+    Overburdened = 32,
+    PickUp = 33,
+    Sacrifice = 34,
+    SandstoneHit = 35,
+    Slip = 36,
+    Swim = 37,
+    Throw = 38,
+    Trample = 39,
+    TreeHit = 40,
+    UiActivate = 41,
+    UiChoose = 42,
+    UiClose = 43,
+    UiDisable = 44,
+    UiEnable = 45,
+    UiEquip = 46,
+    UiInput = 47,
+    UiInputdelete = 48,
+    UiInvalid = 49,
+    UiOpen = 50,
+    UiOpensmall = 51,
+    UiProtect = 52,
+    UiReorder = 53,
+    UiSelect = 54,
+    UiSort = 55,
+    UiStack = 56,
+    UiTrade = 57,
+    UiUnequip = 58,
+    UiUnprotect = 59,
+    UiUnstack = 60,
+    Walk = 61,
+    Water = 62,
+    Wheelbarrow = 63,
+    Break = 64,
+    GeneralAction = 65,
+    GeneralMagicalAction = 66,
+    Exude = 67
 }
 export type SfxUi = Extract<keyof typeof SfxType, `Ui${string}`> extends `Ui${infer RESULT}` ? Lowercase<RESULT> : never;
 export declare enum Music {

package/definitions/game/game/curse/Curse.d.ts

@@ -79,6 +79,11 @@ export declare const CURSE_EVENTS_FIRST_NIGHT = 3;
  * If the entity is on a tile that can be seen by a player, it will not despawn.
  */
 export declare const CURSE_EVENTS_ENTITY_DESPAWN_CHANCE = 0.1;
+/**
+ * Some curse events extinguish light sources via additional decay (both static & dynamic (based on % of decay remaining))
+ * This multiplier affects how quickly curse ward doodads & items are extinguished compared to the rest
+ */
+export declare const CURSE_EVENTS_EXTINGUISH_WARD_MULTIPLIER = 0.2;
 declare namespace Curse {
     interface Helper {
         context: CurseEventContext;

package/definitions/game/game/curse/CurseEvent.d.ts

@@ -19,6 +19,10 @@ import { IRange } from "@wayward/utilities/math/Range";
 import type Tile from "@wayward/game/game/tile/Tile";
 import type Creature from "@wayward/game/game/entity/creature/Creature";
 import type { CreatureType } from "@wayward/game/game/entity/creature/ICreature";
+import type Doodad from "@wayward/game/game/doodad/Doodad";
+import type Item from "@wayward/game/game/item/Item";
+import type TileEvent from "@wayward/game/game/tile/TileEvent";
+import type WorldZ from "@wayward/utilities/game/WorldZ";
 /** The API that curse events have access to */
 export interface CurseEventContext {
     readonly island: Island;
@@ -38,11 +42,29 @@ export interface CurseEventContext {
     getNearbyPlayers(): Human[];
     /** Get a random tile within the curse event's radius. This is based on `CurseEvent.position` and `CurseEvent.radius` */
     getRandomTile(radius?: number): Tile | undefined;
+    /** Get a random tile within the curse event's radius. This is based on `CurseEvent.position` and `CurseEvent.radius` */
+    getTilesInRange(radius?: number, z?: WorldZ): Tile[];
     /**
      * Spawn a creature at the given tile using the curse event spawning rules.
+     *
+     * Note that "curse event" creatures:
+     * - Do not display alerted notifiers
+     * - Do not randomly despawn
+     * - Are despawned at the event end
+     *
      * @param evenWhenAsleep Disable the default functionality of preventing spawns if the cursebearer is asleep
      */
     spawnCreature(type?: CreatureType, tile?: Tile, evenWhenAsleep?: true): Creature | undefined;
+    /**
+     * Note: This does not check whether or not the cursebearer is asleep.
+     * @param options The options for extinguishing lights
+     * @param lights The lights that should lose decay. If no lights are provided, all lights in the event radius will be affected
+     */
+    extinguish(options: CurseEventExtinguishOptions, ...lights: Array<Doodad | Item | TileEvent>): void;
+    /**
+     * Mark the given creatures as "curse event" creatures. See the `spawnCreature` function for more information
+     */
+    claim(...creatures: Creature[]): void;
     /**
      * Inject a custom curse event subscriber class into the game.
      * This class *must* be included in `CurseEvent.subscribers`.
@@ -54,6 +76,20 @@ export interface CurseEventContext {
     uninject<T extends CurseEventSubscriber>(subscriber: Class<T>): void;
     toString(): string;
 }
+export interface CurseEventExtinguishOptions {
+    /**
+     * The number of flat ticks to reduce decays by
+     *
+     * Chooses the higher of `staticDecay` and `dynamicDecay`.
+     */
+    staticDecay?: number | IRange;
+    /**
+     * The percentage of the current decay to reduce by, represented as a number between 0 and 1.
+     *
+     * Chooses the higher of `staticDecay` and `dynamicDecay`.
+     */
+    dynamicDecay?: number | IRange;
+}
 export interface CurseEvent {
     group: CurseGroup;
     category: CurseCategory;

package/definitions/game/game/curse/event/CurseEventShadows.d.ts

@@ -9,5 +9,11 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import { CurseEvent } from "@wayward/game/game/curse/CurseEvent";
+import { IRange, IRangeRange } from "@wayward/utilities/math/Range";
+export declare const CURSE_EVENT_SHADOWS_SPAWN_DELAY: IRangeRange;
+export declare const CURSE_EVENT_SHADOWS_EXTINGUISH_DELAY: IRangeRange;
+export declare const CURSE_EVENT_SHADOWS_EXTINGUISH_STATIC: IRangeRange;
+export declare const CURSE_EVENT_SHADOWS_EXTINGUISH_DYNAMIC: IRangeRange;
+export declare const CURSE_EVENT_SHADOWS_EXTINGUISH_TIME_MULTIPLIER: IRange;
 declare const _default: CurseEvent;
 export default _default;

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

@@ -403,6 +403,7 @@ export default class Doodad extends EntityMovable<IDoodadDescription, DoodadType
      * @returns True if the solar still can work in the current temperature, false if not.
      */
     willStillWorkInTemperature(): boolean;
+    forceDecayTick(): void;
     /**
      * Decay over time
      */

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

@@ -86,7 +86,7 @@ export default class DoodadManager extends EntityManager<Doodad> {
      */
     updateAllAsync(ticks: number, playingHumans: Human[], playerHumanTiles: Set<Tile>, onProgress: (progess: number) => Promise<void>): Promise<void>;
     verifyAndFixItemWeights(): void;
-    getScarecrowInRange(tile: Tile): Doodad | undefined;
+    getScarecrowInRange(tile: Tile, group?: DoodadTypeGroup): Doodad | undefined;
     getScarecrowInLineOfSight(creature: Creature, isClientside: boolean): Doodad | undefined;
     addScarecrow(doodad: Doodad): void;
     removeScarecrow(doodad: Doodad): void;

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

@@ -17,6 +17,7 @@ import type { SkillType } from "@wayward/game/game/entity/IHuman";
 import type { IDecayTemperatureRange } from "@wayward/game/game/IGame";
 import type { ILootItem } from "@wayward/game/game/ILoot";
 import type { IObjectDescription, IObjectOptions } from "@wayward/game/game/IObject";
+import type { WaterType } from "@wayward/game/game/island/IIsland";
 import type Island from "@wayward/game/game/island/Island";
 import type { IContainer, IItemOld, ItemType, ItemTypeExtra, ItemTypeGroup } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
@@ -528,7 +529,8 @@ export declare enum DoodadTypeGroup {
     Altar = -9978,
     OpenFireSource = -9977,
     RequiresCandleToLight = -9976,
-    ContainsFuelSource = -9975
+    ContainsFuelSource = -9975,
+    CurseWard = -9974
 }
 export declare enum DoorOrientation {
     /**
@@ -559,6 +561,7 @@ export interface IHasBuilder {
 export interface IHasWater {
     top?: true;
     bottom?: true;
+    waterType?: WaterType;
 }
 export interface IDoodadGetNameOptions {
     count: number;

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

@@ -10,8 +10,8 @@
  */
 import CombatStrengthManager from "@wayward/game/game/entity/CombatStrengthManager";
 import Creature from "@wayward/game/game/entity/creature/Creature";
-import type { ICreatureCheckMoveOptions } from "@wayward/game/game/entity/creature/ICreature";
-import { CreatureType, TileGroup } from "@wayward/game/game/entity/creature/ICreature";
+import type { ICreatureCheckMoveOptions, ICreatureSpawnOptions } from "@wayward/game/game/entity/creature/ICreature";
+import { CreatureType } from "@wayward/game/game/entity/creature/ICreature";
 import type { IEntityRemoveOptions } from "@wayward/game/game/entity/EntityManager";
 import EntityManager from "@wayward/game/game/entity/EntityManager";
 import type Human from "@wayward/game/game/entity/Human";
@@ -48,12 +48,8 @@ export default class CreatureManager extends EntityManager<Creature, IEntityRemo
      * Spawns a creature.
      * @param type The type of creature to spawn.
      * @param tile The tile
-     * @param bypass Whether to bypass checks for whether the creature can spawn there naturally. Defaults to false, if the creature can't spawn naturally, it won't.
-     * @param forceAberrant If provided, forces the spawned creature's aberrant state to be the passed boolean. True = aberrant, false = not aberrant. If not provided, the aberrant state is decided based on chance.
-     * @param spawnTiles If set, this will overwrite the creature's description for which tiles it can spawn on
-     * @param bypassCreatureLimit If set, the creature limit will be ignored and spawn the creature over the set limit
      */
-    spawn(type: CreatureType, tile: Tile, bypass?: boolean, forceAberrant?: boolean, spawnTiles?: TileGroup, bypassCreatureLimit?: boolean, bypassAll?: boolean): Creature | undefined;
+    spawn(type: CreatureType, tile: Tile, options?: ICreatureSpawnOptions): Creature | undefined;
     spawnFromZone(tile: Tile, bypassCreatureLimit?: boolean, checkTerrainType?: boolean): Creature | undefined;
     createFake(type: CreatureType, aberrant: boolean, tile?: Tile, id?: number): Creature;
     exists(creature: Creature): boolean;

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

@@ -521,3 +521,29 @@ export interface ICreatureCheckMoveOptions {
     ignoreScareCrow: boolean;
     ignoreMoveTypeNone: boolean;
 }
+export interface ICreatureSpawnOptions {
+    /**
+     * If set to true, the creature will ignore blocked or full tile checks as well as ignore spawnTiles definitions set on the creature.
+     */
+    bypassTiles?: boolean;
+    /**
+     * If provided, forces the spawned creature's aberrant state to be the passed boolean. True = aberrant, false = not aberrant. If not provided, the aberrant state is decided based on chance.
+     */
+    forceAberrant?: boolean;
+    /**
+     * If set, this will overwrite the creature's description for which tiles it can spawn on. This will also change which tiles it can path on to, differing from its set definitions.
+     */
+    spawnTiles?: TileGroup;
+    /**
+     * If set to true, this will bypass the current zone's creature limit and spawn it regardless.
+     */
+    bypassCreatureLimit?: boolean;
+    /**
+     * If set to true, the creatures will ignore scarecrows when spawning. Note that this does NOT ignore the chance of being scared by a scarecrow when moving, just the initial spawn checks.
+     */
+    bypassScarecrows?: boolean;
+    /**
+     * If set to true, all checks will be bypassed and the creature will spawn no matter what.
+     */
+    bypassAll?: boolean;
+}

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

@@ -29,6 +29,7 @@ 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 { WaterType } 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 } 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";
@@ -380,7 +381,7 @@ export default class Item extends EntityMovable<IItemDescription, ItemType, Refe
     /**
      * Decreases the time until the item will decay (ticks until it decays at 1x decay speed).
      */
-    reduceDecayTime(time?: number): number | undefined;
+    reduceDecayTime(time?: number, skipChance?: boolean): number | undefined;
     /**
      * Sets the item's decay time (ticks until it decays at 1x decay speed).
      * @param decayTime The new decay time to set, or `undefined` to remove the decay time.
@@ -525,6 +526,11 @@ export default class Item extends EntityMovable<IItemDescription, ItemType, Refe
      */
     getReturnType(): ItemType;
     createReturnItem(returnType: ItemType, container?: IContainer): Item | undefined;
+    /**
+     * Returns the type of water contained in the item in the case of containers of liquid.
+     * @returns WaterType enum value.
+     */
+    getWaterType(): WaterType;
     private checkIfItemsMatch;
     private checkIfItemArraysMatch;
 }

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

@@ -297,7 +297,7 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
      */
     getEfficacyTranslation(human: Human, qualityBonus: number, maxQualityBonus: number, recipe: IRecipe, ui?: boolean): TranslationImpl | undefined;
     updateItems(ticks: number, playerIds: Set<number>, skipHumanItems?: boolean): boolean;
-    updateItem(ticks: number, item: Item, isInInventory: boolean): boolean;
+    updateItem(ticks: number, item: Item, isInInventory?: boolean): boolean;
     getPlayerWithItemInInventory(containable: IContainable): Player | undefined;
     getAbsentPlayerWithItemInInventory(containable: IContainable): Player | undefined;
     getNPCWithItemInInventory(containable: IContainable): NPC | undefined;

package/package.json

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