@wayward/types 2.11.4-beta.dev.20220204.2 → 2.11.4-beta.dev.20220208.1

package/definitions/game/game/entity/action/Actions.d.ts

@@ -26,8 +26,8 @@ declare const actionDescriptions: {
     31: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
     79: import("./Action").Action<[], import("../player/Player").default | import("../npc/NPC").default, void, []>;
     12: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [(import("../../item/Item").default | undefined)?]>;
-    0: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
-    39: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
+    0: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, [import("game/entity/action/IAction").ActionArgument.OptionalItemArrayNearby, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default, ((import("../../item/Item").default | undefined)[] | undefined)?]>;
+    39: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, [import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default, (import("../../item/Item").default | undefined)?]>;
     38: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
     61: import("./Action").Action<[], import("../player/Player").default | import("../npc/NPC").default, void, []>;
     8: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
@@ -111,7 +111,7 @@ declare const actionDescriptions: {
     89: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.Boolean], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default, boolean]>;
     59: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.Direction, [import("game/entity/action/IAction").ActionArgument.Integer32, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../../utilities/math/Direction").Direction.None | import("../../../utilities/math/Direction").Direction.East | import("../../../utilities/math/Direction").Direction.North | import("../../../utilities/math/Direction").Direction.West | import("../../../utilities/math/Direction").Direction.South, (number | undefined)?]>;
     90: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.Container, [import("game/entity/action/IAction").ActionArgument.UnsignedInteger32NumberArray, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default, void, [import("../../item/IItem").IContainer, (number[] | undefined)?]>;
-    97: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.Item, [import("game/entity/action/IAction").ActionArgument.Integer32, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default, void, [import("../../item/Item").default, (number | undefined)?]>;
+    97: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.Item, import("game/entity/action/IAction").ActionArgument.Integer32, [import("game/entity/action/IAction").ActionArgument.Boolean, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default, void, [import("../../item/Item").default, number, (boolean | undefined)?]>;
     104: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.String, import("game/entity/action/IAction").ActionArgument.Object], import("../player/Player").default, void, [string, any?]>;
     92: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, [import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default, (import("../../item/Item").default | undefined)?]>;
     62: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby, import("game/entity/action/IAction").ActionArgument.ActionType], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default, ActionType]>;

package/definitions/game/game/entity/action/IAction.d.ts

@@ -282,19 +282,20 @@ export declare enum ActionArgument {
     ItemArray = 21,
     ItemArrayInventory = 22,
     ItemArrayNearby = 23,
-    ItemInventory = 24,
-    ItemNearby = 25,
-    ItemType = 26,
-    NPC = 27,
-    NPCNearby = 28,
-    Player = 29,
-    Quality = 30,
-    RecipeType = 31,
-    RestType = 32,
-    TileEvent = 33,
-    UnsignedInteger32NumberArray = 34,
-    Vector2 = 35,
-    Vector3 = 36
+    OptionalItemArrayNearby = 24,
+    ItemInventory = 25,
+    ItemNearby = 26,
+    ItemType = 27,
+    NPC = 28,
+    NPCNearby = 29,
+    Player = 30,
+    Quality = 31,
+    RecipeType = 32,
+    RestType = 33,
+    TileEvent = 34,
+    UnsignedInteger32NumberArray = 35,
+    Vector2 = 36,
+    Vector3 = 37
 }
 export declare type ActionArgumentTypeMap<X extends ActionArgument> = {
     [ActionArgument.Undefined]: undefined;
@@ -321,6 +322,7 @@ export declare type ActionArgumentTypeMap<X extends ActionArgument> = {
     [ActionArgument.ItemArray]: Item[];
     [ActionArgument.ItemArrayInventory]: Item[];
     [ActionArgument.ItemArrayNearby]: Item[];
+    [ActionArgument.OptionalItemArrayNearby]: Array<Item | undefined>;
     [ActionArgument.ItemInventory]: Item;
     [ActionArgument.ItemNearby]: Item;
     [ActionArgument.ItemType]: ItemType;

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

@@ -11,5 +11,5 @@
 import { Action } from "game/entity/action/Action";
 import { ActionArgument } from "game/entity/action/IAction";
 import type Item from "game/item/Item";
-declare const _default: Action<[ActionArgument.ItemNearby], import("../../player/Player").default | import("../../npc/NPC").default, void, [Item]>;
+declare const _default: Action<[ActionArgument.ItemNearby, [ActionArgument.OptionalItemArrayNearby, ActionArgument.Undefined]], import("../../player/Player").default | import("../../npc/NPC").default, void, [Item, ((Item | undefined)[] | undefined)?]>;
 export default _default;

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

@@ -11,5 +11,5 @@
 import { Action } from "game/entity/action/Action";
 import { ActionArgument } from "game/entity/action/IAction";
 import type Item from "game/item/Item";
-declare const _default: Action<[ActionArgument.ItemNearby], import("../../player/Player").default | import("../../npc/NPC").default, void, [Item]>;
+declare const _default: Action<[ActionArgument.ItemNearby, [ActionArgument.ItemNearby, ActionArgument.Undefined]], import("../../player/Player").default | import("../../npc/NPC").default, void, [Item, (Item | undefined)?]>;
 export default _default;

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

@@ -10,5 +10,5 @@
  */
 import { Action } from "game/entity/action/Action";
 import { ActionArgument } from "game/entity/action/IAction";
-declare const _default: Action<[ActionArgument.Item, [ActionArgument.Integer32, ActionArgument.Undefined]], import("../../player/Player").default, void, [import("../../../item/Item").default, (number | undefined)?]>;
+declare const _default: Action<[ActionArgument.Item, ActionArgument.Integer32, [ActionArgument.Boolean, ActionArgument.Undefined]], import("../../player/Player").default, void, [import("../../../item/Item").default, number, (boolean | undefined)?]>;
 export default _default;

package/definitions/game/game/entity/action/actions/helper/GatherTreasure.d.ts

@@ -14,10 +14,9 @@ import type Player from "game/entity/player/Player";
 import type Item from "game/item/Item";
 import type { ITreasure } from "game/mapping/DrawnMap";
 import type DrawnMap from "game/mapping/DrawnMap";
-import type { IVector3 } from "utilities/math/IVector";
 export declare enum GatherTreasureResult {
     NoTreasure = 0,
     NotYet = 1,
     Gathered = 2
 }
-export default function (map: DrawnMap, treasure: ITreasure, actionPoint: IVector3, action: IActionHandlerApi<Player | NPC>, tool?: Item): GatherTreasureResult;
+export default function (map: DrawnMap, treasure: ITreasure, action: IActionHandlerApi<Player | NPC>, tool?: Item): GatherTreasureResult;

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

@@ -187,6 +187,7 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
     /**
      * 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.
+     * This should eventually be removed since we want to be able to break down items into proper sub-ingredients/items.
      */
     burnsLike?: ItemType[];
     spawnableTiles?: TileGroup;

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

@@ -169,7 +169,7 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
     isEquipped(): boolean;
     getEquippedPlayer(): Human | undefined;
     getEquipSlot(): EquipType | undefined;
-    setQuickSlot(player: Player, quickSlot: number | undefined): void;
+    setQuickSlot(player: Player, quickSlot: number, removeQuickSlot?: boolean): void;
     clearQuickSlot(): void;
     isDecayed(): boolean;
     changeInto(type: ItemType, disableNotify?: boolean, emitTransformation?: boolean): void;

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

@@ -208,7 +208,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
      * Note: It may return the real containedItems array!
      */
     getOrderedContainerItems(container: IContainer, options?: Partial<IGetItemOptions>): Item[];
-    reduceDismantleWeight(createdItems: Item[], itemWeight: number): void;
+    capWeightOfItems(createdItems: Item[], itemWeight: number): void;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup): Translation;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup, count: number): Translation;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup, article: boolean): Translation;

package/definitions/game/game/mapping/DrawnMap.d.ts

@@ -125,6 +125,7 @@ export default class DrawnMap extends EventEmitter.Host<IDrawnMapEvents> impleme
     get isValid(): boolean;
     get island(): Island;
     private constructor();
+    toString(): string;
     preSerializeObject(): void;
     onUnserialized(): void;
     getTreasure(): readonly ITreasure[];

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

@@ -13,10 +13,11 @@ import type { IGameOptionsPartial } from "game/options/IGameOptions";
 import type Translation from "language/Translation";
 import type { Random, SeededGenerator } from "utilities/random/Random";
 import { RandomInstance, RandomReference } from "utilities/random/Random";
-export declare abstract class GameplayModifierInstance<ID extends number> {
+export declare abstract class GameplayModifierInstance<ID extends number, INSTANCE_ARGS extends any[] = []> {
     readonly id: ID;
     readonly random: Random<SeededGenerator>;
-    constructor(id: ID, random: Random<SeededGenerator>);
+    protected readonly args: INSTANCE_ARGS;
+    constructor(id: ID, random: Random<SeededGenerator>, ...args: INSTANCE_ARGS);
     options: IGameOptionsPartial;
     setOptions(options: IGameOptionsPartial): this;
     addOptions(options: IGameOptionsPartial): this;
@@ -25,12 +26,13 @@ export declare abstract class GameplayModifierInstance<ID extends number> {
     protected abstract getDefaultTitle(): Translation;
     setTitle(initializer: (defaultTitle: Translation) => Translation): this;
 }
-export declare type GetModifierInstance<MODIFIER extends GameplayModifier<number>> = MODIFIER extends GameplayModifier<number, infer INSTANCE, any[]> ? INSTANCE : never;
-export declare type GetModifierId<MODIFIER extends GameplayModifier<number>> = MODIFIER extends GameplayModifier<infer ID, any, any[]> ? ID : never;
-export declare type GetModifierInstanceArgs<MODIFIER extends GameplayModifier<number>> = MODIFIER extends GameplayModifier<number, any, infer INSTANCE_ARGS> ? INSTANCE_ARGS : never;
-export default abstract class GameplayModifier<ID extends number, INSTANCE extends GameplayModifierInstance<ID> = GameplayModifierInstance<ID>, INSTANCE_ARGS extends any[] = []> implements IHasImagePath {
+export declare type GetModifierInstance<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number, any[]>, any[]>> = MODIFIER extends GameplayModifier<number, infer INSTANCE, any[]> ? INSTANCE : never;
+export declare type GetModifierId<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number, any[]>, any[]>> = MODIFIER extends GameplayModifier<infer ID, any, any[]> ? ID : never;
+export declare type GetModifierInstanceArgs<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number, any[]>, any[]>> = MODIFIER extends GameplayModifier<number, any, infer INSTANCE_ARGS> ? INSTANCE_ARGS : never;
+export default abstract class GameplayModifier<ID extends number, INSTANCE extends GameplayModifierInstance<ID, any[]> = GameplayModifierInstance<ID, any[]>, INSTANCE_ARGS extends any[] = []> implements IHasImagePath {
     readonly id: ID;
     readonly random: RandomInstance | RandomReference;
+    private readonly _args;
     readonly imagePath?: string;
     constructor(id: ID, random?: RandomInstance | RandomReference);
     abstract instantiate(type: ID, ...args: INSTANCE_ARGS): INSTANCE;

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

@@ -11,7 +11,7 @@
 import type GameplayModifier from "game/options/modifiers/GameplayModifier";
 import type { GameplayModifierInstance, GetModifierId, GetModifierInstance, GetModifierInstanceArgs } from "game/options/modifiers/GameplayModifier";
 import type { StringableObject } from "utilities/object/Objects";
-export default abstract class GameplayModifiersManager<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number>, any[]>, ID extends GetModifierId<MODIFIER> = GetModifierId<MODIFIER>, INSTANCE_ARGS extends GetModifierInstanceArgs<MODIFIER> = GetModifierInstanceArgs<MODIFIER>> {
+export default abstract class GameplayModifiersManager<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number, any[]>, any[]>, ID extends GetModifierId<MODIFIER> = GetModifierId<MODIFIER>, INSTANCE_ARGS extends GetModifierInstanceArgs<MODIFIER> = GetModifierInstanceArgs<MODIFIER>> {
     private readonly enumObject;
     private readonly classes;
     private _instances;
@@ -21,7 +21,7 @@ export default abstract class GameplayModifiersManager<MODIFIER extends Gameplay
     getModifierInstance(id: ID): MODIFIER | undefined;
     createCollection(...args: INSTANCE_ARGS): GameplayModifiersCollection<MODIFIER, ID>;
 }
-export declare class GameplayModifiersCollection<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number>, any[]>, ID extends GetModifierId<MODIFIER> = GetModifierId<MODIFIER>, INSTANCE extends GetModifierInstance<MODIFIER> = GetModifierInstance<MODIFIER>, INSTANCE_ARGS extends GetModifierInstanceArgs<MODIFIER> = GetModifierInstanceArgs<MODIFIER>> {
+export declare class GameplayModifiersCollection<MODIFIER extends GameplayModifier<number, GameplayModifierInstance<number, any[]>, any[]>, ID extends GetModifierId<MODIFIER> = GetModifierId<MODIFIER>, INSTANCE extends GetModifierInstance<MODIFIER> = GetModifierInstance<MODIFIER>, INSTANCE_ARGS extends GetModifierInstanceArgs<MODIFIER> = GetModifierInstanceArgs<MODIFIER>> {
     protected readonly manager: GameplayModifiersManager<MODIFIER>;
     readonly initializedModifiers: Map<ID, INSTANCE>;
     protected readonly args: INSTANCE_ARGS;

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

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Entity from "game/entity/Entity";
+import type Player from "game/entity/player/Player";
 import type { Milestone } from "game/milestones/IMilestone";
 import type { IGameOptionsPartial } from "game/options/IGameOptions";
 import GameplayModifier, { GameplayModifierInstance } from "game/options/modifiers/GameplayModifier";
@@ -25,11 +26,12 @@ export declare enum MilestoneModifierGroup {
     Challenge = 9
 }
 export declare const milestoneGroupIcons: Record<MilestoneModifierGroup, string>;
-export declare class MilestoneModifierInstance extends GameplayModifierInstance<Milestone> {
+export declare class MilestoneModifierInstance extends GameplayModifierInstance<Milestone, [Player?]> {
+    protected get player(): Player | undefined;
     isEnabledForPlayer(entity: Entity): boolean;
     protected getDefaultTitle(): import("../../../../language/impl/TranslationImpl").default;
 }
-export default abstract class MilestoneModifier extends GameplayModifier<Milestone, MilestoneModifierInstance> {
+export default abstract class MilestoneModifier extends GameplayModifier<Milestone, MilestoneModifierInstance, [Player?]> {
     after?: Milestone[];
     /**
      * Whether this milestone modifier is host-exclusive, IE, clients connecting to a server can't select this modifier.
@@ -38,7 +40,7 @@ export default abstract class MilestoneModifier extends GameplayModifier<Milesto
      */
     isGlobal: boolean;
     constructor(id?: Milestone);
-    instantiate(id: Milestone): MilestoneModifierInstance;
+    instantiate(id: Milestone, player?: Player): MilestoneModifierInstance;
     abstract getOptions(): IGameOptionsPartial;
     initialize(instance: MilestoneModifierInstance): MilestoneModifierInstance;
     abstract getGroup(): MilestoneModifierGroup;

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

@@ -8,10 +8,11 @@
  * 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 Player from "game/entity/player/Player";
 import { Milestone } from "game/milestones/IMilestone";
 import GameplayModifiersManager from "game/options/modifiers/GameplayModifiersManager";
 import type MilestoneModifier from "game/options/modifiers/milestone/MilestoneModifier";
-declare class MilestoneModifiersManager extends GameplayModifiersManager<MilestoneModifier> {
+declare class MilestoneModifiersManager extends GameplayModifiersManager<MilestoneModifier, Milestone, [Player?]> {
     constructor();
     has(milestone: Milestone): boolean;
     getUnlocked(): Milestone[];

package/definitions/game/game/options/modifiers/milestone/modifiers/shared/TamedCreatureMilestoneModifier.d.ts

@@ -14,12 +14,12 @@ import MilestoneModifier, { MilestoneModifierGroup, MilestoneModifierInstance }
 import type { Random, SeededGenerator } from "utilities/random/Random";
 declare class TamedCreatureMilestoneModifierInstance extends MilestoneModifierInstance {
     private readonly modifier;
-    constructor(modifier: TamedCreatureMilestoneModifier, id: Milestone, random: Random<SeededGenerator>);
+    constructor(modifier: TamedCreatureMilestoneModifier, id: Milestone, random: Random<SeededGenerator>, player?: Player);
     onSpawnPlayer(player: Player): void;
 }
 export default abstract class TamedCreatureMilestoneModifier extends MilestoneModifier {
     getGroup(): MilestoneModifierGroup;
-    instantiate(id: Milestone): TamedCreatureMilestoneModifierInstance;
+    instantiate(id: Milestone, player?: Player): TamedCreatureMilestoneModifierInstance;
     abstract isAberrant(): boolean;
 }
 export {};

package/definitions/game/game/tile/events/IFire.d.ts

@@ -33,7 +33,7 @@ export declare module FireStage {
     function getTemperature(stage: FireStage, min: number, max: number): number;
 }
 export declare module IFire {
-    function dissassemblyBurn(island: Island, item: Item, container: ITileContainer, disassembly: boolean): void;
+    function dissassemblyBurn(island: Island, item: Item, container: ITileContainer, disassembly: boolean): Item[];
     function harvestGatherBurn(step: number, resources: ILootItem[] | undefined, container: IContainer, quality: Quality | undefined, tileEvent: TileEvent): void;
-    function burnsLike(burnsLikeItem: ItemType, tileEvent: TileEvent, tileContainer: IContainer, quality: Quality | undefined): void;
+    function burnsLike(burnsLikeItem: ItemType, tileEvent: TileEvent, tileContainer: IContainer, quality: Quality | undefined): Item[];
 }

package/definitions/game/multiplayer/packets/BasePacket.d.ts

@@ -89,7 +89,9 @@ export default abstract class BasePacket {
     protected readIsland(): Island;
     protected writeIsland(value: Island): void;
     protected readItems(): Item[];
+    protected readOptionalItems(): Array<Item | undefined>;
     protected writeItems(value: Item[]): void;
+    protected writeOptionalItems(value: Array<Item | undefined>): void;
     protected readTileEvent(): TileEvent | undefined;
     protected writeTileEvent(value: TileEvent): void;
     protected readObject(): any;

package/definitions/game/multiplayer/packets/client/ShowLoadingScreenPacket.d.ts

@@ -10,10 +10,8 @@
  */
 import type { Load } from "game/meta/Loading";
 import ClientPacket from "multiplayer/packets/ClientPacket";
-import { ScreenId } from "ui/screen/IScreen";
 export default class ShowLoadingScreenPacket extends ClientPacket {
     load: Load;
-    hideScreens?: ScreenId[];
     getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     process(): void;

package/definitions/game/ui/old/screens/InGameScreen.d.ts

@@ -166,7 +166,7 @@ export default class InGameScreen extends BaseScreen {
     addItemToFreeQuickSlot(itemId: number): boolean;
     clearQuickSlot(quickSlot: number, internal?: boolean): void;
     removeItemFromQuickSlot(quickSlot: number, itemId?: number, skipSync?: boolean): void;
-    setItemQuickslot(item: Item, quickSlot: number | undefined): void;
+    setItemQuickslot(item: Item, quickSlot: number, removeQuickSlot?: boolean): void;
     updateQuickSlotItem(quickSlot: number): boolean;
     onUpdateQuickSlotsOrEquips(): void;
     onSortableItemReceive(sortableEvent: ISortableEvent): void;

package/package.json

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