@wayward/types 2.13.0-beta.dev.20230425.1 → 2.13.0-beta.dev.20230427.1

package/definitions/game/event/EventEmitter.d.ts

@@ -71,8 +71,10 @@ export interface IUntilSubscriber<H, E> {
 }
 declare class EventEmitter<H, E> {
     private readonly host;
+    static RECORD_MODE: boolean;
     private readonly hostClass;
     private readonly subscriptions;
+    private readonly subscriptionsRecord;
     private readonly cachedEmitSelfHandlers;
     constructor(host: H);
     raw(): IEventEmitter<H, E>;

package/definitions/game/game/IObject.d.ts

@@ -38,11 +38,11 @@ export interface IObjectDescription extends IHasImagePath {
     preservationChance?: number;
     spawnOnWorldGen?: OptionalDescriptions<BiomeType, OptionalDescriptions<WorldZ, OptionalDescriptions<TerrainType, number>>>;
 }
-export interface IHasImagePath {
+export interface IHasImagePath<ImagePathType = string> {
     /**
      * A replacement image to use. Used in modding.
      */
-    imagePath?: string;
+    imagePath?: ImagePathType;
     /**
      * The number of alternate textures that this image has. Not supported for most things.
      */

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

@@ -26,6 +26,7 @@ import { PlayerState, TurnTypeFlag, WeightStatus } from "game/entity/player/IPla
 import type { INoteManager } from "game/entity/player/note/NoteManager";
 import PlayerDefense from "game/entity/player/PlayerDefense";
 import type { IQuestManager } from "game/entity/player/quest/QuestManager";
+import type { ISkillAttribute } from "game/entity/skill/ISkills";
 import SkillManager from "game/entity/skill/SkillManager";
 import type { StatChangeTimerFactory } from "game/entity/StatFactory";
 import { StatChangeCurrentTimerStrategy } from "game/entity/StatFactory";
@@ -350,7 +351,7 @@ export default abstract class Human<TypeType extends number = number> extends En
     /**
      * Improve one of the core player stats
      */
-    protected statGain(stat: Stat, bypass: boolean): void;
+    protected statGain(stat: Stat | ISkillAttribute, bypass: boolean): void;
     protected calculateStats(): void;
     kill(): void;
     protected resetDefense(skipStatChangedEvent?: boolean): void;

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

@@ -15,6 +15,7 @@ import type Human from "game/entity/Human";
 import { AttackType } from "game/entity/IEntity";
 import { SkillType } from "game/entity/IHuman";
 import type { IItemDescription, IRanged } from "game/item/IItem";
+import { ItemType, ItemTypeGroup } from "game/item/IItem";
 import type Item from "game/item/Item";
 import type Tile from "game/tile/Tile";
 export interface IBaseCanUse extends IActionUsable {
@@ -38,8 +39,9 @@ export interface IAttackRangedWeaponCanUse extends IBaseCanUse {
     attackType: AttackType.RangedWeapon;
     weapon: Item;
     ranged: IRanged;
-    rangedRequiredWeapon?: Item;
-    ammoItem: Item;
+    rangedRequiredWeapon: Item | undefined;
+    ammoItem: Item | undefined;
+    ammunitionType: ItemType | ItemTypeGroup | undefined;
 }
 export type IAttackCanUse = IAttackCloseUpCanUse | IAttackThrowItemCanUse | IAttackRangedWeaponCanUse;
 declare const _default: Action<[[ActionArgument.ItemInventory, ActionArgument.Undefined], [ActionArgument.AttackType, ActionArgument.Undefined], [ActionArgument.ItemInventory, ActionArgument.Undefined]], Human<number>, void, IAttackCanUse, [(Item | undefined)?, (AttackType | undefined)?, (Item | undefined)?]>;

package/definitions/game/game/entity/skill/ISkills.d.ts

@@ -17,8 +17,13 @@ export interface ISkillLevel {
     core: number;
 }
 export interface ISkillDescription extends IModdable {
-    attribute?: Stat;
+    attribute?: Stat | ISkillAttribute;
     reputation?: number;
     defaultDamageType?: DamageType;
 }
+export interface ISkillAttribute {
+    stat: Stat;
+    gainChanceOffset?: number;
+    gainMultiplier?: number;
+}
 export declare const skillDescriptions: OptionalDescriptions<SkillType, ISkillDescription>;

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

@@ -43,6 +43,10 @@ export interface IInfoProviderEvents {
     /**
      * Should be emitted when the info provider should be removed.
      */
+    requestRemove(): any;
+    /**
+     * Emitted when the info provider has been removed.
+     */
     remove(): any;
     /**
      * Should be emitted when the info provider's display level changes.

package/definitions/game/game/inspection/infoProviders/entity/Health.d.ts

@@ -16,6 +16,7 @@ export default class HealthInfoProvider<E extends EntityWithStats> extends InfoP
     protected readonly entity: E;
     constructor(entity: E);
     getClass(): string[];
+    protected onInitContent(): void;
     hasContent(): boolean;
     get(context: InfoProviderContext): InfoProvider;
     private getValue;

package/definitions/game/game/inspection/infoProviders/skill/MagicalItemBonuses.d.ts

@@ -16,6 +16,7 @@ export default class SkillBonusMagicalItemsInfoProvider extends InfoProvider {
     private readonly human?;
     constructor(skill: SkillType, human?: Human<number> | undefined);
     getClass(): string[];
+    protected onInitContent(): void;
     hasContent(): boolean;
     get(): (0 | import("../../../../language/impl/TranslationImpl").default | import("game/inspection/InfoProvider").SimpleInfoProvider)[];
     private getMagicalItems;

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

@@ -73,8 +73,8 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     readonly temperature: TemperatureManager;
     readonly tileEvents: TileEventManager;
     readonly time: TimeManager;
-    saveVersion: string;
     saveBuildTime?: number;
+    saveVersion: string;
     biomeType: BiomeTypes;
     civilizationScore: number;
     civilizationScoreTiles: Record<number, number>;

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

@@ -11,6 +11,7 @@
 import type { SfxType } from "audio/IAudio";
 import type { BiomeType } from "game/biome/IBiome";
 import type { DoodadType, DoodadTypeGroup } from "game/doodad/IDoodad";
+import type { IActionApi } from "game/entity/action/IAction";
 import { ActionType } from "game/entity/action/IAction";
 import type Creature from "game/entity/creature/Creature";
 import type { CreatureType, TileGroup } from "game/entity/creature/ICreature";
@@ -199,6 +200,8 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
     plural?: string;
     hideHelmet?: boolean;
     worth?: number;
+    lightSource?: boolean;
+    lightColor?: IRGB;
     /**
      * Array of items that the item is "made from" in cases where we can't use the disassembly items to burn into.
      * All items in array are required to have onBurn set in their description to function properly.
@@ -299,7 +302,10 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
     onCreate?(item: Item): void;
     onChangeInto?(item: Item, fromItemType: ItemType): void;
 }
-export type ConsumeItemStatsTuple = [health: number, stamina: number, hunger: number, thirst: number];
+export type ConsumeItemStatsTuple = [health: number, stamina: number, hunger: number, thirst: number, otherStats?: Array<{
+    stat: Stat;
+    amount: number;
+}>];
 export interface IItemOnUse {
     [ActionType.Apply]?: ConsumeItemStatsTuple;
     [ActionType.Build]?: IItemBuild;
@@ -505,9 +511,12 @@ export interface IItemChangeIntoOptions {
 export interface IRanged {
     range: number;
     attack: number;
-    ammunitionType?: ItemTypeGroup;
+    ammunitionType?: ItemType | ItemTypeGroup | ((action: IActionApi) => ItemType | ItemTypeGroup | undefined);
     requiredToFire?: ItemType;
     skillType?: SkillType;
+    unlimitedAmmunition?: boolean;
+    attackMessage?: Message;
+    particles?: IRGB | ((action: IActionApi) => IRGB | undefined);
 }
 export interface IMagicalPropertyInfo {
     /**
@@ -1576,7 +1585,22 @@ export declare enum ItemTypeGroup {
     Boat = 916,
     Text = 917,
     ContainerWithLiquid = 918,
-    All = 919,
-    Last = 920
+    CraftingMaterial = 919,
+    MagicalComponent = 920,
+    Scarecrow = 921,
+    Well = 922,
+    Mapping = 923,
+    Terrain = 924,
+    Lighthouse = 925,
+    SeedBearer = 926,
+    Mushroom = 927,
+    Lockpick = 928,
+    WaterPurification = 929,
+    CreatureContainment = 930,
+    Gem = 931,
+    Golem = 932,
+    CreatureResource = 933,
+    All = 934,
+    Last = 935
 }
 export {};

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

@@ -98,27 +98,27 @@ declare enum Dictionary {
     Quest = 86,
     QuestRequirement = 87,
     RecipeLevel = 88,
-    Riddle = 89,
-    SaveImportErrorReason = 90,
-    SaveSlotSort = 91,
-    Skill = 92,
-    SkillsSort = 93,
-    Source = 94,
-    Stat = 95,
-    StatusEffect = 96,
-    TeamMemberResponsibility = 97,
-    TemperatureType = 98,
-    Terrain = 99,
-    TileEvent = 100,
-    TooltipVisibilityOption = 101,
-    Ui = 102,
-    UiQuadrant = 103,
-    UnableToJoinReason = 104,
-    UnlockedRecipesStrategy = 105,
-    UsableActionType = 106,
-    Website = 107,
-    WeightStatus = 108,
-    WorldLayer = 109,
-    Region = 110
+    Region = 89,
+    Riddle = 90,
+    SaveImportErrorReason = 91,
+    SaveSlotSort = 92,
+    Skill = 93,
+    SkillsSort = 94,
+    Source = 95,
+    Stat = 96,
+    StatusEffect = 97,
+    TeamMemberResponsibility = 98,
+    TemperatureType = 99,
+    Terrain = 100,
+    TileEvent = 101,
+    TooltipVisibilityOption = 102,
+    Ui = 103,
+    UiQuadrant = 104,
+    UnableToJoinReason = 105,
+    UnlockedRecipesStrategy = 106,
+    UsableActionType = 107,
+    Website = 108,
+    WeightStatus = 109,
+    WorldLayer = 110
 }
 export default Dictionary;

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

@@ -112,7 +112,6 @@ declare const dictionaryMap: {
     19: typeof DamageType;
     20: typeof DialogId;
     21: typeof Direction;
-    110: typeof Direction;
     22: typeof InfoDisplayLevel;
     23: typeof DoodadType;
     24: typeof DoodadTypeExtra;
@@ -180,27 +179,28 @@ declare const dictionaryMap: {
     86: typeof QuestType;
     87: typeof QuestRequirementType;
     88: typeof RecipeLevel;
-    89: typeof Riddle;
-    90: typeof SaveImportErrorReason;
-    91: typeof SaveSort;
-    92: typeof SkillType;
-    93: typeof SkillSort;
-    94: typeof Source;
-    95: typeof Stat;
-    96: typeof StatusType;
-    97: typeof Responsibility;
-    98: typeof TempType;
-    99: typeof TerrainType;
-    100: typeof TileEventType;
-    101: typeof TooltipVisibilityOption;
-    102: typeof UiTranslation;
-    103: typeof Quadrant;
-    104: typeof UnableToJoinReason;
-    105: typeof UnlockedRecipesStrategy;
-    106: typeof UsableActionType;
-    107: typeof Website;
-    108: typeof WeightStatus;
-    109: typeof WorldZ;
+    89: typeof Direction;
+    90: typeof Riddle;
+    91: typeof SaveImportErrorReason;
+    92: typeof SaveSort;
+    93: typeof SkillType;
+    94: typeof SkillSort;
+    95: typeof Source;
+    96: typeof Stat;
+    97: typeof StatusType;
+    98: typeof Responsibility;
+    99: typeof TempType;
+    100: typeof TerrainType;
+    101: typeof TileEventType;
+    102: typeof TooltipVisibilityOption;
+    103: typeof UiTranslation;
+    104: typeof Quadrant;
+    105: typeof UnableToJoinReason;
+    106: typeof UnlockedRecipesStrategy;
+    107: typeof UsableActionType;
+    108: typeof Website;
+    109: typeof WeightStatus;
+    110: typeof WorldZ;
 };
 export declare const strictDictionaries: {
     0: typeof ActionType;
@@ -225,7 +225,6 @@ export declare const strictDictionaries: {
     19: typeof DamageType;
     20: typeof DialogId;
     21: typeof Direction;
-    110: typeof Direction;
     22: typeof InfoDisplayLevel;
     23: typeof DoodadType;
     24: typeof DoodadTypeExtra;
@@ -293,27 +292,28 @@ export declare const strictDictionaries: {
     86: typeof QuestType;
     87: typeof QuestRequirementType;
     88: typeof RecipeLevel;
-    89: typeof Riddle;
-    90: typeof SaveImportErrorReason;
-    91: typeof SaveSort;
-    92: typeof SkillType;
-    93: typeof SkillSort;
-    94: typeof Source;
-    95: typeof Stat;
-    96: typeof StatusType;
-    97: typeof Responsibility;
-    98: typeof TempType;
-    99: typeof TerrainType;
-    100: typeof TileEventType;
-    101: typeof TooltipVisibilityOption;
-    102: typeof UiTranslation;
-    103: typeof Quadrant;
-    104: typeof UnableToJoinReason;
-    105: typeof UnlockedRecipesStrategy;
-    106: typeof UsableActionType;
-    107: typeof Website;
-    108: typeof WeightStatus;
-    109: typeof WorldZ;
+    89: typeof Direction;
+    90: typeof Riddle;
+    91: typeof SaveImportErrorReason;
+    92: typeof SaveSort;
+    93: typeof SkillType;
+    94: typeof SkillSort;
+    95: typeof Source;
+    96: typeof Stat;
+    97: typeof StatusType;
+    98: typeof Responsibility;
+    99: typeof TempType;
+    100: typeof TerrainType;
+    101: typeof TileEventType;
+    102: typeof TooltipVisibilityOption;
+    103: typeof UiTranslation;
+    104: typeof Quadrant;
+    105: typeof UnableToJoinReason;
+    106: typeof UnlockedRecipesStrategy;
+    107: typeof UsableActionType;
+    108: typeof Website;
+    109: typeof WeightStatus;
+    110: typeof WorldZ;
 };
 export type DictionaryEnum = (typeof dictionaryMap)[Dictionary];
 export type DictionaryEntryEnums = {

package/definitions/game/language/dictionary/Message.d.ts

@@ -446,15 +446,15 @@ declare enum Message {
     NoTinderToStartFire = 434,
     NotSuitableToPlant = 435,
     NoWaterInStill = 436,
-    NPCMerchantStartingDialog1 = 437,
-    NPCMerchantStartingDialog2 = 438,
-    NPCMerchantStartingDialog3 = 439,
-    NPCMerchantStartingDialog4 = 440,
-    NPCMerchantWelcomeCredit = 441,
-    NPCMerchantNewInventoryDialog1 = 442,
-    NPCMerchantNewInventoryDialog2 = 443,
-    NPCMerchantNewInventoryDialog3 = 444,
-    NPCMerchantNewInventoryDialog4 = 445,
+    NPCMerchantNewInventoryDialog1 = 437,
+    NPCMerchantNewInventoryDialog2 = 438,
+    NPCMerchantNewInventoryDialog3 = 439,
+    NPCMerchantNewInventoryDialog4 = 440,
+    NPCMerchantStartingDialog1 = 441,
+    NPCMerchantStartingDialog2 = 442,
+    NPCMerchantStartingDialog3 = 443,
+    NPCMerchantStartingDialog4 = 444,
+    NPCMerchantWelcomeCredit = 445,
     NPCShipperShipToIsland = 446,
     NPCShipperStartingDialog1 = 447,
     NPCShipperStartingDialog2 = 448,

package/definitions/game/language/dictionary/Misc.d.ts

@@ -126,20 +126,20 @@ export declare enum MiscTranslation {
     ExpressionSeparator = 24,
     ItemMagicalProperty = 25,
     ListItemSeparator = 26,
-    Multiply = 27,
-    NPCName = 28,
-    NPCNameUnmet = 29,
-    NumberSingleDecimal = 30,
-    OwnName = 31,
-    Percent = 32,
-    PercentRaw = 33,
-    PlayerName = 34,
-    Possession = 35,
-    Range = 36,
-    ReformatSingularNoun = 37,
-    Renamed = 38,
-    Merge = 39,
-    MergeSpaced = 40,
+    Merge = 27,
+    MergeSpaced = 28,
+    Multiply = 29,
+    NPCName = 30,
+    NPCNameUnmet = 31,
+    NumberSingleDecimal = 32,
+    OwnName = 33,
+    Percent = 34,
+    PercentRaw = 35,
+    PlayerName = 36,
+    Possession = 37,
+    Range = 38,
+    ReformatSingularNoun = 39,
+    Renamed = 40,
     Tilled = 41,
     Unknown = 42,
     UnknownItem = 43

package/definitions/game/resource/IResourcePath.d.ts

@@ -13,7 +13,7 @@ import type { IModdable } from "mod/ModRegistry";
 import { PathType } from "resource/IResourceLoader";
 interface IResourceData {
     enumObject: any;
-    descriptions?: Map<number, IModdable & IHasImagePath> | OptionalDescriptions<number, IModdable & IHasImagePath> | ((key: number) => (IModdable & IHasImagePath) | undefined);
+    descriptions?: Map<number, IModdable & IHasImagePath<string | any>> | OptionalDescriptions<number, IModdable & IHasImagePath> | ((key: number) => (IModdable & IHasImagePath) | undefined);
     referencedType?: PathType;
 }
 declare module IResourceData {

package/definitions/game/ui/component/Text.d.ts

@@ -92,6 +92,7 @@ export declare class BasicText extends Component {
     currentTooltip?: (tooltip: Tooltip) => any;
     constructor(elementType?: string);
     setText(text: IStringSection & Partial<IColorSection> & Partial<ILinkSection> & Partial<IHeadingSection> & Partial<ITooltipSection> & Partial<IReferenceSection> & Partial<IListItemSection> & Partial<IBindingsSection>, data?: IEntireTextData): this;
+    protected onRemove(): void;
     private setTooltipLocation;
     private onClick;
 }

package/definitions/game/ui/screen/screens/game/static/stats/IStatDisplayDescription.d.ts

@@ -8,6 +8,7 @@
  * 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 { IHasImagePath } from "game/IObject";
 import type EntityWithStats from "game/entity/EntityWithStats";
 import type { IStat, StatDisplayType } from "game/entity/IStats";
 import type { Reference } from "game/reference/IReferenceManager";
@@ -15,7 +16,7 @@ import type { IModdable } from "mod/ModRegistry";
 import type Component from "ui/component/Component";
 import type Tooltip from "ui/tooltip/Tooltip";
 import type { IStringSection } from "utilities/string/Interpolator";
-export interface IStatDisplayDescription extends IModdable {
+export interface IStatDisplayDescription extends IModdable, IHasImagePath<string | ((entity: EntityWithStats, stat: IStat) => string)> {
     imagePath?: string | ((entity: EntityWithStats, stat: IStat) => string);
     /**
      * The CSS variable to use for the stat bar color

package/definitions/test/core/application.d.ts

@@ -15,12 +15,13 @@ import type { MenuId } from "../../game/ui/screen/screens/menu/component/IMenu";
 import type { Random } from "../../game/utilities/random/Random";
 import type { IAppPaths } from "../interfaces";
 import type { TestRunContext } from "../testRunner";
-import type { Apps } from "./applicationManager";
 import ApplicationInteractions from "./applicationInteractions";
+import type { Apps } from "./applicationManager";
 export interface IApplicationOptions {
     additionalArgs?: string[];
     mods?: string[];
     nodeJsMode?: boolean;
+    random?: Random;
 }
 export interface ITestState {
     seed: number;
@@ -52,7 +53,7 @@ export default class Application extends ApplicationInteractions {
     private videoPath;
     private videoTimerId;
     private readonly videoFrames;
-    constructor(testContext: TestRunContext, appId: string, paths: IAppPaths, random: Random, options?: IApplicationOptions);
+    constructor(testContext: TestRunContext, appId: string, paths: IAppPaths, options?: IApplicationOptions);
     get waywardLogFilePath(): string;
     reportResults(): Promise<void>;
     start(expectedInitialScreen?: "title" | "mp_gameplay_modifiers"): Promise<void>;

package/definitions/test/core/applicationDom.d.ts

@@ -27,5 +27,8 @@ export default class ApplicationDom {
     waitForVisibleThenClick(selector: string, timeout?: number, indent?: boolean, clickOnce?: boolean): Promise<void>;
     waitForVisibleElements(selector: string, timeout?: number, scrollIntoView?: boolean): Promise<WebdriverIO.Element[]>;
     waitForNotVisible(selector: string, timeout?: number): Promise<void>;
-    waitUntil(executor: () => Promise<boolean>, options: webdriverio.WaitUntilOptions): Promise<true | void>;
+    waitUntil(executor: () => Promise<boolean>, options: WaitUntilOptions): Promise<true | void>;
+}
+export interface WaitUntilOptions extends Omit<webdriverio.WaitUntilOptions, "timeoutMsg"> {
+    timeoutMsg?: string | (() => string);
 }

package/definitions/test/core/applicationManager.d.ts

@@ -75,7 +75,7 @@ export declare class Apps {
     sailToCivilization(winnerApp: Application): Promise<void>;
     executeJavascript<T2 extends any[], T = void>(app: Application, executor: (player: Player, ...extraArgs: T2) => T, ...extraArgs: T2): Promise<T[]>;
     executeOnPlayingClients<T>(runnable: (app: Application) => Promise<T>): Promise<T[]>;
-    executeOnApps<T>(apps: Application[], runnable: (app: Application) => Promise<T>): Promise<T[]>;
+    executeOnApps<T>(apps: Application[], runnable: (app: Application) => Promise<T>, requiresDeterminism: boolean): Promise<T[]>;
     runWhilePaused(blockId: string, runnable: () => Promise<void>): Promise<void>;
     private bindApp;
     private log;

package/definitions/test/util/random.d.ts

@@ -9,5 +9,5 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { Random } from "../../game/utilities/random/Random";
-export declare function createRandom(): Random;
+export declare function createRandom(appId: string): Random;
 export declare function getSeed(): number;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.13.0-beta.dev.20230425.1",
+	"version": "2.13.0-beta.dev.20230427.1",
 	"license": "MIT",
 	"repository": {
 		"type": "git",