@wayward/types 2.15.0-beta.dev.20251005.1 → 2.15.0-beta.dev.20251006.1

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

@@ -15,7 +15,7 @@ import type Human from "@wayward/game/game/entity/Human";
 import { SkillType } from "@wayward/game/game/entity/IHuman";
 import type Island from "@wayward/game/game/island/Island";
 import type { IVector2 } from "@wayward/game/utilities/math/IVector";
-import { IRange } from "@wayward/utilities/math/Range";
+import { IRange, IRangeRange } from "@wayward/utilities/math/Range";
 export declare const CURSE_WEIGHTS: PartialRecord<CurseComponent, number>;
 export declare const CURSE_ATTACK_MAX = 50;
 export declare const CURSE_DEFENSE_MAX = 100;
@@ -55,15 +55,13 @@ export declare const CURSE_EVENTS_MAELSTROM_SPEED = 1;
  * Additional opportunities before the top opportunity always use the max chance.
  */
 export declare const CURSE_EVENTS_CHANCE: IRange;
-export declare const CURSE_EVENTS_NEARBY_PLAYERS_RADIUS = 25;
+export declare const CURSE_EVENTS_DEFAULT_RADIUS = 25;
 /**
- * For randomly selecting the cooldown time between curse event nights.
- * Interpolates between the minimum and maximum values based on the player's curse — minimum at 0% curse, maximum at 100% curse.
+ * An IRangeRange for randomly selecting the cooldown time between curse event nights.
+ * Interpolates between the minimum and maximum ranges based on the player's curse.
  */
-export declare const CURSE_EVENTS_COOLDOWN_RANGE: {
-    minimum: IRange;
-    maximum: IRange;
-};
+export declare const CURSE_EVENTS_COOLDOWN_RANGE: IRangeRange;
+export declare const CURSE_EVENTS_FIRST_NIGHT = 3;
 declare namespace Curse {
     interface Helper {
         context: CurseEventContext;
@@ -71,11 +69,13 @@ declare namespace Curse {
         definition: CurseEvent;
     }
     function get(island?: Island, type?: CurseEventType): Helper | undefined;
+    function clearCooldown(island: Island): void;
     function tickCurse(island: Island, humans: Human[]): void;
     function reload(island: Island): void;
     function spawnCurseEvents(island: Island, humans: Human[]): void;
     function attemptCurseEventSpawn(category: CurseCategory, human: Human, curse: number, humans: Human[], events: CurseEventInstance[]): CurseEventInstance | undefined;
     function attemptSpecificCurseEventSpawn(human: Human, type: CurseEventType, humans: Human[], curse?: number): CurseEventInstance | undefined;
+    function unload(island: Island): void;
     function cleanup(island: Island, humans?: Human[]): void;
     function createCurseEventContext(instance: CurseEventInstance, island: Island, humans?: Human[], cursebearer?: Human): CurseEventContext;
 }
@@ -92,7 +92,9 @@ interface CurseEventInstance {
     type: CurseEventType;
     display: CurseEventDisplayMode;
     cursebearerIdentifier: string;
+    curse: number;
     point: IVector2;
+    creatures?: number[];
     subscribers?: string[];
     scriptProcesses?: ScriptProcessState[];
     [SYMBOL_CURSE_EVENT_SUBSCRIBER_INSTANCES]?: Record<string, CurseEventSubscriber>;

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

@@ -9,21 +9,40 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { BiomeType } from "@wayward/game/game/biome/IBiome";
-import type { CurseGroup, CurseEventDisplayMode, CurseEventType, CurseCategory } from "@wayward/game/game/curse/ICurse";
+import type { CurseGroup, CurseEventDisplayMode, CurseEventType, CurseCategory, CursePosition } from "@wayward/game/game/curse/ICurse";
 import type Human from "@wayward/game/game/entity/Human";
 import type Island from "@wayward/game/game/island/Island";
 import type { IGameOptionsPartial } from "@wayward/game/game/options/IGameOptions";
 import type { TimeString } from "@wayward/game/game/time/ITimeManager";
 import type { IVector2 } from "@wayward/game/utilities/math/IVector";
-import type { IRange } from "@wayward/utilities/math/Range";
+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";
 /** The API that curse events have access to */
 export interface CurseEventContext {
     readonly island: Island;
+    /** The epicenter of the curse, based on `CurseEvent.position` */
     readonly point: IVector2;
     /** A number 0-1 of how far through the night it currently is */
     readonly fractionalTime: number;
+    /** The human that happened to get the event rolled on them */
     readonly cursebearer: Human | undefined;
+    /** The cursebearer's curse at the time the event began */
+    readonly curse: number;
+    /** The creatures that the event has spawned */
+    readonly creatures: Creature[];
+    /** Whether the cursebearer is asleep */
+    readonly sleeping: boolean;
+    /** Get the players nearby the curse. This is based on `CurseEvent.position` and `CurseEvent.radius` */
     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;
+    /**
+     * Spawn a creature at the given tile using the curse event spawning rules.
+     * @param evenWhenAsleep Disable the default functionality of preventing spawns if the cursebearer is asleep
+     */
+    spawnCreature(type?: CreatureType, tile?: Tile, evenWhenAsleep?: true): Creature | undefined;
     /**
      * Inject a custom curse event subscriber class into the game.
      * This class *must* be included in `CurseEvent.subscribers`.
@@ -37,6 +56,17 @@ export interface CurseEventContext {
 export interface CurseEvent {
     group: CurseGroup;
     category: CurseCategory;
+    /**
+     * The chance that this curse event will spawn compared to other events.
+     * All curse events default to a weight of 1, so setting this to 0.5 would make it half as likely as any other event.
+     */
+    weight?: number;
+    position?: CursePosition;
+    /**
+     * Controls the radius of the curse event. Defaults to the value of `CURSE_EVENTS_DEFAULT_RADIUS` (at time of writing, 25.)
+     * This is used for the `CurseEventContext.getRandomTile` and `CurseEventContext.getNearbyPlayers` methods.
+     */
+    radius?: number;
     /** A number 0-1 representing the curse level that the randomly selected player must have in order for this curse event to be chosen */
     requiredCurseLevel?: number;
     requiredBiomes?: {
@@ -50,7 +80,7 @@ export interface CurseEvent {
     subscribers?: Array<Class<CurseEventSubscriber>>;
     onStart?(context: CurseEventContext): void;
     onEnd?(context: CurseEventContext): void;
-    script?: CurseEventScript;
+    script?: CurseEventScript | CurseEventScript.Repeat | CurseEventScript.Simultaneously;
 }
 export declare function CurseEvent(event: CurseEvent): CurseEvent;
 export type CurseEventScript = CurseEventScript.Step[];
@@ -61,9 +91,9 @@ export declare namespace CurseEventScript {
     }
     export interface EndAfter extends CurseEventScriptNodeBase {
         type: "end after";
-        ticks: number | IRange;
+        ticks: SupplierOr<number | IRange, [CurseEventContext]>;
     }
-    export function EndAfter(ticks: number | IRange): EndAfter;
+    export function EndAfter(ticks: SupplierOr<number | IRange, [CurseEventContext]>): EndAfter;
     export interface EndAt extends CurseEventScriptNodeBase {
         type: "end at";
         time: TimeString;
@@ -79,6 +109,7 @@ export declare namespace CurseEventScript {
         type: "wait";
         end: EndCondition;
     }
+    export function Wait(ticks: SupplierOr<number | IRange, [CurseEventContext]>): Wait;
     export function Wait(end: EndCondition): Wait;
     export interface Action extends CurseEventScriptNodeBase {
         type: "action";

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

@@ -53,6 +53,14 @@ export declare enum CurseCategory {
      */
     Dependent = 2
 }
+export declare enum CursePosition {
+    /** The default value for a curse event. `position` returns the island's center. */
+    None = 0,
+    /** The curse event spawns in a random location near the cursebearer. */
+    Random = 1,
+    /** The curse event's position is always directly on the cursebearer. */
+    Follow = 2
+}
 export declare enum CurseComponent {
     Skill = 0,
     HighestAttack = 1,

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

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2025 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 { CurseEvent } from "@wayward/game/game/curse/CurseEvent";
+declare const _default: CurseEvent;
+export default _default;

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

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2025 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 { CurseEvent } from "@wayward/game/game/curse/CurseEvent";
+declare const _default: CurseEvent;
+export default _default;

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

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2025 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 { CurseEvent } from "@wayward/game/game/curse/CurseEvent";
+declare const _default: CurseEvent;
+export default _default;

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

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2025 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 { CurseEvent } from "@wayward/game/game/curse/CurseEvent";
+declare const _default: CurseEvent;
+export default _default;

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

@@ -256,6 +256,7 @@ export default abstract class Human<DescriptionType = unknown, TypeType extends
     getEquippedItem(slot: EquipType, includeDisabled?: true): Item | undefined;
     isOffHandDisabled(): boolean;
     getEquipSlotForItem(item: Item, includeDisabled?: true): EquipType | undefined;
+    getFanaticism(deity: Deity): number;
     getCurse(): number;
     canSeePosition(type: CanASeeBType, islandId: IslandId, x: number, y: number, z: number, fieldOfView?: FieldOfView, customRadius?: number): boolean;
     /**

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

@@ -8,13 +8,17 @@
  * 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 { DeityReal } from "@wayward/game/game/deity/Deity";
 import { Action } from "@wayward/game/game/entity/action/Action";
 import type { IActionUsable } from "@wayward/game/game/entity/action/IAction";
 import { ActionArgument, ActionType } from "@wayward/game/game/entity/action/IAction";
 import type { IInvokeUse } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
+import { Milestone } from "@wayward/game/game/milestones/IMilestone";
 export interface IInvokeUsable extends IActionUsable, IInvokeUse {
     rune: Item;
 }
+export declare const DEITY_INVOKE_MILESTONES: Record<DeityReal, Milestone>;
+export declare const RUNE_USE_CHANCE = 1;
 declare const _default: Action<[ActionArgument.Item], ActionType.Invoke, import("../../player/Player").default, void, IInvokeUsable, [Item]>;
 export default _default;

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

@@ -8,4 +8,12 @@
  * 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
  */
-export {};
+import type { QualityNatural } from "@wayward/game/game/IObject";
+import { Quality } from "@wayward/game/game/IObject";
+import { ChaosEffect } from "@wayward/game/game/deity/Chaos";
+import type { IRange } from "@wayward/utilities/math/Range";
+export declare const RUNE_OF_EVIL_SPAWN_COUNT: Record<QualityNatural, IRange>;
+export declare const RUNE_OF_EVIL_MAX_ATTEMPTS = 20;
+export declare const RUNE_OF_GOOD_PACIFY_CHANCE: Record<QualityNatural, number>;
+export declare const RUNE_OF_GOOD_PACIFY_TIME: Record<QualityNatural, IRange>;
+export declare const RUNE_OF_CHAOS_EFFECT_MAP: PartialRecord<Quality, ChaosEffect>;

package/definitions/game/game/options/IGameOptions.d.ts

@@ -298,6 +298,12 @@ export interface IGameOptionsPlayer {
          * TODO: Set to Map<RecipeLevel, number> when we can support maps in milestone modifier overrides?
          */
         difficultyMultiplier: number;
+        /**
+         * A multiplier for the chance of magical properties being generated on crafted items.
+         *
+         * Multiplied with the island's chance for any item being generated with magical properties (which is per-quality.)
+         */
+        magicChanceMultiplier: number;
         /**
          * Allow default crafting recipe discovery.
          */