@wayward/types 2.13.2-beta.dev.20230605.3 → 2.13.2-beta.dev.20230607.1

package/definitions/game/game/biome/IBiome.d.ts

@@ -8,6 +8,8 @@
  * 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 { WorldZ } from "game/WorldZ";
+import { type FerocityLevelThresholds } from "game/deity/IDeities";
 import type { IBiomeMapGen, MapGenVersions } from "game/mapgen/IMapGen";
 import type { IBiomeTemperature } from "game/temperature/ITemperature";
 import type { TerrainType } from "game/tile/ITerrain";
@@ -21,6 +23,17 @@ export interface IBiomeDescription extends IModdable {
     temperature?: IBiomeTemperature;
     mapGen: MapGenVersions<IBiomeMapGen>;
     fog?: IFogDescription;
+    /**
+     * A record defining maximum thresholds for each ferocity level.
+     *
+     * When a layer's ferocity thresholds are not set, thresholds for `WorldZ.Overworld` are used.
+     * When no thresholds are set *at all*, {@link DEFAULT_FEROCITY_LEVEL_THRESHOLDS} is used.
+     *
+     * The current ferocity level is equivalent to the level with the threshold *closest* to the current alignment value, without exceeding it.
+     *
+     * When no thresholds are applicable, `FerocityLevel.Minimal` is used.
+     */
+    ferocity?: PartialRecord<WorldZ, FerocityLevelThresholds>;
 }
 export interface IFogDescription {
     color: IRGB;

package/definitions/game/game/biome/arid/Arid.d.ts

@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/biome/coastal/Coastal.d.ts

@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/biome/iceCap/IceCap.d.ts

@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/biome/volcanic/Volcanic.d.ts

@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/biome/wetlands/Wetlands.d.ts

@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/deity/IDeities.d.ts

@@ -0,0 +1,58 @@
+export declare enum Deity {
+    Evil = 0,
+    Neutral = 1,
+    Good = 2
+}
+export type RuneChance = [alignment: Deity, chance: number];
+/**
+ * The maximum chance of a rune dropping that can come from the base chance.
+ * IE, given a maxed chance (1.0), that results in an actual 30% chance of a rune dropping.
+ *
+ * The base chance is combined with the piety chance in the rune dropping calculation.
+ */
+export declare const DEITY_RUNE_CHANCE_BASE_MAX = 0.3;
+/**
+ * The maximum chance of a rune dropping that can come from the Piety skill.
+ * IE, if the skill is at 100%, that results in an actual 30% chance of a rune dropping.
+ *
+ * The piety chance is combined with the base chance in the rune dropping calculation.
+ */
+export declare const DEITY_RUNE_CHANCE_PIETY_MAX = 0.3;
+/**
+ * The chance that a rune drop is replaced with a neutral rune drop.
+ */
+export declare const DEITY_RUNE_CHANCE_NEUTRAL = 0.1;
+/**
+ * The range of evil alignment gained per night between at start and once it's ramped up.
+ */
+export declare const DEITY_ALIGNMENT_EVIL_NIGHTLY_RAMP_RANGE: import("utilities/math/Range").IRange;
+/**
+ * The number of days it takes for nightly evil alignment to fully ramp up.
+ */
+export declare const DEITY_ALIGNMENT_EVIL_NIGHTLY_RAMP_TIME = 10;
+export declare enum DeityAlignmentLevel {
+    Neutral = 0,
+    AlignedTo = 1,
+    ReverentTo = 2,
+    AcolyteOf = 3,
+    DevotedTo = 4,
+    ZealotOf = 5
+}
+export declare enum FerocityLevel {
+    Minimal = 0,
+    Low = 1,
+    Moderate = 2,
+    High = 3,
+    VeryHigh = 4,
+    Nightmare = 5
+}
+/**
+ *
+ * A record defining maximum thresholds for each alignment danger level.
+ *
+ * The current danger level is the first level above the current alignment value.
+ *
+ * When no thresholds are applicable, `AlignmentDangerLevel.Minimal` is used.
+ */
+export type FerocityLevelThresholds = Record<Exclude<FerocityLevel, FerocityLevel.Minimal>, number>;
+export declare const DEFAULT_FEROCITY_LEVEL_THRESHOLDS: FerocityLevelThresholds;

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

@@ -12,6 +12,7 @@ import type { SfxType } from "audio/IAudio";
 import EventEmitter from "event/EventEmitter";
 import type { TileUpdateType } from "game/IGame";
 import { FireType } from "game/IGame";
+import type { WorldZ } from "game/WorldZ";
 import type Doodad from "game/doodad/Doodad";
 import type EntityMovable from "game/entity/EntityMovable";
 import type EntityWithStats from "game/entity/EntityWithStats";
@@ -45,7 +46,7 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
     renamed?: string | ISerializedTranslation;
     x: number;
     y: number;
-    z: number;
+    z: WorldZ;
     private _data?;
     private _tags?;
     islandId: IslandId;

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

@@ -61,17 +61,17 @@ export interface IStatChangeInfo<T = any> {
     important?: boolean;
 }
 export declare module IStatChangeInfo {
-    /**
-     * Creates a stat change info object
-     * @param important Marked as "important" if true
-     */
-    function get<T = any>(important: boolean): IStatChangeInfo<T>;
     /**
      * Creates a stat change info object
      * @param reasonOrInfo A `StatChangeReason`, or an already created `IStatChangeInfo` object.
      * @param important Whether this change should be marked as important
      */
     function get<T = any>(reasonOrInfo: StatChangeReason | IStatChangeInfo, important?: boolean): IStatChangeInfo<T>;
+    /**
+     * Creates a stat change info object
+     * @param important Marked as "important" if true
+     */
+    function get<T = any>(important: boolean): IStatChangeInfo<T>;
 }
 export declare enum StatusType {
     Bleeding = 0,

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

@@ -311,11 +311,21 @@ export declare const EQUIP_SLOTS_FREE: EquipType[];
 export declare const EQUIP_SLOT_ITEM_GROUPS: Record<EquipType, ItemTypeGroup | undefined>;
 export declare const equipmentRenderOrder: EquipType[];
 export type InsulationWeight = number | [number, "onlyWhenEquipped"];
-export declare const equipSlotInsulationWeights: Record<TempType, Record<EquipType, InsulationWeight>>;
+export declare const equipSlotInsulationWeights: Record<TempType, PartialRecord<EquipType, InsulationWeight>>;
 export interface IExcludedWhenLowering {
     excludeIfLowering: true;
 }
-export declare function calculateEquipSlotInsulation(type: TempType, slot: EquipType, equipped?: Item): [number, number, IExcludedWhenLowering | undefined];
+/**
+ * @param weight The weight of this slot in the calculation. Compare this number to the weights of other slots.
+ * @param insulation The insulation value of the item in this slot.
+ * @param excluded Whether this slot's insulation should be excluded if it lowers the resulting insulation value.
+ */
+export type CalculatedEquipSlotInsulation = [
+    weight: number,
+    insulation: number,
+    excluded?: IExcludedWhenLowering
+];
+export declare function calculateEquipSlotInsulation(type: TempType, slot: EquipType, equipped?: Item): CalculatedEquipSlotInsulation;
 export declare const insulationRangeWhenSwimming: Record<TempType, IRange>;
 export declare enum HairColor {
     "#e7c978" = 0,

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

@@ -0,0 +1,38 @@
+/*!
+ * Copyright 2011-2023 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 type Human from "game/entity/Human";
+import { Stat } from "game/entity/IStats";
+export interface IStatGainInfo {
+    amount?: number;
+}
+export interface IStatDescription {
+    /**
+     * A multiplier for stat gain
+     */
+    gainMultiplier?: number;
+    /**
+     * When a human "gains" stat (ie from skill use), if this method is defined, it will be called.
+     * @param human The human that "gains" stat
+     * @param gainAmount The amount to gain. This will usually be 1. You should respect this if possible.
+     * @returns Whether the stat was truly gained
+     *
+     * **Note:** When implementing this, it is recommended to use
+     */
+    gain?(human: Human, gainAmount: number): boolean;
+    /**
+     * When a human performs an action that has a chance of raising a stat, the chance is `1 / getGainChanceOffset()`
+     *
+     * When `getGainChanceOffset` is not implemented, the stat max will be used instead.
+     * When the stat is not an `IStatMax`, the current value will be used instead.
+     */
+    getGainChanceOffset?(human: Human, defaultGainChanceOffset: number): number;
+}
+export declare const statDescriptions: PartialRecord<Stat, IStatDescription>;

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

@@ -52,7 +52,7 @@ export default class Stats<T extends IStatHost> {
     /**
      * Returns the value of the given stat, or `undefined` if the stat does not exist. Stat bonus is *not* applied.
      */
-    getBaseValue(stat: Stat | IStat): number | undefined;
+    getBaseValue(stat: Stat | IStat, allowFailure?: boolean): number | undefined;
     /**
      * Sets the given `Stat`'s value to the given amount. Assumes the given value includes any bonus. Triggers `statChange`
      * @param stat The `Stat` to set.
@@ -110,7 +110,7 @@ export default class Stats<T extends IStatHost> {
     /**
      * Returns the `max` of the given stat, or undefined if the stat isn't an `IStatMax`. Stat bonus is *not* applied.
      */
-    getBaseMax(stat: Stat | IStat): number | undefined;
+    getBaseMax(stat: Stat | IStat, allowFailure?: boolean): number | undefined;
     /**
      * Sets the given `Stat`'s `max` to the given amount. Triggers `statMaxChange`
      * @param stat The `Stat` to set.

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

@@ -10,8 +10,10 @@
  */
 import { Action } from "game/entity/action/Action";
 import { ActionArgument } from "game/entity/action/IAction";
+import type Human from "game/entity/Human";
 import { Direction } from "utilities/math/Direction";
-declare const _default: Action<[ActionArgument.Direction, [ActionArgument.Integer32, ActionArgument.Undefined]], import("../../Human").default<number>, void, {
+declare const _default: Action<[ActionArgument.Direction, [ActionArgument.Integer32, ActionArgument.Undefined]], Human<number>, void, {
     usable: true;
 }, [Direction.None | Direction.East | Direction.North | Direction.West | Direction.South, (number | undefined)?]>;
 export default _default;
+export declare function UpdateDirectionInternal(human: Human, direction: Direction.Cardinal): void;

package/definitions/game/game/inspection/InfoProvider.d.ts

@@ -78,10 +78,10 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
     static create(...translations: TranslationGenerator[]): SimpleInfoProvider;
     static dynamic<T>(observer: InfoProvider.Observer<T>, supplier: (value: T) => InfoProvider | undefined): SimpleInfoProvider;
     static of(...classes: string[]): SimpleInfoProvider;
-    static title(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
-    static subtitle(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
-    static description(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
-    static text(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
+    static title(...translations: Array<InfoProvider | TranslationGenerator | undefined>): SimpleInfoProvider;
+    static subtitle(...translations: Array<InfoProvider | TranslationGenerator | undefined>): SimpleInfoProvider;
+    static description(...translations: Array<InfoProvider | TranslationGenerator | undefined>): SimpleInfoProvider;
+    static text(...translations: Array<InfoProvider | TranslationGenerator | undefined>): SimpleInfoProvider;
     static list(...translations: Array<InfoProvider | TranslationGenerator | undefined>): SimpleInfoProvider;
     static ofComponent(componentSupplier: () => Component): InfoProvider;
     private displayLevel?;
@@ -109,21 +109,21 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
     /**
      * Marks this info provider as to subscribe refresh events to the given host.
      * Note: Any existing initialized components will not be retroactively subscribed.
-     * @param predicate A predicate function for whether or not this info provider should actually refresh when the event is hit
      */
-    subscribeRefreshOn<E extends EmitterOrBus, K extends Event<E>>(emitterOrBus: E, ...args: [...events: K[], predicate: (...params: Parameters<Handler<E, K>>) => boolean]): this;
+    subscribeRefreshOn<E extends EmitterOrBus>(emitterOrBus: E, ...events: Array<Event<E>>): this;
+    subscribeRefreshOn<E extends Emitter, K extends Event<E>>(emitter: WeakRef<E>, ...events: Array<Event<E>>): this;
     /**
      * Marks this info provider as to subscribe refresh events to the given host.
      * Note: Any existing initialized components will not be retroactively subscribed.
-     * @param observer An observer that will only trigger a refresh if the value has changed
+     * @param predicate A predicate function for whether or not this info provider should actually refresh when the event is hit
      */
-    subscribeRefreshOn<E extends EmitterOrBus, K extends Event<E>>(emitterOrBus: E, ...args: [...events: K[], observer: InfoProvider.Observer<any>]): this;
+    subscribeRefreshOn<E extends EmitterOrBus, K extends Event<E>>(emitterOrBus: E, ...args: [...events: K[], predicate: (...params: Parameters<Handler<E, K>>) => boolean]): this;
     /**
      * Marks this info provider as to subscribe refresh events to the given host.
      * Note: Any existing initialized components will not be retroactively subscribed.
+     * @param observer An observer that will only trigger a refresh if the value has changed
      */
-    subscribeRefreshOn<E extends EmitterOrBus, K extends Event<E>>(emitterOrBus: E, ...events: K[]): this;
-    subscribeRefreshOn<E extends Emitter, K extends Event<E>>(emitter: WeakRef<E>, ...events: K[]): this;
+    subscribeRefreshOn<E extends EmitterOrBus>(emitterOrBus: E, ...args: [...events: Array<Event<E>>, observer: InfoProvider.Observer<any>]): this;
     /**
      * Call when this info provider should be refreshed.
      */

package/definitions/game/game/inspection/infoProviders/stat/AttackInfo.d.ts

@@ -8,12 +8,9 @@
  * 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 Human from "game/entity/Human";
-import { InfoProvider } from "game/inspection/InfoProvider";
 import LabelledValue from "game/inspection/infoProviders/LabelledValue";
-export default class AttackInfo extends InfoProvider {
-    private readonly human?;
-    constructor(human?: Human<number> | undefined);
+import { StatInfo } from "game/inspection/infoProviders/stat/StatInfo";
+export default class AttackInfo extends StatInfo {
     getClass(): string[];
     get(): (import("game/inspection/InfoProvider").SimpleInfoProvider | LabelledValue)[];
     private getTactics;

package/definitions/game/game/inspection/infoProviders/stat/DefenseInfo.d.ts

@@ -8,12 +8,9 @@
  * 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 Human from "game/entity/Human";
-import { InfoProvider } from "game/inspection/InfoProvider";
 import LabelledValue from "game/inspection/infoProviders/LabelledValue";
-export default class DefenseInfo extends InfoProvider {
-    private readonly human?;
-    constructor(human?: Human<number> | undefined);
+import { StatInfo } from "game/inspection/infoProviders/stat/StatInfo";
+export default class DefenseInfo extends StatInfo {
     getClass(): string[];
     get(): LabelledValue[];
     private getInsulationSlots;

package/definitions/game/game/inspection/infoProviders/stat/FerocityInfo.d.ts

@@ -0,0 +1,18 @@
+import { Stat } from "game/entity/IStats";
+import type { SimpleInfoProvider } from "game/inspection/InfoProvider";
+import { InfoProvider } from "game/inspection/InfoProvider";
+import LabelledValue from "game/inspection/infoProviders/LabelledValue";
+import { StatInfo } from "game/inspection/infoProviders/stat/StatInfo";
+export default class FerocityInfo extends StatInfo {
+    readonly averageReputation: InfoProvider.Observer<number | undefined>;
+    readonly reputation: InfoProvider.Observer<number>;
+    readonly benignity: InfoProvider.Observer<number>;
+    readonly malignity: InfoProvider.Observer<number>;
+    readonly score: InfoProvider.Observer<number>;
+    readonly civilizationScore: InfoProvider.Observer<number>;
+    readonly turns: InfoProvider.Observer<number>;
+    readonly ticks: InfoProvider.Observer<number>;
+    getTitle(stat: Stat): SimpleInfoProvider;
+    getClass(): string[];
+    get(): (SimpleInfoProvider | LabelledValue)[];
+}

package/definitions/game/game/inspection/infoProviders/stat/StatInfo.d.ts

@@ -0,0 +1,10 @@
+import type Human from "game/entity/Human";
+import type { Stat } from "game/entity/IStats";
+import { InfoProvider } from "game/inspection/InfoProvider";
+export declare abstract class StatInfo extends InfoProvider {
+    static getTitle(stat: Stat): import("game/inspection/InfoProvider").SimpleInfoProvider;
+    private readonly _human;
+    protected get human(): Human<number> | undefined;
+    constructor(human: Human);
+    getTitle(stat: Stat): import("game/inspection/InfoProvider").SimpleInfoProvider;
+}

package/definitions/game/game/inspection/inspections/StatInspection.d.ts

@@ -8,15 +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 Human from "game/entity/Human";
 import { Stat } from "game/entity/IStats";
 import { InspectType } from "game/inspection/IInspection";
-import { InfoProvider } from "game/inspection/InfoProvider";
+import type { InfoProvider } from "game/inspection/InfoProvider";
 import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
 import Inspection from "game/inspection/Inspection";
 import type { TranslationGenerator } from "ui/component/IComponent";
 export default class StatInspection extends Inspection<Stat> {
     static handles: (type: InspectType, value: unknown, context?: InfoProviderContext | undefined) => boolean;
-    private readonly human?;
+    private readonly _human?;
+    protected get human(): Human<number> | undefined;
     constructor([, stat]: [any, Stat], context?: InfoProviderContext);
     getId(): string;
     getBorder(): string;

package/definitions/game/game/temperature/TemperatureManager.d.ts

@@ -59,6 +59,7 @@ export default class TemperatureManager extends EventEmitter.Host<ITemperatureMa
     private temperatureBoundaryMax;
     temperatureBoundaryMaxVector: Vector2;
     constructor(island: Island);
+    clearAll(): void;
     /**
      * Called after the island map size is configured
      */