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

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

@@ -28,7 +28,7 @@ import { AutoSave } from "@wayward/game/game/meta/AutoSave";
 import { SaveLoad } from "@wayward/game/game/meta/SaveLoad";
 import type { Milestone } from "@wayward/game/game/milestones/IMilestone";
 import { MilestoneManager } from "@wayward/game/game/milestones/MilestoneManager";
-import type { IGameOptions } from "@wayward/game/game/options/IGameOptions";
+import type { IGameOptions, IGameOptionsPartial } from "@wayward/game/game/options/IGameOptions";
 import { GameMode } from "@wayward/game/game/options/IGameOptions";
 import type { GameplayModifiersCollection } from "@wayward/game/game/options/modifiers/GameplayModifiersManager";
 import type { ChallengeModifiersCollection } from "@wayward/game/game/options/modifiers/challenge/ChallengeModifiers";
@@ -177,6 +177,8 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     selectBiome(position: IVector2 | undefined, random: Random): BiomeTypes;
     getGameMode(): GameMode;
     getGameOptionsBeforeModifiers(): IGameOptions;
+    /** A game options modifier that always returns an empty array by default, to be injected into */
+    getAdditionalGameOptionsSources(): IGameOptionsPartial[];
     getGameOptions(): IGameOptions;
     uncacheGameOptions(): void;
     updateGameOptions(gameOptions: IGameOptions): void;

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

@@ -34,12 +34,6 @@ import type { IVector2, IVector3 } from "@wayward/game/utilities/math/IVector";
 import type { IBuildId } from "@wayward/hosts/shared/globalTypes";
 import type { IRange } from "@wayward/utilities/math/Range";
 export interface IGameEvents {
-    /**
-     * Called when game options are first processed, after modifiers are applied.
-     *
-     * You can use this combined with `game.uncacheGameOptions()` to dynamically modify game options.
-     */
-    getGameOptions(gameOptions: IGameOptions): IGameOptions;
     /**
      * Called when the game is starting
      * @param isLoadingSave True if a save game was loaded

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

@@ -8,16 +8,19 @@
  * 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 { CurseEventContext, CurseEventSubscriber } from "@wayward/game/game/curse/CurseEvent";
-import { CurseComponent, CurseEventType } from "@wayward/game/game/curse/ICurse";
+import type { CurseEvent, CurseEventContext } from "@wayward/game/game/curse/CurseEvent";
+import { CurseEventSubscriber } from "@wayward/game/game/curse/CurseEvent";
+import { CurseCategory, CurseComponent, CurseEventDisplayMode, CurseEventType } from "@wayward/game/game/curse/ICurse";
 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";
 export declare const CURSE_WEIGHTS: PartialRecord<CurseComponent, number>;
 export declare const CURSE_ATTACK_MAX = 50;
 export declare const CURSE_DEFENSE_MAX = 100;
 export declare const CURSE_CRAFTING_MAX = 100;
+export declare const CURSE_KILLING_MAX = 100;
 export declare const CURSE_SKILL_MAX = 100;
 export declare const CURSE_COMPONENTS: Record<CurseComponent, (human: Human) => number>;
 /**
@@ -44,26 +47,55 @@ export declare const CURSE_EVENTS_MAX = 5;
  */
 export declare const CURSE_EVENTS_MAELSTROM_SPEED = 1;
 /**
- * The maximum chance that a curse event will occur, given the opportunity. The chance scales up from 0% at 0% curse, to this value at 100% curse.
+ * The chance that a curse event will occur, given the opportunity.
+ * The chance scales up from the minimum (left) value at 0% curse, to the maximum (right) value at 100% curse.
  *
  * There can be up to CURSE_EVENTS_MAX opportunities per night, based on maelstrom level.
  * At 0-1 maelstrom, there are up to 2 opportunities per night. (Per player, because curse events are localised.)
  * Additional opportunities before the top opportunity always use the max chance.
  */
-export declare const CURSE_EVENTS_MAX_CHANCE = 0.5;
+export declare const CURSE_EVENTS_CHANCE: IRange;
 export declare const CURSE_EVENTS_NEARBY_PLAYERS_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.
+ */
+export declare const CURSE_EVENTS_COOLDOWN_RANGE: {
+    minimum: IRange;
+    maximum: IRange;
+};
 declare namespace Curse {
+    interface Helper {
+        context: CurseEventContext;
+        instance: CurseEventInstance;
+        definition: CurseEvent;
+    }
+    function get(island?: Island, type?: CurseEventType): Helper | undefined;
     function tickCurse(island: Island, humans: Human[]): void;
     function reload(island: Island): void;
     function spawnCurseEvents(island: Island, humans: Human[]): void;
-    function attemptCurseEventSpawn(human: Human, curse: number, humans: Human[], events: CurseEventInstance[]): CurseEventInstance | undefined;
+    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 cleanup(island: Island, humans?: Human[]): void;
-    function createCurseEventContext(instance: CurseEventInstance, island: Island, humans: Human[], cursebearer?: Human): CurseEventContext;
+    function createCurseEventContext(instance: CurseEventInstance, island: Island, humans?: Human[], cursebearer?: Human): CurseEventContext;
 }
+declare const SYMBOL_CURSE_EVENT_SUBSCRIBER_INSTANCES: unique symbol;
+declare const SYMBOL_CURSE_EVENT_GLOBAL_SUBSCRIBER_INSTANCE: unique symbol;
 interface Curse {
-    active?: true;
+    night?: true;
     events?: CurseEventInstance[];
+    cooldown?: number;
+    warned?: true;
+    [SYMBOL_CURSE_EVENT_GLOBAL_SUBSCRIBER_INSTANCE]?: CurseEventSubscriber;
+}
+interface CurseEventInstance {
+    type: CurseEventType;
+    display: CurseEventDisplayMode;
+    cursebearerIdentifier: string;
+    point: IVector2;
+    subscribers?: string[];
+    scriptProcesses?: ScriptProcessState[];
+    [SYMBOL_CURSE_EVENT_SUBSCRIBER_INSTANCES]?: Record<string, CurseEventSubscriber>;
 }
 interface ScriptProcessState {
     /** The path of keys/indices from the root of the script to the step this process is currently on. */
@@ -75,14 +107,4 @@ interface ScriptProcessState {
     /** The state of any child processes started by a "simultaneously" or "repeat" block. */
     childProcesses?: ScriptProcessState[];
 }
-declare const SYMBOL_CURSE_EVENT_SUBSCRIBER_INSTANCES: unique symbol;
-interface CurseEventInstance {
-    type: CurseEventType;
-    visible: boolean;
-    cursebearerIdentifier: string;
-    point: IVector2;
-    subscribers?: string[];
-    scriptProcesses?: ScriptProcessState[];
-    [SYMBOL_CURSE_EVENT_SUBSCRIBER_INSTANCES]?: Record<string, CurseEventSubscriber>;
-}
 export default Curse;

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

@@ -9,13 +9,14 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { BiomeType } from "@wayward/game/game/biome/IBiome";
-import type { CurseCategory, CurseEventType } from "@wayward/game/game/curse/ICurse";
+import type { CurseGroup, CurseEventDisplayMode, CurseEventType, CurseCategory } 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";
+/** The API that curse events have access to */
 export interface CurseEventContext {
     readonly island: Island;
     readonly point: IVector2;
@@ -28,21 +29,13 @@ export interface CurseEventContext {
      * This class *must* be included in `CurseEvent.subscribers`.
      */
     inject<T extends CurseEventSubscriber>(subscriber: Class<T>): void;
-    setVisible(visible: boolean): void;
+    setDisplay(mode: CurseEventDisplayMode): void;
     uninject(): void;
     uninject<T extends CurseEventSubscriber>(subscriber: Class<T>): void;
     toString(): string;
 }
-/**
- * A base class for subscribing to game events & applying game options during a curse event.
- * Note that renaming this class will result in it no longer being subscribed for a curse event, if it was before.
- */
-export declare abstract class CurseEventSubscriber {
-    protected readonly event: CurseEventContext;
-    constructor(event: CurseEventContext);
-    protected getOptions?(): IGameOptionsPartial;
-}
 export interface CurseEvent {
+    group: CurseGroup;
     category: CurseCategory;
     /** 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;
@@ -53,6 +46,7 @@ export interface CurseEvent {
     /** If one event is marked as conflicting with another, they will both have the conflict registered. */
     conflicts?: CurseEventType[];
     requiredPredicate?(context: CurseEventContext): boolean;
+    getOptions?(): IGameOptionsPartial;
     subscribers?: Array<Class<CurseEventSubscriber>>;
     onStart?(context: CurseEventContext): void;
     onEnd?(context: CurseEventContext): void;
@@ -109,3 +103,13 @@ export declare namespace CurseEventScript {
     export type Step = Wait | Action | Repeat | Simultaneously;
     export {};
 }
+/**
+ * A base class for subscribing to game events & applying game options during a curse event.
+ * Note that renaming this class will result in it no longer being subscribed for a curse event, if it was before.
+ */
+export declare abstract class CurseEventSubscriber {
+    protected readonly event: CurseEventContext;
+    constructor(event: CurseEventContext);
+    protected getOptions?(): IGameOptionsPartial;
+    private getAdditionalGameOptionsSources;
+}

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

@@ -30,20 +30,44 @@ export declare enum CurseEventType {
     FrigidNight = 18,
     HeatWave = 19
 }
-export declare enum CurseCategory {
+export declare enum CurseGroup {
     Lucky = 0,
     Neutral = 1,
     Unlucky = 2
 }
+export declare enum CurseCategory {
+    /**
+     * Primary curses are the main ones that players should be responding to.
+     */
+    Primary = 0,
+    /**
+     * Secondary curses are ones that interact with the primary curses in interesting ways.
+     *
+     * Secondary curses are selected before primary curses.
+     */
+    Secondary = 1,
+    /**
+     * Dependent curses are secondary curses that can ONLY be selected if a specific primary curse is also selected.
+     *
+     * They're still selected before primary curses, but will be cancelled if no primary curse is selected.
+     */
+    Dependent = 2
+}
 export declare enum CurseComponent {
     Skill = 0,
     HighestAttack = 1,
     HighestDefense = 2,
     CumulativeEvilCrafting = 3,
     Equipment = 4,
-    Modifier = 5
+    Modifier = 5,
+    CumulativeKilling = 6
 }
 export declare enum CurseSystemDiscovery {
     CurseFactors = 0,
     CurseFactorsExact = 1
 }
+export declare enum CurseEventDisplayMode {
+    Hidden = 0,
+    Mystery = 1,
+    Revealed = 2
+}

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

@@ -46,7 +46,7 @@ import ItemReference from "@wayward/game/game/item/ItemReference";
 import MagicalPropertyType from "@wayward/game/game/magic/MagicalPropertyType";
 import { Milestone } from "@wayward/game/game/milestones/IMilestone";
 import Runekeeper from "@wayward/game/game/milestones/milestone/Runekeeper";
-import type { IGameOptionsPlayer } from "@wayward/game/game/options/IGameOptions";
+import type { IGameOptionsPartial, IGameOptionsPlayer } from "@wayward/game/game/options/IGameOptions";
 import type { Reference, ReferenceType } from "@wayward/game/game/reference/IReferenceManager";
 import type { IHasInsulation } from "@wayward/game/game/temperature/ITemperature";
 import { TempType } from "@wayward/game/game/temperature/ITemperature";
@@ -130,6 +130,7 @@ export default abstract class Human<DescriptionType = unknown, TypeType extends
     highestAttack?: number;
     highestDefense?: number;
     cumulativeEvilCrafting: number;
+    cumulativeKilling: number;
     itemDiscovered: ItemType[];
     /** @deprecated (use the entity itself) */
     readonly inventory: IContainer;
@@ -182,8 +183,11 @@ export default abstract class Human<DescriptionType = unknown, TypeType extends
      */
     get lastAttackedByEntityHuman(): Human | undefined;
     getDefense(): PlayerDefense;
+    /** A game options modifier that always returns an empty array by default, to be injected into */
+    getAdditionalGameOptionsSources(): IGameOptionsPartial[];
     getGameOptionsBeforeModifiers(): ImmutableObject<IGameOptionsPlayer>;
     getGameOptions(): ImmutableObject<IGameOptionsPlayer>;
+    clearGameOptionsCache(): void;
     setOptions(options: IOptions): void;
     getEquipEffect<E extends EquipEffect>(type: E): FirstIfOne<EquipEffectByType<E>>;
     /**

package/definitions/game/game/island/Island.d.ts

@@ -97,6 +97,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     biomeOptions?: unknown;
     biomeType: BiomeTypes;
     contaminatedWater: IWaterContamination[];
+    curse: Curse;
     lastPlayerGameTimeTicks?: number;
     loadCount: number;
     name?: string;
@@ -106,7 +107,6 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     readonly wellData: SaferNumberIndexedObject<IWell>;
     referenceId?: number;
     tileContainers: ITileContainer[];
-    curse: Curse;
     tileData: SaferNumberIndexedObject<SaferNumberIndexedObject<SaferNumberIndexedObject<ITileData[]>>>;
     readonly seeds: ISeeds;
     get mapGenVersionInfo(): Version.Info;
@@ -174,9 +174,11 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
      */
     private deactivate;
     private gameOptionsCached?;
+    private gameOptionsWithoutModifiersCached?;
     /** A game options modifier that always returns an empty array by default, to be injected into */
     getAdditionalGameOptionsSources(): IGameOptionsPartial[];
     getGameOptions(): ImmutableObject<IGameOptions>;
+    getGameOptionsWithoutModifiers(): ImmutableObject<IGameOptions>;
     clearGameOptionsCache(): void;
     rename(human: Human, newName: string): void;
     private generatedName?;

package/definitions/game/game/options/modifiers/milestone/modifiers/Exsanguinated.d.ts

@@ -24,7 +24,7 @@ import type { IGameOptionsPartial, IGameOptionsStatus } from "@wayward/game/game
 import MilestoneModifier, { MilestoneModifierInstance } from "@wayward/game/game/options/modifiers/milestone/MilestoneModifier";
 import { MilestoneModifierGroup } from "@wayward/game/game/options/modifiers/milestone/IMilestoneModifier";
 import type { TranslationArg } from "@wayward/game/language/ITranslation";
-import type { IInjectionApi } from "@wayward/utilities/class/Inject";
+import type { IInjectionApi } from "@wayward/game/utilities/Inject";
 export default class Exsanguinated extends MilestoneModifier {
     getOptions(): IGameOptionsPartial;
     getTranslationArgs(): TranslationArg[] | undefined;

package/definitions/game/language/Dictionary.d.ts

@@ -34,7 +34,7 @@ declare enum Dictionary {
     Creature = 22,
     CurseComponent = 23,
     CurseEvent = 24,
-    CurseEventCategory = 25,
+    CurseEventGroup = 25,
     DamageType = 26,
     Deity = 27,
     DeitySymbol = 28,

package/definitions/game/language/DictionaryMap.d.ts

@@ -11,7 +11,7 @@
 import { Command } from "@wayward/game/command/ICommand";
 import { Quality } from "@wayward/game/game/IObject";
 import { BiomeType } from "@wayward/game/game/biome/IBiome";
-import { CurseCategory, CurseComponent, CurseEventType } from "@wayward/game/game/curse/ICurse";
+import { CurseGroup, CurseComponent, CurseEventType } from "@wayward/game/game/curse/ICurse";
 import Deity from "@wayward/game/game/deity/Deity";
 import { DoodadType, DoodadTypeExtra, DoodadTypeGroup, GrowingStage } from "@wayward/game/game/doodad/IDoodad";
 import { CombatDangerLevel } from "@wayward/game/game/entity/ICombatStrength";
@@ -125,7 +125,7 @@ declare const dictionaryMap: {
     22: typeof CreatureType;
     23: typeof CurseComponent;
     24: typeof CurseEventType;
-    25: typeof CurseCategory;
+    25: typeof CurseGroup;
     26: typeof DamageType;
     27: typeof Deity;
     28: typeof Deity;
@@ -1959,7 +1959,7 @@ export declare const strictDictionaries: {
     22: typeof CreatureType;
     23: typeof CurseComponent;
     24: typeof CurseEventType;
-    25: typeof CurseCategory;
+    25: typeof CurseGroup;
     26: typeof DamageType;
     27: typeof Deity;
     28: typeof Deity;