@wayward/types 2.11.0-beta.dev.20211203.1 → 2.11.0-beta.dev.20211204.1

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

@@ -426,6 +426,10 @@ export declare type EquipEffects = {
     [K in keyof IEquipEffects]: AddHead<K, Extract<IEquipEffects[K], any[]>>;
 }[keyof IEquipEffects];
 export declare type EquipEffectByType<T extends EquipEffect> = IEquipEffects[T];
+export declare enum ItemWeightChange {
+    NewMagicProperty = 0,
+    NewWeight = 1
+}
 export declare enum RecipeLevel {
     Simple = 0,
     Intermediate = 1,

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

@@ -24,7 +24,7 @@ import type { IObject, IObjectOptions } from "game/IObject";
 import { Quality } from "game/IObject";
 import type { IslandId } from "game/island/IIsland";
 import type { ContainerReference, IConstructedInfo, IContainable, IContainer, IItemDescription, IItemDisassembleResult, IItemUsed, IMagicalPropertyInfo, IMoveToTileOptions } from "game/item/IItem";
-import { BookType, ItemType, SYMBOL_CONTAINER_CACHED_REFERENCE } from "game/item/IItem";
+import { ItemWeightChange, BookType, ItemType, SYMBOL_CONTAINER_CACHED_REFERENCE } from "game/item/IItem";
 import type { IPlaceOnTileOptions } from "game/item/IItemManager";
 import ItemMapManager from "game/item/ItemMapManager";
 import type { IHasMagic, MagicalSubPropertySubTypes } from "game/magic/MagicalPropertyManager";
@@ -170,6 +170,11 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
     clearQuickSlot(): void;
     isDecayed(): boolean;
     changeInto(type: ItemType, disableNotify?: boolean, emitTransformation?: boolean): void;
+    /**
+     * Verifies an item has a proper weight combined with its magical item weight (featherweight) property and changes it if not.
+     * @returns A type of change via ItemWeightChange for showing a new magical property was added or a new magical weight was added. If no change happened, it will return undefined.
+     */
+    verifyMagicalItemWeight(): ItemWeightChange | undefined;
     /**
      * Returns and item based on returnOnUseAndDecay.
      * @param disableNotify Set to true if no notification should be shown for the new item above the player.

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

@@ -15,7 +15,6 @@ import Human from "game/entity/Human";
 import type NPC from "game/entity/npc/NPC";
 import type Player from "game/entity/player/Player";
 import { Quality } from "game/IObject";
-import type Island from "game/island/Island";
 import type { ContainerReference, IContainable, IContainer, IItemDescription, IItemWeightComponent } from "game/item/IItem";
 import { ItemType, ItemTypeGroup } from "game/item/IItem";
 import type { IAddToContainerOptions, IRequirementInfo } from "game/item/IItemManager";
@@ -91,6 +90,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     static isGroup(item: ItemType | ItemTypeGroup): item is ItemTypeGroup;
     static isInGroup(itemType: ItemType, itemGroup: ItemTypeGroup | ItemType): boolean;
     static getGroupItems(itemGroup: ItemType | ItemTypeGroup, ancestorGroups?: ItemTypeGroup[]): Set<ItemType>;
+    static getPlayerFromInventoryContainer(containable: IContainable): Player | undefined;
     static getItemTypeGroupName(itemType: ItemType | ItemTypeGroup, article?: boolean, count?: number): Translation;
     static getGroupDefault(itemGroup: ItemTypeGroup, weightType?: WeightType, ancestorGroups?: ItemTypeGroup[]): ItemType;
     /**
@@ -160,6 +160,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     getItemTypeGroupName(itemType: ItemType | ItemTypeGroup, article?: boolean, count?: number): Translation;
     getGroupDefault(itemGroup: ItemTypeGroup, weightType?: WeightType, ancestorGroups?: ItemTypeGroup[]): ItemType;
     getGroups(itemType: ItemType): ItemTypeGroup[];
+    getPlayerFromInventoryContainer(containable: IContainable): Player | undefined;
     /**
      * Used to spawn a random item on the current biome type and at a set location (and terrain type) based on spawnOnWorldGen properties in item descriptions.
      * @param terrainType The terrain type to check.
@@ -225,7 +226,6 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     getItemsByWeight(a: number, b: number): number;
     getItemsWeight(items: Item[]): number;
     copyProperties(item: Item, item2: Item): void;
-    getPlayerFromInventoryContainer(island: Island, containable: IContainable): Player | undefined;
     getCraftQualityBonus(item: Item, required?: boolean): number;
     /**
      * Checks if the item type or item is filtered from inventory/crafting/container dialogs.
@@ -245,7 +245,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     /**
      * Note: don't print items to the console because the console will hold the item indefinitely
      */
-    loadReference(container: IContainer): boolean;
+    loadReference(container: IContainer, loadChildReferences?: boolean): boolean;
     private removeFromContainerInternal;
     private updateUiOnItemRemove;
     private getCraftTierBonus;

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

@@ -14,7 +14,6 @@ declare module ItemReferenceManager {
     /**
      * Don't use this
      */
-    function getContainerReferenceSlow(containable: IContainable, includeIsland?: boolean): ContainerReference;
     function getContainerReferenceInIsland(island: Island, containable: IContainable | undefined, showWarnings?: boolean): ContainerReference;
     function derefenceContainerReference(containerRef: ContainerReference, island?: Island, showWarnings?: boolean): object | undefined;
 }

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

@@ -11,6 +11,7 @@
 import EventEmitter from "event/EventEmitter";
 import { DoodadType } from "game/doodad/IDoodad";
 import type Human from "game/entity/Human";
+import type { IslandId } from "game/island/IIsland";
 import type Island from "game/island/Island";
 import type Item from "game/item/Item";
 import type { IMapGenGenerateOutput } from "game/mapgen/IMapGen";
@@ -113,7 +114,7 @@ export default class DrawnMap extends EventEmitter.Host<IDrawnMapEvents> impleme
     get position(): Readonly<IVector3>;
     get radius(): number;
     private _position;
-    private islandId;
+    islandId: IslandId;
     private seed?;
     private readonly discoveredTreasures;
     readonly type: DrawnMapType;

package/definitions/game/game/reference/ReferenceManager.d.ts

@@ -44,7 +44,7 @@ interface IReferenceTypeMap {
 export declare type Referenceable = IReferenceTypeMap[ReferenceableReferenceTypes];
 export default class ReferenceManager {
     static isEnumReference(type: ReferenceType): type is EnumReferenceTypes;
-    static getList(type: ReferenceType, gameIsland?: Island): import("../entity/creature/corpse/CorpseManager").default | import("../entity/creature/CreatureManager").default | import("../doodad/DoodadManager").default | import("../item/ItemManager").default | import("../entity/npc/NPCManager").default | import("../tile/TileEventManager").default | IterableIterator<Island> | Player[] | readonly Milestone[] | readonly ItemType[] | readonly SkillType[] | readonly Stat[];
+    static getList(type: ReferenceType, gameIsland?: Island): import("../entity/creature/corpse/CorpseManager").default | import("../entity/creature/CreatureManager").default | import("../doodad/DoodadManager").default | import("../item/ItemManager").default | import("../entity/npc/NPCManager").default | import("../tile/TileEventManager").default | Player[] | readonly Milestone[] | readonly ItemType[] | readonly SkillType[] | IterableIterator<Island> | readonly Stat[];
     private referenceCursor;
     create(): number;
     get(thing: Referenceable): Reference | undefined;

package/definitions/game/save/serializer/Serializer.d.ts

@@ -14,6 +14,7 @@ import StringTokenizer from "save/serializer/StringTokenizer";
 export default class Serializer implements ISerializer {
     private readonly options;
     private readonly stringTokenizer?;
+    static convertStringToUint8Array(data: string): Uint8Array;
     private static array;
     private static usingArray;
     private static readonly savedObjectCache;

package/definitions/game/ui/screen/screens/game/component/CanvasDialog.d.ts

@@ -80,6 +80,7 @@ export default class CanvasDialog extends Dialog {
     protected buttonSurface: Component<HTMLElement>;
     protected drawer: Component<HTMLElement>;
     constructor(id: DialogId);
+    protected onCanvasDialogRemove(): void;
     setZoomLevels(levels: Iterable<number>): this;
     get isHovering(): boolean;
     getMousePosition(): Vector2;
@@ -99,6 +100,7 @@ export default class CanvasDialog extends Dialog {
     private dragStart;
     private drag;
     private dragEnd;
+    private removeDragEventListeners;
     protected onCanvasClick(): void;
     private getAbsoluteMousePosition;
     protected rotateClockwise(): void;

package/definitions/game/ui/screen/screens/game/static/Messages.d.ts

@@ -75,6 +75,7 @@ export default class Messages extends QuadrantComponent {
     onReadNote(player: Player, id: number): void;
     onFocusChat(): boolean;
     getDefaultFilterName(filter: MessageFilterDefault): string;
+    protected onAppend(): void;
     protected onChangeQuadrant(): void;
     /**
      * Event handler for when the text in the chat box should be sent as a message.

package/definitions/game/ui/screen/screens/menu/MenuManager.d.ts

@@ -8,11 +8,17 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
+import EventEmitter from "event/EventEmitter";
 import type Screen from "ui/screen/Screen";
 import { MenuId } from "ui/screen/screens/menu/component/IMenu";
 import Menu from "ui/screen/screens/menu/component/Menu";
 import type { MenuById } from "ui/screen/screens/menu/MenuMap";
-export default class MenuManager {
+export interface IMenuManagerEvents {
+    init(menu: Menu): any;
+    show(menu: Menu): any;
+    hide(menu: Menu): any;
+}
+export default class MenuManager extends EventEmitter.Host<IMenuManagerEvents> {
     allowNoMenus: boolean;
     all: Record<number, Menu>;
     chain: Menu[];
@@ -39,4 +45,8 @@ export default class MenuManager {
      * Sets the given menu to be the new top menu. (Removes super-menus, keeps sub-menus)
      */
     setTop(menu: Menu): this;
+    /**
+     * Returns a promise that resolves when the given screen is shown.
+     */
+    await<MENU extends MenuId>(menuId: MENU): Promise<MenuById[MENU]>;
 }

package/package.json

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