@wayward/types 2.12.2-beta.dev.20221111.1 → 2.12.2-beta.dev.20221113.1

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

@@ -11,6 +11,6 @@
 import type { IActionApi } from "game/entity/action/IAction";
 import { ActionType } from "game/entity/action/IAction";
 import type Human from "game/entity/Human";
-import type { ItemType } from "game/item/IItem";
+import { ItemType } from "game/item/IItem";
 import Item from "game/item/Item";
 export default function consumeItemType(action: IActionApi<Human>, item: Item | ItemType, actionType?: ActionType): boolean;

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

@@ -255,7 +255,7 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
     /**
      * The item type to display instead of the describe item type
      */
-    displayItem?: SupplierOr<ItemType | undefined, [Item]>;
+    displayItem?: SupplierOr<DisplayableItemType | undefined, [Item]>;
     onEquip?(item: Item): void;
     onUnequip?(item: Item): void;
 }
@@ -1326,9 +1326,14 @@ export declare enum ItemType {
     WaterLilies = 718,
     Mud = 719,
     SpikerushSheaths = 720,
-    SpikerushSeeds = 721,
-    TatteredMap_RolledUp = 722
+    SpikerushSeeds = 721
 }
+export declare enum ItemTypeExtra {
+    None = 999,
+    TatteredMap_RolledUp = 1000,
+    TatteredMap_Completed = 1001
+}
+export declare type DisplayableItemType = ItemType | ItemTypeExtra;
 export declare enum ItemTag {
     None = 0
 }

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

@@ -23,7 +23,7 @@ import { CreationId } from "game/IGame";
 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, ItemTag } from "game/item/IItem";
+import type { ContainerReference, DisplayableItemType, IConstructedInfo, IContainable, IContainer, IItemDescription, IItemDisassembleResult, IItemUsed, IMagicalPropertyInfo, IMoveToTileOptions, ItemTag } from "game/item/IItem";
 import { BookType, ItemType, ItemTypeGroup, ItemWeightChange, SYMBOL_CONTAINER_CACHED_REFERENCE } from "game/item/IItem";
 import type { IPlaceOnTileOptions } from "game/item/IItemManager";
 import ItemMapManager from "game/item/ItemMapManager";
@@ -119,7 +119,7 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
     set durability(value: number);
     get durabilityMax(): number;
     set durabilityMax(value: number);
-    getDisplayItem(): ItemType;
+    getDisplayItem(): DisplayableItemType;
     isContainer(): this is Item & IContainer;
     /**
      * Gets the owner of this item.

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

@@ -17,7 +17,7 @@ import type Player from "game/entity/player/Player";
 import { CreationId } from "game/IGame";
 import { Quality } from "game/IObject";
 import type { ContainerReference, IContainable, IContainer, IItemDescription, IItemWeightComponent, IMoveToTileOptions, IRecipe } from "game/item/IItem";
-import { CraftResult, ItemType, ItemTypeGroup } from "game/item/IItem";
+import { CraftResult, ItemType, ItemTypeGroup, ItemTypeExtra } from "game/item/IItem";
 import type { IAddToContainerOptions, IDoodadsUsed, IGetBestItemsOptions, IGetItemOptions, IGetItemsOptions, IRequirementInfo } from "game/item/IItemManager";
 import { ContainerReferenceSource, CraftStatus, ICraftResultChances, WeightType } from "game/item/IItemManager";
 import Item from "game/item/Item";
@@ -133,6 +133,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     updateContainedWithin(containable: IContainable, containedWithin: IContainer | undefined): void;
     addToContainerInternal(item: Item, container: IContainer, options?: IAddToContainerOptions): boolean;
     removeContainerItems(container: IContainer, removeContainedItems?: boolean): void;
+    isItemExtra(type: number): type is ItemTypeExtra;
     exists(item: Item): boolean;
     remove(item: Item, removeContainedItems?: boolean): void;
     getDisassemblyComponents(description: IItemDescription, quality: Quality | undefined): Item[];

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

@@ -11,13 +11,16 @@
 import type { IslandId } from "game/island/IIsland";
 import type Island from "game/island/Island";
 import type { IContainer } from "game/item/IItem";
+import type Item from "game/item/Item";
 import DrawnMap from "game/mapping/DrawnMap";
 import type { IVector3 } from "utilities/math/IVector";
 export declare const DEFAULT_ITEM_MAP_CHANCE_COMPLETED = 0.1;
 export declare const DEFAULT_ITEM_MAP_CHANCE_OTHER_ISLAND = 0.5;
 export default class ItemMapManager {
-    static getMapsInContainer(island: Island, container: IContainer): import("./Item").default[];
+    static getMapsInContainer(island: Island, container: IContainer): Item[];
     private map?;
+    private readonly host;
+    constructor(host: Item);
     has(): boolean;
     /**
      * Sets the map associated with this item.
@@ -50,6 +53,10 @@ export default class ItemMapManager {
      * @returns the island associated with this map, if it exists
      */
     getIsland(): Island | undefined;
+    /**
+     * @returns whether this map is completed
+     */
+    isCompleted(): boolean;
     /**
      * @returns the obfuscation of the linked map, a multiplier that will be applied overtop whatever durability obfuscation there is
      */

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

@@ -55,58 +55,59 @@ declare enum Dictionary {
     IslandNameModifierDescriptor = 43,
     IslandNameOverrunWithCreatureDescriptor = 44,
     Item = 45,
-    ItemGroup = 46,
-    JoinServerRetryReason = 47,
-    Level = 48,
-    Loading = 49,
-    Macro = 50,
-    MagicalPropertyType = 51,
-    MapQuality = 52,
-    MenuBarButton = 53,
-    Message = 54,
-    MessagesDefaultFilter = 55,
-    MessagesTimestampMode = 56,
-    Milestone = 57,
-    MilestoneModifierGroup = 58,
-    Misc = 59,
-    ModLoadError = 60,
-    ModLoadFailureReason = 61,
-    ModProvide = 62,
-    ModSort = 63,
-    ModType = 64,
-    MultiplayerCompatibility = 65,
-    MultiplayerDisconnectReason = 66,
-    MusicPlaylist = 67,
-    Note = 68,
-    Npc = 69,
-    Number = 70,
-    PartOfDay = 71,
-    Prompt = 72,
-    QuadrantComponent = 73,
-    QuadrantComponentContextMenuAction = 74,
-    Quality = 75,
-    Quest = 76,
-    QuestRequirement = 77,
-    RecipeLevel = 78,
-    Riddle = 79,
-    SaveImportErrorReason = 80,
-    SaveSlotSort = 81,
-    Skill = 82,
-    Source = 83,
-    Stat = 84,
-    StatusEffect = 85,
-    TeamMemberResponsibility = 86,
-    TemperatureType = 87,
-    Terrain = 88,
-    TileEvent = 89,
-    TooltipVisibilityOption = 90,
-    Ui = 91,
-    UiQuadrant = 92,
-    UnableToJoinReason = 93,
-    UnlockedRecipesStrategy = 94,
-    UsableActionType = 95,
-    Website = 96,
-    WeightStatus = 97,
-    WorldLayer = 98
+    ItemExtra = 46,
+    ItemGroup = 47,
+    JoinServerRetryReason = 48,
+    Level = 49,
+    Loading = 50,
+    Macro = 51,
+    MagicalPropertyType = 52,
+    MapQuality = 53,
+    MenuBarButton = 54,
+    Message = 55,
+    MessagesDefaultFilter = 56,
+    MessagesTimestampMode = 57,
+    Milestone = 58,
+    MilestoneModifierGroup = 59,
+    Misc = 60,
+    ModLoadError = 61,
+    ModLoadFailureReason = 62,
+    ModProvide = 63,
+    ModSort = 64,
+    ModType = 65,
+    MultiplayerCompatibility = 66,
+    MultiplayerDisconnectReason = 67,
+    MusicPlaylist = 68,
+    Note = 69,
+    Npc = 70,
+    Number = 71,
+    PartOfDay = 72,
+    Prompt = 73,
+    QuadrantComponent = 74,
+    QuadrantComponentContextMenuAction = 75,
+    Quality = 76,
+    Quest = 77,
+    QuestRequirement = 78,
+    RecipeLevel = 79,
+    Riddle = 80,
+    SaveImportErrorReason = 81,
+    SaveSlotSort = 82,
+    Skill = 83,
+    Source = 84,
+    Stat = 85,
+    StatusEffect = 86,
+    TeamMemberResponsibility = 87,
+    TemperatureType = 88,
+    Terrain = 89,
+    TileEvent = 90,
+    TooltipVisibilityOption = 91,
+    Ui = 92,
+    UiQuadrant = 93,
+    UnableToJoinReason = 94,
+    UnlockedRecipesStrategy = 95,
+    UsableActionType = 96,
+    Website = 97,
+    WeightStatus = 98,
+    WorldLayer = 99
 }
 export default Dictionary;

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

@@ -31,7 +31,7 @@ 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 { BookType, EquipEffect, ItemType, ItemTypeGroup, RecipeLevel } from "game/item/IItem";
+import { BookType, EquipEffect, ItemType, ItemTypeExtra, ItemTypeGroup, RecipeLevel } from "game/item/IItem";
 import { CraftEfficacy } from "game/item/recipe/Crafter";
 import { MagicalPropertyType } from "game/magic/MagicalPropertyType";
 import { DrawnMapTheme } from "game/mapping/IMapRender";
@@ -130,59 +130,60 @@ declare const dictionaryMap: {
     43: typeof IslandModifierType;
     44: typeof CreatureType;
     45: typeof ItemType;
-    46: typeof ItemTypeGroup;
-    47: typeof JoinServerRetryReason;
-    48: typeof Level;
-    49: typeof Load;
-    50: symbol;
-    51: typeof MagicalPropertyType;
-    52: typeof MapQuality;
-    53: typeof MenuBarButtonType;
-    54: typeof Message;
-    55: typeof MessageFilterDefault;
-    56: typeof MessageTimestamp;
-    57: typeof Milestone;
-    58: typeof MilestoneModifierGroup;
-    59: typeof MiscTranslation;
-    60: typeof CanLoadState;
-    61: typeof ModLoadFailureReason;
-    62: typeof ModProvide;
-    63: typeof ModSort;
-    64: typeof ModType;
-    65: typeof MultiplayerCompatibility;
-    66: typeof DisconnectReason;
-    67: typeof MusicPlaylist;
-    68: typeof Note;
-    69: typeof NPCType;
-    70: symbol;
-    71: typeof PartOfDay;
-    72: typeof Prompt;
-    73: typeof QuadrantComponentId;
-    74: typeof QuadrantComponentContextMenuAction;
-    75: typeof Quality;
-    76: typeof QuestType;
-    77: typeof QuestRequirementType;
-    78: typeof RecipeLevel;
-    79: typeof Riddle;
-    80: typeof SaveImportErrorReason;
-    81: typeof SaveSort;
-    82: typeof SkillType;
-    83: typeof Source;
-    84: typeof Stat;
-    85: typeof StatusType;
-    86: typeof Responsibility;
-    87: typeof TempType;
-    88: typeof TerrainType;
-    89: typeof TileEventType;
-    90: typeof TooltipVisibilityOption;
-    91: typeof UiTranslation;
-    92: typeof Quadrant;
-    93: typeof UnableToJoinReason;
-    94: typeof UnlockedRecipesStrategy;
-    95: typeof UsableActionType;
-    96: typeof Website;
-    97: typeof WeightStatus;
-    98: typeof WorldZ;
+    46: typeof ItemTypeExtra;
+    47: typeof ItemTypeGroup;
+    48: typeof JoinServerRetryReason;
+    49: typeof Level;
+    50: typeof Load;
+    51: symbol;
+    52: typeof MagicalPropertyType;
+    53: typeof MapQuality;
+    54: typeof MenuBarButtonType;
+    55: typeof Message;
+    56: typeof MessageFilterDefault;
+    57: typeof MessageTimestamp;
+    58: typeof Milestone;
+    59: typeof MilestoneModifierGroup;
+    60: typeof MiscTranslation;
+    61: typeof CanLoadState;
+    62: typeof ModLoadFailureReason;
+    63: typeof ModProvide;
+    64: typeof ModSort;
+    65: typeof ModType;
+    66: typeof MultiplayerCompatibility;
+    67: typeof DisconnectReason;
+    68: typeof MusicPlaylist;
+    69: typeof Note;
+    70: typeof NPCType;
+    71: symbol;
+    72: typeof PartOfDay;
+    73: typeof Prompt;
+    74: typeof QuadrantComponentId;
+    75: typeof QuadrantComponentContextMenuAction;
+    76: typeof Quality;
+    77: typeof QuestType;
+    78: typeof QuestRequirementType;
+    79: typeof RecipeLevel;
+    80: typeof Riddle;
+    81: typeof SaveImportErrorReason;
+    82: typeof SaveSort;
+    83: typeof SkillType;
+    84: typeof Source;
+    85: typeof Stat;
+    86: typeof StatusType;
+    87: typeof Responsibility;
+    88: typeof TempType;
+    89: typeof TerrainType;
+    90: typeof TileEventType;
+    91: typeof TooltipVisibilityOption;
+    92: typeof UiTranslation;
+    93: typeof Quadrant;
+    94: typeof UnableToJoinReason;
+    95: typeof UnlockedRecipesStrategy;
+    96: typeof UsableActionType;
+    97: typeof Website;
+    98: typeof WeightStatus;
+    99: typeof WorldZ;
 };
 export declare const strictDictionaries: {
     0: typeof ActionType;
@@ -231,59 +232,60 @@ export declare const strictDictionaries: {
     43: typeof IslandModifierType;
     44: typeof CreatureType;
     45: typeof ItemType;
-    46: typeof ItemTypeGroup;
-    47: typeof JoinServerRetryReason;
-    48: typeof Level;
-    49: typeof Load;
-    50: symbol;
-    51: typeof MagicalPropertyType;
-    52: typeof MapQuality;
-    53: typeof MenuBarButtonType;
-    54: typeof Message;
-    55: typeof MessageFilterDefault;
-    56: typeof MessageTimestamp;
-    57: typeof Milestone;
-    58: typeof MilestoneModifierGroup;
-    59: typeof MiscTranslation;
-    60: typeof CanLoadState;
-    61: typeof ModLoadFailureReason;
-    62: typeof ModProvide;
-    63: typeof ModSort;
-    64: typeof ModType;
-    65: typeof MultiplayerCompatibility;
-    66: typeof DisconnectReason;
-    67: typeof MusicPlaylist;
-    68: typeof Note;
-    69: typeof NPCType;
-    70: symbol;
-    71: typeof PartOfDay;
-    72: typeof Prompt;
-    73: typeof QuadrantComponentId;
-    74: typeof QuadrantComponentContextMenuAction;
-    75: typeof Quality;
-    76: typeof QuestType;
-    77: typeof QuestRequirementType;
-    78: typeof RecipeLevel;
-    79: typeof Riddle;
-    80: typeof SaveImportErrorReason;
-    81: typeof SaveSort;
-    82: typeof SkillType;
-    83: typeof Source;
-    84: typeof Stat;
-    85: typeof StatusType;
-    86: typeof Responsibility;
-    87: typeof TempType;
-    88: typeof TerrainType;
-    89: typeof TileEventType;
-    90: typeof TooltipVisibilityOption;
-    91: typeof UiTranslation;
-    92: typeof Quadrant;
-    93: typeof UnableToJoinReason;
-    94: typeof UnlockedRecipesStrategy;
-    95: typeof UsableActionType;
-    96: typeof Website;
-    97: typeof WeightStatus;
-    98: typeof WorldZ;
+    46: typeof ItemTypeExtra;
+    47: typeof ItemTypeGroup;
+    48: typeof JoinServerRetryReason;
+    49: typeof Level;
+    50: typeof Load;
+    51: symbol;
+    52: typeof MagicalPropertyType;
+    53: typeof MapQuality;
+    54: typeof MenuBarButtonType;
+    55: typeof Message;
+    56: typeof MessageFilterDefault;
+    57: typeof MessageTimestamp;
+    58: typeof Milestone;
+    59: typeof MilestoneModifierGroup;
+    60: typeof MiscTranslation;
+    61: typeof CanLoadState;
+    62: typeof ModLoadFailureReason;
+    63: typeof ModProvide;
+    64: typeof ModSort;
+    65: typeof ModType;
+    66: typeof MultiplayerCompatibility;
+    67: typeof DisconnectReason;
+    68: typeof MusicPlaylist;
+    69: typeof Note;
+    70: typeof NPCType;
+    71: symbol;
+    72: typeof PartOfDay;
+    73: typeof Prompt;
+    74: typeof QuadrantComponentId;
+    75: typeof QuadrantComponentContextMenuAction;
+    76: typeof Quality;
+    77: typeof QuestType;
+    78: typeof QuestRequirementType;
+    79: typeof RecipeLevel;
+    80: typeof Riddle;
+    81: typeof SaveImportErrorReason;
+    82: typeof SaveSort;
+    83: typeof SkillType;
+    84: typeof Source;
+    85: typeof Stat;
+    86: typeof StatusType;
+    87: typeof Responsibility;
+    88: typeof TempType;
+    89: typeof TerrainType;
+    90: typeof TileEventType;
+    91: typeof TooltipVisibilityOption;
+    92: typeof UiTranslation;
+    93: typeof Quadrant;
+    94: typeof UnableToJoinReason;
+    95: typeof UnlockedRecipesStrategy;
+    96: typeof UsableActionType;
+    97: typeof Website;
+    98: typeof WeightStatus;
+    99: typeof WorldZ;
 };
 export declare type DictionaryEnum = (typeof dictionaryMap)[Dictionary];
 export declare type DictionaryEntryEnums = {
@@ -390,6 +392,7 @@ declare const dictionaries: {
     96: typeof SYMBOL_ANY_DICTIONARY | Enum;
     97: typeof SYMBOL_ANY_DICTIONARY | Enum;
     98: typeof SYMBOL_ANY_DICTIONARY | Enum;
+    99: typeof SYMBOL_ANY_DICTIONARY | Enum;
 } & Record<number, typeof SYMBOL_ANY_DICTIONARY | Enum | undefined> & {
     getByEnum: typeof getByEnum;
 };