@wayward/types 2.10.9-beta.dev.20211009.1 → 2.11.0-beta.dev.20211123.4

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

@@ -1,326 +0,0 @@
-/*!
- * 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 { BiomeType } from "game/biome/IBiome";
-import { CreatureType, TileGroup } from "game/entity/creature/ICreature";
-import { AttackType, StatusType } from "game/entity/IEntity";
-import { SkillType } from "game/entity/IHuman";
-import { Stat } from "game/entity/IStats";
-import { Milestone } from "game/milestones/IMilestone";
-import { ThreeStateButtonState } from "ui/component/IThreeStateButton";
-import DefaultMap from "utilities/collection/map/DefaultMap";
-import RandomItem from "utilities/random/generators/RandomItem";
-import RandomRange from "utilities/random/generators/RandomRange";
-import { RecursivePartial } from "utilities/types/Recursive";
-export declare enum GameMode {
-    Hardcore = 0,
-    Casual = 1,
-    Challenge = 2,
-    Custom = 3
-}
-export declare const TIME_ETERNAL_NIGHT = 0.7;
-export declare const TIME_ETERNAL_DAY = 0.3;
-export declare enum TravelingEffectStrategy {
-    AllPlayers = 0,
-    OnlinePlayersOnly = 1,
-    NoPlayers = 2
-}
-export interface IGameOptions {
-    /**
-     * Whether players respawn when they die
-     */
-    respawn: boolean;
-    island: {
-        /**
-         * Biome type for the first island
-         */
-        startingBiomeType: BiomeType;
-        /**
-         * Traveling effect options
-         */
-        applyTravelingEffects: TravelingEffectStrategy;
-    };
-    creatures: {
-        /**
-         * Whether creatures attack when unprovoked
-         */
-        peaceful: boolean;
-        /**
-         * @param On Only aberrants can spawn
-         * @param Off Only non-aberrants can spawn
-         * @param Null Either aberrants or non-aberrants can spawn
-         */
-        aberrantSpawns: ThreeStateButtonState;
-        /**
-         * Custom options for each creature.
-         */
-        creature: DefaultMap<CreatureType, IGameOptionsCreature>;
-        /**
-         * Multiplier for damage of creatures
-         */
-        damageMultiplier: number;
-        /**
-         * Multiplier for health of creatures
-         */
-        healthMultiplier: number;
-        /**
-         * Chance for creature to spawn as scared (uses Random.chance)
-         */
-        chanceToSpawnScared: number;
-        /**
-         * Maximum number of creatures that can spawn in a world
-         */
-        spawnLimit: number;
-    };
-    time: {
-        /**
-         * A number between `0` and `1`, where `0` is the start of the day and `1` is the end.
-         */
-        initial: number;
-        /**
-         * Whether time never passes
-         */
-        frozen: boolean;
-        /**
-         * The number of turns/ticks in a day.
-         */
-        dayLength?: number;
-        /**
-         * A number between `0` and `1` representing how much of the day is "daytime" and how much of the day is "night time".
-         */
-        dayPercent?: number;
-    };
-    rest: {
-        /**
-         * How long to delay before resting begins
-         */
-        startDelay?: number;
-        /**
-         * Delay between rest ticks
-         */
-        tickInterval?: number;
-    };
-    player: IGameOptionsPlayer;
-    npcs: {
-        merchants: {
-            /**
-             * A multiplier for the price of each merchant item.
-             */
-            priceMultiplier: number;
-            /**
-             * The number of items a merchant spawns with.
-             */
-            initialItems: RandomRange[];
-        };
-    };
-    /**
-     * Whether mods should be disabled
-     */
-    disableMods: boolean;
-    milestoneModifiers: Set<Milestone>;
-    items: {
-        /**
-         * Multiplier for decay of items.
-         */
-        decayMultiplier: number;
-    };
-}
-export declare enum UnlockedRecipesStrategy {
-    StartWithNone = 0,
-    UseUnlocks = 1,
-    AllUnlocked = 2
-}
-export interface IGameOptionsPlayer {
-    /**
-     * Whether the player should use their globally unlocked recipes in this game.
-     */
-    unlockedRecipes: UnlockedRecipesStrategy;
-    /**
-     * A map of options for each stat.
-     */
-    stats: DefaultMap<Stat, IGameOptionsStat>;
-    /**
-     * A map of options for each status effect.
-     */
-    statusEffects: DefaultMap<StatusType, IGameOptionsStatusEffect>;
-    skills: {
-        /**
-         * Amount of starting skills the player has (by default, 1 or 0, depending on mode)
-         *
-         * Note: Randomly generated skills can be overwritten by custom options in `skills`.
-         */
-        initial: RandomRange[];
-        /**
-         * Configuration that affects every skill which doesn't have its own configuration.
-         */
-        global: IGameOptionsSkill;
-        /**
-         * Custom options for each skill.
-         */
-        customs: DefaultMap<SkillType, IGameOptionsSkill>;
-    };
-    reputation: {
-        /**
-         * The initial malignity
-         */
-        initialMalignity: number;
-        /**
-         * The initial benignity
-         */
-        initialBenignity: number;
-        /**
-         * The rate at which malignity is gained
-         */
-        malignityMultiplier: number;
-        /**
-         * The rate at which benignity is gained
-         */
-        benignityMultiplier: number;
-    };
-    inventory: {
-        /**
-         * - Set to `false` to disable initial items
-         * - Set to `true` to randomly generate initial items
-         */
-        randomItems: boolean;
-        /**
-         * An additional set of items the player should spawn with.
-         */
-        additionalItems: RandomItem[];
-        /**
-         * An additional set of items the player should spawn with that should be equipped.
-         */
-        equipment: Array<{
-            type: RandomItem;
-            priority?: number;
-        }>;
-    };
-    crafting: {
-        /**
-         * A multiplier for the durability of each item.
-         */
-        durabilityMultiplier: number;
-        /**
-         * A multiplier for the difficulty of each level of craft.
-         * TODO: Set to Map<RecipeLevel, number> when we can support maps in milestone modifier overrides?
-         */
-        difficultyMultiplier: number;
-    };
-    actions: {
-        /**
-         * Guardians to attempt to spawn after successful lockpicks.
-         */
-        additionalGuardiansSpawnedOnLockpick: number;
-    };
-    damage: {
-        /**
-         * Add player damage multiplier based on attack type (used within Attack action).
-         */
-        attackMultiplier: DefaultMap<AttackType, number>;
-        /**
-         * Add player damage multiplier based on attack type (used within Attack action).
-         */
-        trapMultiplier: number;
-    };
-}
-/**
- * "Partial" difficulty options; used to apply options over top base options. Milestone modifiers can never exist on partial difficulty options.
- */
-export declare type IGameOptionsPartial = RecursivePartial<IGameOptions> & {
-    milestoneModifiers?: never;
-};
-export interface IGameOptionsStat {
-    /**
-     * If the given value is a decimanl number less than or equal to `1`, sets the stat value to a percentage of the max.
-     * Otherwise, sets the stat to the given value.
-     */
-    initialValue?: number;
-    /**
-     * The max value of the stat, or `undefined` if it should be generated randomly
-     */
-    maxValue?: number;
-    /**
-     * A float or number to multiply against the maxValue after being generated randomly or set via custom options.
-     * Used specifically for milestone modifiers currently.
-     */
-    maxValueMultiplier?: number;
-    /**
-     * A multiplier for the speed at which the stat changes `1` is "default", `0` is "none", `2` is "two times speed"
-     */
-    changeTimerMultiplier: number;
-    /**
-     * A bonus value to apply to the stat.
-     */
-    bonus?: number;
-    /**
-     * The number that stats increase by each gain. By default, this is "1".
-     */
-    gainAmount: number;
-}
-export interface IGameOptionsStatusEffect {
-    /**
-     * Whether every player starts with this status effect.
-     */
-    startWith: boolean;
-    /**
-     * Whether this status effect is untreatable (IE: it must pass naturally)
-     */
-    untreatable: boolean;
-    /**
-     * A multiplier for the chance of this status effect to be passed each turn.
-     */
-    passChanceMultiplier: number;
-    /**
-     * A multiplier for the number of ticks between effect ticks.
-     */
-    effectRateMultiplier: number;
-    /**
-     * Decrease or increase the effect of the... effect.
-     */
-    effectMultiplier: number;
-}
-export interface IGameOptionsSkill {
-    /**
-     * The initial value of this skill.
-     */
-    initial?: number;
-    /**
-     * A multiplier for how fast the skill is gained.
-     */
-    gainMultiplier: number;
-}
-export interface IGameOptionsCreature {
-    /**
-     * Can spawn at all.
-     */
-    allowSpawning: boolean;
-    /**
-     * @param On Only aberrants can spawn
-     * @param Off Only non-aberrants can spawn
-     * @param Null Either aberrants or non-aberrants can spawn
-     */
-    aberrantSpawns: ThreeStateButtonState;
-    /**
-     * A multiplier for the chance of this creature executing a special attack.
-     */
-    specialAttackChanceMultiplier: number;
-    /**
-     * Chance for creature to spawn as tamed (uses Random.chance)
-     */
-    chanceToSpawnTamed: number;
-    /**
-     * Forces the creature to always be present in the spawn pool, overwriting allowSpawning.
-     */
-    alwaysSpawn: boolean;
-    /**
-     * Modifies the tiles the creature can spawn on.
-     */
-    spawnTiles: TileGroup;
-}

package/definitions/game/options/modifiers/GameplayModifier.d.ts

@@ -1,30 +0,0 @@
-/*!
- * 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 Entity from "game/entity/Entity";
-import { IHasImagePath } from "game/IObject";
-import { IGameOptionsPartial } from "game/options/IGameOptions";
-import { RandomInstance } from "utilities/random/Random";
-export default abstract class GameplayModifier<ID extends number> implements IHasImagePath {
-    readonly id: ID;
-    readonly random: RandomInstance;
-    readonly imagePath?: string;
-    /**
-     * Game options to be applied when this modifier is active
-     */
-    protected readonly options?: IGameOptionsPartial | (() => IGameOptionsPartial);
-    private cachedOptions?;
-    constructor(id: ID, random?: RandomInstance);
-    initialize(): void;
-    uninitialize(): void;
-    getOptions(resolve?: boolean): IGameOptionsPartial | undefined;
-    isEnabledForPlayer(_entity: Entity): boolean;
-    getRandom(): import("utilities/random/Random").Random<import("utilities/random/Random").SeededGenerator>;
-}

package/definitions/game/options/modifiers/GameplayModifiersManager.d.ts

@@ -1,30 +0,0 @@
-/*!
- * 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 GameplayModifier from "game/options/modifiers/GameplayModifier";
-export default class GameplayModifiersManager<ID extends number, MODIFIER extends GameplayModifier<ID>> {
-    private readonly enumObject;
-    private readonly classes;
-    private _instances;
-    protected get instances(): Map<ID, MODIFIER>;
-    constructor(enumObject: any, classes: OptionalDescriptions<ID, Class<MODIFIER, [ID]>>);
-    getImage(id: ID): string | undefined;
-    getModifierInstance(id: ID): MODIFIER | undefined;
-    createCollection(): GameplayModifiersCollection<ID, MODIFIER>;
-}
-export declare class GameplayModifiersCollection<ID extends number, MODIFIER extends GameplayModifier<ID>> {
-    private readonly manager;
-    protected readonly initializedModifiers: Map<ID, MODIFIER>;
-    constructor(manager: GameplayModifiersManager<ID, MODIFIER>);
-    initialize(...ids: ID[]): void;
-    uninitialize(): void;
-    options(): import("@wayward/goodstream/Stream").default<import("../IGameOptions").IGameOptionsPartial>;
-    initialized(): IterableIterator<ID>;
-}

package/definitions/game/options/modifiers/challenge/ChallengeModifier.d.ts

@@ -1,25 +0,0 @@
-/*!
- * 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 { Challenge } from "game/options/modifiers/challenge/IChallenge";
-import GameplayModifier from "game/options/modifiers/GameplayModifier";
-import { ITooltip } from "ui/component/IComponent";
-export default abstract class ChallengeModifier extends GameplayModifier<Challenge> {
-    /**
-     * How often this modifier should be chosen compared to the others
-     */
-    readonly weight: number;
-    /**
-     * How much "challenge" this modifier adds (or subtracts!). Defaults to `0`. Added to the result of `apply`.
-     */
-    challenge: number;
-    tooltipArgs?: readonly any[];
-    readonly getTooltip: (tooltip: ITooltip) => ITooltip;
-}

package/definitions/game/options/modifiers/challenge/ChallengeModifiers.d.ts

@@ -1,24 +0,0 @@
-/*!
- * 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 ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-import { Challenge } from "game/options/modifiers/challenge/IChallenge";
-import GameplayModifiersManager, { GameplayModifiersCollection } from "game/options/modifiers/GameplayModifiersManager";
-import { ITooltip } from "ui/component/IComponent";
-export declare const EXCLUSIVE_MODIFIERS: Challenge[][];
-declare class ChallengeModifiersManager extends GameplayModifiersManager<Challenge, ChallengeModifier> {
-    constructor();
-    createCollection(seed?: number): ChallengeModifiersCollection;
-}
-declare const _default: ChallengeModifiersManager;
-export default _default;
-export declare class ChallengeModifiersCollection extends GameplayModifiersCollection<Challenge, ChallengeModifier> {
-    getTooltip(challenge: Challenge, tooltip: ITooltip): ITooltip;
-}

package/definitions/game/options/modifiers/challenge/IChallenge.d.ts

@@ -1,29 +0,0 @@
-/*!
- * 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 { StatusType } from "game/entity/IEntity";
-import { IGameOptionsPlayer } from "game/options/IGameOptions";
-export declare enum Challenge {
-    NoHealthRegeneration = 0,
-    NoStaminaRegeneration = 1,
-    EternalNight = 2,
-    ThirstRate = 3,
-    HungerRate = 4,
-    PermanentlyBleeding = 5,
-    PermanentlyBurning = 6,
-    PermanentlyPoisoned = 7,
-    NoStartingItems = 8,
-    StartingMalignity = 9,
-    BenignityRate = 10,
-    MalignityRate = 11
-}
-export declare function isPermanentEffect(effect: StatusType, options: IGameOptionsPlayer): boolean;
-export declare function isEternal(time: number): (options?: import("game/options/IGameOptions").IGameOptions) => boolean;
-export declare function getMultiplierChallengeValue(multiplier: number, value?: number): number;

package/definitions/game/options/modifiers/challenge/modifiers/BenignityRate.d.ts

@@ -1,21 +0,0 @@
-/*!
- * 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 ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class BenignityRate extends ChallengeModifier {
-    readonly weight = 0.25;
-    readonly options: () => {
-        player: {
-            reputation: {
-                benignityMultiplier: number;
-            };
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/EternalNight.d.ts

@@ -1,29 +0,0 @@
-/*!
- * 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 ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-import RandomItem from "utilities/random/generators/RandomItem";
-export default class EternalNight extends ChallengeModifier {
-    readonly weight = 0.5;
-    readonly challenge = 150;
-    readonly options: {
-        time: {
-            frozen: boolean;
-            initial: number;
-        };
-        player: {
-            inventory: {
-                equipment: {
-                    type: RandomItem;
-                }[];
-            };
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/HungerRate.d.ts

@@ -1,22 +0,0 @@
-/*!
- * 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 { Stat } from "game/entity/IStats";
-import ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class HungerRate extends ChallengeModifier {
-    readonly weight = 1;
-    readonly options: () => {
-        player: {
-            stats: Map<Stat, {
-                changeTimerMultiplier: number;
-            }>;
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/MalignityRate.d.ts

@@ -1,21 +0,0 @@
-/*!
- * 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 ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class MalignityRate extends ChallengeModifier {
-    readonly weight = 1;
-    readonly options: () => {
-        player: {
-            reputation: {
-                malignityMultiplier: number;
-            };
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/NoHealthRegeneration.d.ts

@@ -1,23 +0,0 @@
-/*!
- * 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 { Stat } from "game/entity/IStats";
-import ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class NoHealthRegeneration extends ChallengeModifier {
-    readonly weight = 1;
-    readonly challenge = 100;
-    readonly options: {
-        player: {
-            stats: Map<Stat, {
-                changeTimerMultiplier: number;
-            }>;
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/NoStaminaRegeneration.d.ts

@@ -1,26 +0,0 @@
-/*!
- * 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 { Stat } from "game/entity/IStats";
-import ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class NoStaminaRegeneration extends ChallengeModifier {
-    readonly weight = 0.75;
-    readonly challenge = 200;
-    readonly options: {
-        player: {
-            stats: Map<Stat, {
-                changeTimerMultiplier: number;
-            }>;
-            inventory: {
-                additionalItems: any[];
-            };
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/NoStartingItems.d.ts

@@ -1,22 +0,0 @@
-/*!
- * 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 ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class NoStartingItems extends ChallengeModifier {
-    readonly weight = 0.75;
-    readonly challenge = 50;
-    readonly options: {
-        player: {
-            inventory: {
-                randomItems: boolean;
-            };
-        };
-    };
-}

package/definitions/game/options/modifiers/challenge/modifiers/PermanentlyBleeding.d.ts

@@ -1,27 +0,0 @@
-/*!
- * 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 { StatusType } from "game/entity/IEntity";
-import ChallengeModifier from "game/options/modifiers/challenge/ChallengeModifier";
-export default class PermanentlyBleeding extends ChallengeModifier {
-    readonly weight = 0.5;
-    readonly challenge = 300;
-    readonly options: {
-        player: {
-            statusEffects: Map<StatusType, {
-                startWith: boolean;
-                passChanceMultiplier: number;
-                untreatable: boolean;
-                effectMultiplier: number;
-                effectRateMultiplier: number;
-            }>;
-        };
-    };
-}