@wayward/types 2.11.3-beta.dev.20220123.2 → 2.11.4-beta

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

@@ -1,174 +1,174 @@
-/*!
- * Copyright 2011-2021 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 { IStatChangeInfo } from "game/entity/IEntity";
-import type { StatChangeTimerFactory } from "game/entity/StatFactory";
-export declare enum Stat {
-    Health = 0,
-    Stamina = 1,
-    Hunger = 2,
-    Thirst = 3,
-    Weight = 4,
-    Attack = 5,
-    /**
-     * Positive reputation
-     */
-    Benignity = 6,
-    /**
-     * Negative reputation
-     */
-    Malignity = 7,
-    /**
-     * The base defense of the player.
-     * UI only. Does not exist on `Player` instances.
-     */
-    Defense = 8,
-    /**
-     * A combination of `Stat.Benignity` + `Stat.Malignity`
-     * UI only. Does not exist on `Player` instances.
-     */
-    Reputation = 9,
-    /**
-     * A combination of `Stat.Hunger` + `Stat.Thirst`
-     * Does not exist on `Player` instances. Used for magical items.
-     */
-    Metabolism = 10,
-    /**
-     * Used to calculate the max weight & max health of the player.
-     */
-    Strength = 11,
-    /**
-     * How much this human and their inventory is affected by temperature
-     */
-    InsulationHeat = 12,
-    InsulationCold = 13,
-    /**
-     * Used for chicken eggs and goat milk
-     */
-    Produce = 14,
-    /**
-     * Used for tamed animals
-     */
-    Happiness = 15,
-    Tamed = 16,
-    Petting = 17,
-    Waste = 18
-}
-export declare type IStats = {
-    [key in keyof typeof Stat]: IStat;
-};
-export declare const SYMBOL_STAT_TYPE: unique symbol;
-export interface IStatBase {
-    readonly [SYMBOL_STAT_TYPE]: Stat;
-    readonly type: Stat;
-    readonly value: number;
-    readonly max: number | undefined;
-    /**
-     * If set to `true`, when the `value` changes it isn't clamped to the `max`.
-     * EG: `max` in this case will usually only be useful visually
-     */
-    canExceedMax?: true;
-    /**
-     * The number of turns remaining until the stat changes.
-     */
-    changeTimer: number | undefined;
-    /**
-     * The value `changeTimer` will be reset to when it reaches `0`.
-     */
-    readonly nextChangeTimer: number | undefined;
-    /**
-     * The amount the value should change by when the `changeTimer` reaches `0`.
-     * When not provided, defaults to `1`.
-     */
-    changeAmount?: number;
-    /**
-     * The speed the change timer decreases. When `undefined`, `1` is used.
-     */
-    changeTimerSpeed?: number;
-    /**
-     * A bonus value added to be added to `max` and `value`.
-     */
-    bonus?: number;
-}
-export interface IStatMax extends IStatBase {
-    readonly max: number;
-}
-export interface IStatChanging extends IStatBase {
-    changeAmount: number;
-    changeTimer: number;
-    readonly nextChangeTimer: number;
-    changeTimerSpeed?: number;
-}
-export interface IStatBonus extends IStatBase {
-    bonus: number;
-}
-export declare type IStat = IStatBase | IStatMax | IStatChanging | IStatBonus;
-export declare enum StatDisplayType {
-    /**
-     * Do not display this stat
-     */
-    None = 0,
-    /**
-     * Allow implementation to decide the display type automatically
-     */
-    Auto = 1,
-    /**
-     * Display as an attribute
-     */
-    Attribute = 2,
-    /**
-     * Display as a statbar
-     */
-    Statbar = 3
-}
-export interface IStatFactory {
-    get(): IStat;
-}
-export interface IStatEvents {
-    /**
-     * Called when a stat changes, for any reason
-     * @param stat An IStat object, the stat that was affected
-     * @param oldValue The value that the stat changed from
-     * @param info An IStatChangeInfo object describing why the change occurred. It will always be passed with a `reason`
-     */
-    statChanged(stat: IStat, oldValue: number, info: IStatChangeInfo): void;
-    /**
-     * Called when a stat timer changes
-     * @param stat An IStat object, the stat that was affected
-     * @param oldValue The value that the stat changed from
-     */
-    statTimerChanged(stat: IStat, oldValue?: number): void;
-    /**
-     * Called when a stat timer will change
-     * @param stat An `IStat` object, the stat that will be affected
-     * @param changeFactory An object for manipulating how the new stat change timer will be set
-     * @returns `false` to cancel the stat timer change, `undefined` otherwise.
-     */
-    statTimerWillChange(stat: IStat, changeFactory: StatChangeTimerFactory): false | undefined;
-    /**
-     * Called when a stat timer is removed
-     * @param stat An `IStat` object, the stat that was affected
-     */
-    statTimerRemoved(stat: IStat): any;
-    /**
-     * Called when a stat's max value changes, for any reason
-     * @param stat An IStat object, the stat that was affected
-     * @param oldValue The value that the stat changed from
-     * @param info An `IStatChangeInfo` object describing why the change occurred. It will always be passed with a `reason`
-     */
-    statMaxChanged(stat: IStatMax, oldValue?: number, info?: IStatChangeInfo): void;
-    /**
-     * Called when a stat changes, for any reason
-     * @param stat An IStat object, the stat that was affected
-     * @param oldValue The value that the stat changed from
-     * @param info An `IStatChangeInfo` object describing why the change occurred. It will always be passed with a `reason`
-     */
-    statBonusChanged(stat: IStat, oldValue?: number, info?: IStatChangeInfo): void;
-}
+/*!
+ * Copyright 2011-2021 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 { IStatChangeInfo } from "game/entity/IEntity";
+import type { StatChangeTimerFactory } from "game/entity/StatFactory";
+export declare enum Stat {
+    Health = 0,
+    Stamina = 1,
+    Hunger = 2,
+    Thirst = 3,
+    Weight = 4,
+    Attack = 5,
+    /**
+     * Positive reputation
+     */
+    Benignity = 6,
+    /**
+     * Negative reputation
+     */
+    Malignity = 7,
+    /**
+     * The base defense of the player.
+     * UI only. Does not exist on `Player` instances.
+     */
+    Defense = 8,
+    /**
+     * A combination of `Stat.Benignity` + `Stat.Malignity`
+     * UI only. Does not exist on `Player` instances.
+     */
+    Reputation = 9,
+    /**
+     * A combination of `Stat.Hunger` + `Stat.Thirst`
+     * Does not exist on `Player` instances. Used for magical items.
+     */
+    Metabolism = 10,
+    /**
+     * Used to calculate the max weight & max health of the player.
+     */
+    Strength = 11,
+    /**
+     * How much this human and their inventory is affected by temperature
+     */
+    InsulationHeat = 12,
+    InsulationCold = 13,
+    /**
+     * Used for chicken eggs and goat milk
+     */
+    Produce = 14,
+    /**
+     * Used for tamed animals
+     */
+    Happiness = 15,
+    Tamed = 16,
+    Petting = 17,
+    Waste = 18
+}
+export declare type IStats = {
+    [key in keyof typeof Stat]: IStat;
+};
+export declare const SYMBOL_STAT_TYPE: unique symbol;
+export interface IStatBase {
+    readonly [SYMBOL_STAT_TYPE]: Stat;
+    readonly type: Stat;
+    readonly value: number;
+    readonly max: number | undefined;
+    /**
+     * If set to `true`, when the `value` changes it isn't clamped to the `max`.
+     * EG: `max` in this case will usually only be useful visually
+     */
+    canExceedMax?: true;
+    /**
+     * The number of turns remaining until the stat changes.
+     */
+    changeTimer: number | undefined;
+    /**
+     * The value `changeTimer` will be reset to when it reaches `0`.
+     */
+    readonly nextChangeTimer: number | undefined;
+    /**
+     * The amount the value should change by when the `changeTimer` reaches `0`.
+     * When not provided, defaults to `1`.
+     */
+    changeAmount?: number;
+    /**
+     * The speed the change timer decreases. When `undefined`, `1` is used.
+     */
+    changeTimerSpeed?: number;
+    /**
+     * A bonus value added to be added to `max` and `value`.
+     */
+    bonus?: number;
+}
+export interface IStatMax extends IStatBase {
+    readonly max: number;
+}
+export interface IStatChanging extends IStatBase {
+    changeAmount: number;
+    changeTimer: number;
+    readonly nextChangeTimer: number;
+    changeTimerSpeed?: number;
+}
+export interface IStatBonus extends IStatBase {
+    bonus: number;
+}
+export declare type IStat = IStatBase | IStatMax | IStatChanging | IStatBonus;
+export declare enum StatDisplayType {
+    /**
+     * Do not display this stat
+     */
+    None = 0,
+    /**
+     * Allow implementation to decide the display type automatically
+     */
+    Auto = 1,
+    /**
+     * Display as an attribute
+     */
+    Attribute = 2,
+    /**
+     * Display as a statbar
+     */
+    Statbar = 3
+}
+export interface IStatFactory {
+    get(): IStat;
+}
+export interface IStatEvents {
+    /**
+     * Called when a stat changes, for any reason
+     * @param stat An IStat object, the stat that was affected
+     * @param oldValue The value that the stat changed from
+     * @param info An IStatChangeInfo object describing why the change occurred. It will always be passed with a `reason`
+     */
+    statChanged(stat: IStat, oldValue: number, info: IStatChangeInfo): void;
+    /**
+     * Called when a stat timer changes
+     * @param stat An IStat object, the stat that was affected
+     * @param oldValue The value that the stat changed from
+     */
+    statTimerChanged(stat: IStat, oldValue?: number): void;
+    /**
+     * Called when a stat timer will change
+     * @param stat An `IStat` object, the stat that will be affected
+     * @param changeFactory An object for manipulating how the new stat change timer will be set
+     * @returns `false` to cancel the stat timer change, `undefined` otherwise.
+     */
+    statTimerWillChange(stat: IStat, changeFactory: StatChangeTimerFactory): false | undefined;
+    /**
+     * Called when a stat timer is removed
+     * @param stat An `IStat` object, the stat that was affected
+     */
+    statTimerRemoved(stat: IStat): any;
+    /**
+     * Called when a stat's max value changes, for any reason
+     * @param stat An IStat object, the stat that was affected
+     * @param oldValue The value that the stat changed from
+     * @param info An `IStatChangeInfo` object describing why the change occurred. It will always be passed with a `reason`
+     */
+    statMaxChanged(stat: IStatMax, oldValue?: number, info?: IStatChangeInfo): void;
+    /**
+     * Called when a stat changes, for any reason
+     * @param stat An IStat object, the stat that was affected
+     * @param oldValue The value that the stat changed from
+     * @param info An `IStatChangeInfo` object describing why the change occurred. It will always be passed with a `reason`
+     */
+    statBonusChanged(stat: IStat, oldValue?: number, info?: IStatChangeInfo): void;
+}

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

@@ -1,136 +1,136 @@
-/*!
- * Copyright 2011-2021 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 { IStat, IStatBase, IStatFactory, IStats } from "game/entity/IStats";
-import { Stat } from "game/entity/IStats";
-import type { IStatHost } from "game/entity/Stats";
-import type Stats from "game/entity/Stats";
-export declare class StatsFactory {
-    private readonly stats;
-    private readonly _host;
-    constructor(host: IStatHost);
-    private get host();
-    /**
-     * If the condition is not falsey, runs the initializer on this factory.
-     */
-    if(condition: any, initializer: (factory: StatsFactory) => any): this;
-    /**
-     * Note: When adding a stat that already exists in this factory, the previous one will be replaced.
-     */
-    add(stat: Stat, initializer?: (factory: StatFactory) => any): this;
-    add(stat: Stat, value?: number, initializer?: (factory: StatFactory) => any): this;
-    get(): IStats;
-}
-declare class StatFactory implements IStatFactory {
-    private readonly host;
-    private readonly result;
-    get stat(): Stat;
-    get value(): number;
-    /**
-     * @param type The `Stat` this factory is building
-     * @param value The starting value of this stat. Defaults to `0`
-     */
-    constructor(host: IStatHost, type: Stat, value?: number);
-    setValue(value: number): this;
-    /**
-     * Sets the max value this stat can be
-     */
-    setMax(max: number, canExceed?: true): this;
-    /**
-     * Sets the stat to change over time.
-     * @param timer The number of turns that should pass before the stat should change.
-     * @param amt The amount the stat should change, whenever the timer completes.
-     *
-     * Stat timers are managed by their parent Entity. Currently, only players support `changeTimer`
-     */
-    setChangeTimer(timer: number, initializer?: (factory: StatChangeTimerFactory) => any): this;
-    /**
-     * Sets the "bonus" for the stat. This changes the value that will be returned.
-     */
-    setBonus(bonus: number): this;
-    get(): IStat;
-}
-export default StatFactory;
-export declare enum StatChangeCurrentTimerStrategy {
-    /**
-     * If the next change timer will be `200`, sets the current change timer to `200`.
-     */
-    Reset = "Reset",
-    /**
-     * If the current change timer is `250`, and the next change timer will be `200`, sets the current change timer to `200`.
-     */
-    Clamp = "Clamp",
-    /**
-     * If the current change timer is `10`, and the next change timer is going from `100` to `200`, sets the current change timer to `110`.
-     */
-    Difference = "Difference",
-    /**
-     * If the current change timer is `10`, and the next change timer is going from `100` to `200`, sets the current change timer to `20`.
-     */
-    Ratio = "Ratio"
-}
-export declare class StatChangeTimerFactory {
-    private timer;
-    private nextTimer;
-    private _canOverride;
-    private amount?;
-    private decayRate?;
-    constructor(timer: number);
-    /**
-     * @returns The strategy for calculating the current change timer given the changes.
-     */
-    getCurrentTimer(): number | StatChangeCurrentTimerStrategy;
-    /**
-     * Sets the strategy for calculating the current change timer given the changes.
-     * @param timer A number to precisely set the current timer, or a `StatChangeCurrentTimerStrategy` to calculate the new value automatically.
-     * See enum for more detail.
-     */
-    setCurrentTimer(timer?: StatChangeCurrentTimerStrategy): this;
-    /**
-     * @returns The next change timer. This value is what the `changeTimer` will be reset to every time it reaches `0`.
-     * If the next change timer is less than or equal to `0`, upon reaching `0`, the change timer will be removed from the stat.
-     */
-    getNextTimer(): number;
-    /**
-     * @param nextTimer The next change timer. This value is what the `changeTimer` will be reset to every time it reaches `0`.
-     * If the next change timer is less than or equal to `0`, upon reaching `0`, the change timer will be removed from the stat.
-     */
-    setNextTimer(nextTimer: number): this;
-    /**
-     * Sets the next change timer to `-1`, which will cause the change timer to be removed from the stat when the timer reaches `0`.
-     */
-    setOnce(): this;
-    /**
-     * @returns The amount the stat will be changed when the change timer completes.
-     */
-    getAmount(): number | undefined;
-    /**
-     * @param amount The amount the stat will be changed when the change timer completes. Defaults to `1`.
-     */
-    setAmount(amount?: number): this;
-    /**
-     * @returns The amount the change timer will be reduced by every tick.
-     */
-    getDecayRate(): number | undefined;
-    /**
-     * @param rate The amount the change timer will be reduced by every tick.
-     */
-    setDecayRate(rate: number): this;
-    /**
-     * @returns Whether this change timer's application is overridable through the `statTimerWillChange` event.
-     */
-    isOverridable(): boolean;
-    /**
-     * @param overridable Whether this change timer's application is overridable through the `statTimerWillChange` event.
-     */
-    setOverridable(overridable?: boolean): this;
-    apply(host: IStatHost, stat: Partial<Mutable<IStatBase>>): void;
-    apply(stats: Stats<IStatHost>, stat: Stat | IStat): void;
-}
+/*!
+ * Copyright 2011-2021 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 { IStat, IStatBase, IStatFactory, IStats } from "game/entity/IStats";
+import { Stat } from "game/entity/IStats";
+import type { IStatHost } from "game/entity/Stats";
+import type Stats from "game/entity/Stats";
+export declare class StatsFactory {
+    private readonly stats;
+    private readonly _host;
+    constructor(host: IStatHost);
+    private get host();
+    /**
+     * If the condition is not falsey, runs the initializer on this factory.
+     */
+    if(condition: any, initializer: (factory: StatsFactory) => any): this;
+    /**
+     * Note: When adding a stat that already exists in this factory, the previous one will be replaced.
+     */
+    add(stat: Stat, initializer?: (factory: StatFactory) => any): this;
+    add(stat: Stat, value?: number, initializer?: (factory: StatFactory) => any): this;
+    get(): IStats;
+}
+declare class StatFactory implements IStatFactory {
+    private readonly host;
+    private readonly result;
+    get stat(): Stat;
+    get value(): number;
+    /**
+     * @param type The `Stat` this factory is building
+     * @param value The starting value of this stat. Defaults to `0`
+     */
+    constructor(host: IStatHost, type: Stat, value?: number);
+    setValue(value: number): this;
+    /**
+     * Sets the max value this stat can be
+     */
+    setMax(max: number, canExceed?: true): this;
+    /**
+     * Sets the stat to change over time.
+     * @param timer The number of turns that should pass before the stat should change.
+     * @param amt The amount the stat should change, whenever the timer completes.
+     *
+     * Stat timers are managed by their parent Entity. Currently, only players support `changeTimer`
+     */
+    setChangeTimer(timer: number, initializer?: (factory: StatChangeTimerFactory) => any): this;
+    /**
+     * Sets the "bonus" for the stat. This changes the value that will be returned.
+     */
+    setBonus(bonus: number): this;
+    get(): IStat;
+}
+export default StatFactory;
+export declare enum StatChangeCurrentTimerStrategy {
+    /**
+     * If the next change timer will be `200`, sets the current change timer to `200`.
+     */
+    Reset = "Reset",
+    /**
+     * If the current change timer is `250`, and the next change timer will be `200`, sets the current change timer to `200`.
+     */
+    Clamp = "Clamp",
+    /**
+     * If the current change timer is `10`, and the next change timer is going from `100` to `200`, sets the current change timer to `110`.
+     */
+    Difference = "Difference",
+    /**
+     * If the current change timer is `10`, and the next change timer is going from `100` to `200`, sets the current change timer to `20`.
+     */
+    Ratio = "Ratio"
+}
+export declare class StatChangeTimerFactory {
+    private timer;
+    private nextTimer;
+    private _canOverride;
+    private amount?;
+    private decayRate?;
+    constructor(timer: number);
+    /**
+     * @returns The strategy for calculating the current change timer given the changes.
+     */
+    getCurrentTimer(): number | StatChangeCurrentTimerStrategy;
+    /**
+     * Sets the strategy for calculating the current change timer given the changes.
+     * @param timer A number to precisely set the current timer, or a `StatChangeCurrentTimerStrategy` to calculate the new value automatically.
+     * See enum for more detail.
+     */
+    setCurrentTimer(timer?: StatChangeCurrentTimerStrategy): this;
+    /**
+     * @returns The next change timer. This value is what the `changeTimer` will be reset to every time it reaches `0`.
+     * If the next change timer is less than or equal to `0`, upon reaching `0`, the change timer will be removed from the stat.
+     */
+    getNextTimer(): number;
+    /**
+     * @param nextTimer The next change timer. This value is what the `changeTimer` will be reset to every time it reaches `0`.
+     * If the next change timer is less than or equal to `0`, upon reaching `0`, the change timer will be removed from the stat.
+     */
+    setNextTimer(nextTimer: number): this;
+    /**
+     * Sets the next change timer to `-1`, which will cause the change timer to be removed from the stat when the timer reaches `0`.
+     */
+    setOnce(): this;
+    /**
+     * @returns The amount the stat will be changed when the change timer completes.
+     */
+    getAmount(): number | undefined;
+    /**
+     * @param amount The amount the stat will be changed when the change timer completes. Defaults to `1`.
+     */
+    setAmount(amount?: number): this;
+    /**
+     * @returns The amount the change timer will be reduced by every tick.
+     */
+    getDecayRate(): number | undefined;
+    /**
+     * @param rate The amount the change timer will be reduced by every tick.
+     */
+    setDecayRate(rate: number): this;
+    /**
+     * @returns Whether this change timer's application is overridable through the `statTimerWillChange` event.
+     */
+    isOverridable(): boolean;
+    /**
+     * @param overridable Whether this change timer's application is overridable through the `statTimerWillChange` event.
+     */
+    setOverridable(overridable?: boolean): this;
+    apply(host: IStatHost, stat: Partial<Mutable<IStatBase>>): void;
+    apply(stats: Stats<IStatHost>, stat: Stat | IStat): void;
+}