@wayward/types 2.13.0-beta.dev.20230422.1 → 2.13.0-beta.dev.20230424.1

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

@@ -16,9 +16,9 @@ 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 { ContainerReference, IContainable, IContainer, IItemDescription, IItemWeightComponent, IMoveToTileOptions, IRecipe } from "game/item/IItem";
+import type { ContainerReference, IContainable, IContainer, IItemDescription, IItemWeightComponent, IRecipe } from "game/item/IItem";
 import { ContainerType, CraftResult, ItemType, ItemTypeExtra, ItemTypeGroup } from "game/item/IItem";
-import type { IAddToContainerOptions, IDoodadsUsed, IGetBestItemsOptions, IGetItemOptions, IGetItemsOptions, IRequirementInfo } from "game/item/IItemManager";
+import type { IAddToContainerResult, IDoodadsUsed, IGetBestItemsOptions, IGetItemOptions, IGetItemsOptions, IMoveItemOptions, IRequirementInfo } from "game/item/IItemManager";
 import { ContainerReferenceSource, CraftStatus, ICraftResultChances, WeightType } from "game/item/IItemManager";
 import Item from "game/item/Item";
 import { ObjectManager } from "game/ObjectManager";
@@ -34,29 +34,32 @@ import type { Random } from "utilities/random/Random";
 export interface IItemManagerEvents {
     create(item: Item): any;
     remove(item: Item): any;
-    canMoveItem(human: Human | undefined, item: Item, toContainer: IContainer): boolean | undefined;
-    canMoveItems(human: Human | undefined, fromContainer: IContainer, toContainer: IContainer, itemType: ItemType | undefined, ofQuality: Quality | undefined): boolean | undefined;
     /**
-     * Called when an item is removed from a container.
-     * @param item The item object.
+     * Called before moving items to another container
+     */
+    canMoveItems(human: Human | undefined, itemsToMove: Item[], fromContainer: IContainer | undefined, toContainer: IContainer, options?: IMoveItemOptions): boolean | undefined;
+    /**
+     * Called when items are removed from a container.
+     * @param items The items.
      * @param container The container object the item was removed from.
      * @param containerTile The tile of that container when the remove occurred.
      */
-    containerItemRemove(item: Item, container: IContainer | undefined, containerTile: Tile | undefined): any;
+    containerItemRemove(items: Item[], container: IContainer | undefined, containerTile: Tile | undefined): any;
     /**
-     * Called when an item is moved from one container to another.
-     * @param item The item object.
-     * @param containerFrom The container object the item was moved from. This container might be inventory or a container within the inventory.
+     * Called when items are moved from one container to another.
+     * @param items The items.
+     * @param containerFrom The container object the items were moved from. This container might be inventory or a container within the inventory.
      * @param containerFromTile The tile of containerFrom when the update occurred.
-     * @param containerTo The container object the item was moved to. This container might be inventory or a container within the inventory.
+     * @param containerTo The container object the items were moved to. This container might be inventory or a container within the inventory.
      */
-    containerItemUpdate(item: Item, containerFrom: IContainer | undefined, containerFromTile: Tile | undefined, containerTo: IContainer): any;
+    containerItemUpdate(items: Item[], containerFrom: IContainer | undefined, containerFromTile: Tile | undefined, containerTo: IContainer): any;
     /**
-     * Called when an item is added to a container.
-     * @param item The item object.
-     * @param container The container object the item was added to. This container might be inventory or a container within the inventory.
+     * Called when items are added to a container.
+     * @param items The items.
+     * @param container The container object the items were added to. This container might be inventory or a container within the inventory.
+     * @param options Move item options.
      */
-    containerItemAdd(item: Item, container: IContainer): any;
+    containerItemAdd(items: Item[], container: IContainer, options?: IMoveItemOptions): any;
     /**
      * Called when an item is crafted
      * @param human The human object
@@ -81,7 +84,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     private static readonly cachedItemsThatAreUsedForGrowingPlants;
     private static readonly cachedItemsThatAreUsedInRecipes;
     private static readonly cachedWeights;
-    static readonly cachedItemSpawns: Map<BiomeType, OptionalDescriptions<WorldZ, OptionalDescriptions<TerrainType, ItemType[]>>>;
+    static readonly cachedItemSpawns: Map<BiomeType, Map<WorldZ, Map<TerrainType, Set<ItemType>>>>;
     static getItemTypes(): readonly ItemType[];
     static getItemsWithRecipes(): readonly ItemType[];
     static getBestItemForTier(item: ItemType | ItemTypeGroup): ItemType | undefined;
@@ -95,7 +98,10 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     static isInGroup(itemType: ItemType, itemGroup: ItemTypeGroup | ItemType): boolean;
     static isItemExtra(type: number): type is ItemTypeExtra;
     static getGroupItems(itemGroup: ItemType | ItemTypeGroup): Set<ItemType>;
-    private static getGroupItemsWithoutCache;
+    /**
+     * Gets a set of additional item types that belong to the specified group
+     */
+    private static getAdditionalGroupItemsWithoutCache;
     static getItemTypeGroupName(itemType: ItemType | ItemTypeGroup, article?: Article, count?: number): Translation;
     static getGroupDefault(itemGroup: ItemTypeGroup, weightType?: WeightType, ancestorGroups?: ItemTypeGroup[]): ItemType;
     /**
@@ -130,7 +136,34 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     hashContainer(containable: IContainable, containerReferenceSource?: ContainerReferenceSource): string;
     hashContainerReference(containerReference: ContainerReference): string;
     updateContainedWithin(containable: IContainable, containedWithin: IContainer | undefined): void;
-    addToContainerInternal(item: Item, container: IContainer, options?: IAddToContainerOptions): boolean;
+    /**
+     * Moves an item into a container
+     * @param human Human causing the item movement
+     * @param item Item to move
+     * @param toContainer Container to move the item to
+     * @param options Item move options
+     * @returns Result that tells you what moved
+     */
+    moveItemToContainer(human: Human | undefined, item: Item, toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult;
+    /**
+     * Moves items from one container into another container
+     * @param human Human causing the item movement
+     * @param fromContainer Source container
+     * @param toContainer Destination container
+     * @param options Item move options
+     * @returns Result that tells you what moved
+     */
+    moveItemsFromContainer(human: Human | undefined, fromContainer: IContainer, toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult;
+    /**
+     * Moves items to a container.
+     * Note: All the items must be contained within the same container.
+     * @param human Human causing the item movement
+     * @param item Items to move
+     * @param toContainer Destination container
+     * @param options Item move options
+     * @returns Result that tells you what moved
+     */
+    moveItemsToContainer(human: Human | undefined, items: Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult;
     removeContainerItems(container: IContainer, removeContainedItems?: boolean): void;
     exists(item: Item): boolean;
     remove(item: Item, removeContainedItems?: boolean, extinguishTorches?: boolean): void;
@@ -140,19 +173,8 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     create(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, container: IContainer | undefined, quality?: Quality, human?: Human, updateTables?: boolean): Item;
     createFake(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, quality?: Quality, human?: Human): Item;
     getContainedContainers(container: IContainer): IContainer[];
-    moveAllFromContainerToInventory(human: Human, container: IContainer, ofQuality?: Quality): Item[];
     computeContainerWeight(container: IContainer): number;
     getMagicalWeightCapacity(container: IContainer): number;
-    moveAllFromContainerToContainer(human: Human | undefined, fromContainer: IContainer, toContainer: IContainer, itemType?: ItemType | undefined, ofQuality?: Quality | undefined, checkWeight?: boolean, filterText?: string | undefined, onMoveItem?: (item: Item) => void, moveToTileOptions?: IMoveToTileOptions): Item[];
-    /**
-     * Moves an item into a container when the container has enough room for it
-     * @param human Human causing the item movement
-     * @param item Item to move
-     * @param container Container to move the item to
-     * @param moveToTileOptions When set, the movement will be animated
-     * @returns True if the item was moved, false if it wasn't
-     */
-    moveToContainer(human: Human | undefined, item: Item, container: IContainer, moveToTileOptions?: IMoveToTileOptions): boolean;
     hasRoomInContainer(targetContainer: IContainer, itemToMove: Item): boolean;
     /**
      * Gets the name of a container

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

@@ -0,0 +1,22 @@
+/*!
+ * 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 Island from "game/island/Island";
+import Translation from "language/Translation";
+import { Direction } from "utilities/math/Direction";
+interface IRegion extends Record<Uppercase<Direction.CardinalNames>, boolean> {
+    CENTER: boolean;
+    DIRECTION: Direction;
+    REGION: Translation;
+}
+declare namespace IRegion {
+    function get(island: Island, x: number, y: number): IRegion;
+}
+export default IRegion;

package/definitions/game/game/temperature/TemperatureManager.d.ts

@@ -150,8 +150,8 @@ export default class TemperatureManager extends EventEmitter.Host<ITemperatureMa
     protected onCreateOrRemoveObject(_: any, object: Doodad | TileEvent | Creature | NPC): void;
     protected onEntityMove(object: EntityMovable, lastTile: Tile, tile: Tile): void;
     protected onUpdateTile(island: Island, tile: Tile, oldType: TerrainType): void;
-    protected onItemContainerAdd(itemManager: ItemManager, item: Item, container?: IContainer): void;
-    protected onItemContainerRemove(itemManager: ItemManager, item: Item, container: IContainer | undefined, containerTile: Tile | undefined): void;
+    protected onItemContainerAdd(itemManager: ItemManager, items: Item[], container?: IContainer): void;
+    protected onItemContainerRemove(itemManager: ItemManager, items: Item[], container: IContainer | undefined, containerTile: Tile | undefined): void;
     protected onItemFireUpdate(item: Item): void;
     protected onPlay(): void;
     protected onTickStart(island: Island): void;

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

@@ -118,6 +118,7 @@ declare enum Dictionary {
     UsableActionType = 106,
     Website = 107,
     WeightStatus = 108,
-    WorldLayer = 109
+    WorldLayer = 109,
+    Region = 110
 }
 export default Dictionary;

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

@@ -8,19 +8,19 @@
  * 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 { MilestoneSort } from "ui/screen/screens/game/dialog/IMilestonesDialog";
-import { SkillSort } from "ui/screen/screens/game/dialog/ISkillsDialog";
 import { Command } from "command/ICommand";
+import { Quality } from "game/IObject";
+import { WorldZ } from "game/WorldZ";
 import { BiomeType } from "game/biome/IBiome";
 import { DoodadType, DoodadTypeExtra, DoodadTypeGroup, GrowingStage } from "game/doodad/IDoodad";
-import { MapQuality } from "game/entity/action/actions/map/MapQuality";
-import { ActionType } from "game/entity/action/IAction";
-import { UsableActionType } from "game/entity/action/usable/UsableActionType";
 import { CombatDangerLevel, CombatStrength } from "game/entity/CombatStrengthManager";
-import { CreatureType } from "game/entity/creature/ICreature";
 import { AiType, DamageType, StatusType } from "game/entity/IEntity";
 import { EquipType, SkillType } from "game/entity/IHuman";
 import { Stat } from "game/entity/IStats";
+import { ActionType } from "game/entity/action/IAction";
+import { MapQuality } from "game/entity/action/actions/map/MapQuality";
+import { UsableActionType } from "game/entity/action/usable/UsableActionType";
+import { CreatureType } from "game/entity/creature/ICreature";
 import { NPCType } from "game/entity/npc/INPCs";
 import { Source } from "game/entity/player/IMessageManager";
 import { WeightStatus } from "game/entity/player/IPlayer";
@@ -31,9 +31,8 @@ import { BleedLevel } from "game/entity/status/handler/IBleeding";
 import { ExhaustionLevel } from "game/entity/status/handler/IExhausted";
 import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
 import { InspectType } from "game/inspection/IInspection";
-import { DurabilityLevel } from "game/inspection/infoProviders/doodad/IDurability";
 import { Level } from "game/inspection/infoProviders/ILevel";
-import { Quality } from "game/IObject";
+import { DurabilityLevel } from "game/inspection/infoProviders/doodad/IDurability";
 import { BookType, EquipEffect, ItemType, ItemTypeExtra, ItemTypeGroup, RecipeLevel } from "game/item/IItem";
 import { CraftEfficacy } from "game/item/recipe/Crafter";
 import { MagicalPropertyType } from "game/magic/MagicalPropertyType";
@@ -48,11 +47,10 @@ import { IslandModifierType } from "game/options/modifiers/island/IslandModifier
 import { MilestoneModifierGroup } from "game/options/modifiers/milestone/MilestoneModifier";
 import Riddle from "game/riddle/Riddle";
 import { TempType } from "game/temperature/ITemperature";
-import { FireStage } from "game/tile/events/IFire";
 import { TerrainType } from "game/tile/ITerrain";
 import { TileEventType } from "game/tile/ITileEvent";
+import { FireStage } from "game/tile/events/IFire";
 import { PartOfDay } from "game/time/ITimeManager";
-import { WorldZ } from "game/WorldZ";
 import Dictionary from "language/Dictionary";
 import { GameEndMessage } from "language/dictionary/GameEndMessage";
 import { Health, HealthAccuracy } from "language/dictionary/Health";
@@ -63,27 +61,29 @@ import { MiscTranslation } from "language/dictionary/Misc";
 import { MultiplayerCompatibility } from "language/dictionary/MultiplayerCompatibility";
 import Note from "language/dictionary/Note";
 import UiTranslation from "language/dictionary/UiTranslation";
-import { IslandName } from "language/english/game/islandName/IslandName";
 import { LighthouseName } from "language/english/game/LighthouseName";
+import { IslandName } from "language/english/game/islandName/IslandName";
 import { ModProvide, ModType } from "mod/IModInfo";
 import { CanLoadState, ModLoadFailureReason } from "mod/IModManager";
 import { DisconnectReason, JoinServerRetryReason, UnableToJoinReason } from "multiplayer/IMultiplayer";
-import { MusicPlaylist, TooltipVisibilityOption } from "save/data/ISaveDataGlobal";
 import { SaveImportErrorReason, SaveSort } from "save/ISaveManager";
-import Bindable, { BindableType } from "ui/input/Bindable";
+import { MusicPlaylist, TooltipVisibilityOption } from "save/data/ISaveDataGlobal";
 import { FontStyle } from "ui/IUi";
+import Bindable, { BindableType } from "ui/input/Bindable";
 import { SortType } from "ui/old/IOldUi";
-import { Quadrant, QuadrantComponentContextMenuAction } from "ui/screen/screens/game/component/IQuadrantComponent";
 import { DialogId } from "ui/screen/screens/game/Dialogs";
 import { MessageTimestamp, QuadrantComponentId } from "ui/screen/screens/game/IGameScreenApi";
 import { MessageFilterDefault } from "ui/screen/screens/game/IMessages";
+import { Quadrant, QuadrantComponentContextMenuAction } from "ui/screen/screens/game/component/IQuadrantComponent";
+import { MilestoneSort } from "ui/screen/screens/game/dialog/IMilestonesDialog";
+import { SkillSort } from "ui/screen/screens/game/dialog/ISkillsDialog";
 import { ActionSort } from "ui/screen/screens/game/static/actions/IActionsDrawer";
 import { MenuBarButtonType } from "ui/screen/screens/game/static/menubar/IMenuBarButton";
 import { CharacterSort } from "ui/screen/screens/menu/menus/character/Character";
 import { HelpArticle } from "ui/screen/screens/menu/menus/help/HelpArticleDescriptions";
 import { HighscoreSort } from "ui/screen/screens/menu/menus/highscores/IHighscoresMenu";
-import { Website } from "ui/screen/screens/menu/menus/main/component/IWebsite";
 import { Responsibility } from "ui/screen/screens/menu/menus/main/IAbout";
+import { Website } from "ui/screen/screens/menu/menus/main/component/IWebsite";
 import { ModSort } from "ui/screen/screens/menu/menus/mods/IModsMenu";
 import { Direction } from "utilities/math/Direction";
 import { ChangeType } from "utilities/trello/ITrello";
@@ -112,6 +112,7 @@ declare const dictionaryMap: {
     19: typeof DamageType;
     20: typeof DialogId;
     21: typeof Direction;
+    110: typeof Direction;
     22: typeof InfoDisplayLevel;
     23: typeof DoodadType;
     24: typeof DoodadTypeExtra;
@@ -224,6 +225,7 @@ 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;

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

@@ -21,7 +21,7 @@ import { EquipSlotTranslation, MiscTranslation } from "language/dictionary/Misc"
 import type UiTranslation from "language/dictionary/UiTranslation";
 import type { DictionaryEntryEnums } from "language/DictionaryMap";
 import TranslationImpl from "language/impl/TranslationImpl";
-import type { ISerializedTranslation } from "language/ITranslation";
+import type { ISerializedTranslation, TranslationArg } from "language/ITranslation";
 import { formatListTranslation } from "language/segment/FormatListSegment";
 import ITranslationSorter from "language/utility/TranslationSorter";
 import type { IStringSection } from "utilities/string/Interpolator";
@@ -117,6 +117,8 @@ declare module Translation {
     const damage: (damageTypes: ArrayOr<DamageType>, colorize?: boolean, reformatter?: TranslationImpl | ((type: DamageType) => Translation) | undefined) => TranslationImpl;
     function growthStage(stage: GrowingStage, spores?: boolean): TranslationImpl;
     function growthStage(stage?: GrowingStage, spores?: boolean): TranslationImpl | undefined;
+    function merge(...content: TranslationArg[]): TranslationImpl;
+    function mergeSpaced(...content: TranslationArg[]): TranslationImpl;
     const getString: typeof TranslationImpl.getString;
     const resolve: typeof TranslationImpl.resolve;
     function colorizeQuality(quality: Quality | string | undefined): Translation;
@@ -147,5 +149,6 @@ declare module Translation {
     function reformatSingularNoun(article: Article): Translation;
     function reformatSingularNoun(count: number, article: Article): Translation;
     function reformatSingularNoun(count?: number | Article, article?: Article): Translation;
+    function upgrade(translation: ISerializedTranslation, id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number): void;
 }
 export default Translation;

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

@@ -43,7 +43,7 @@ export default abstract class TranslationsProvider {
     readonly contextRules: IContextRules;
     constructor(language: string);
     getTranslation(dictionaryName: string, entry: string): string[] | undefined;
-    setDictionary(dictionary: string, translations: Record<string, string | string[]>): this;
+    setDictionary(dictionary: string, translations: Record<string, string | string[]> | Map<any, string | string[]>): this;
     setIrregularRules(...rules: Array<[string, string]>): this;
     setPluralizationRules(...rules: Array<PluralRule | [string, string]>): this;
     setSingularizationRules(...rules: Array<SingularRule | [string, string]>): this;