@wayward/types 2.12.0-beta.dev.20220905.1 → 2.12.0-beta.dev.20220907.9

package/definitions/game/IGlobal.d.ts

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import "@cplusplus/index";
+import "@hosts/shared/globalTypes";
 import "@wayward/goodstream/apply";
 import type WAudio from "audio/Audio";
 import type CommandManager from "command/CommandManager";
@@ -41,7 +42,6 @@ import "utilities/typesglobal/Iterables";
 import "utilities/typesglobal/Misc";
 import "utilities/typesglobal/Objects";
 import "utilities/typesglobal/Types";
-import "@hosts/shared/globalTypes";
 declare global {
     let absentPlayers: Player[];
     let audio: WAudio | undefined;
@@ -69,6 +69,9 @@ declare global {
     const gameVersionMinor: number;
     const gameVersionPatch: number;
     const gameVersionName: string;
+    const gameVersionTitleMajor: string;
+    const gameVersionTitleMinor: string;
+    const gameVersionTitle: string;
     const isNodeJs: boolean;
     const isWebWorker: boolean;
     const overlayWorks: boolean | undefined;

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

@@ -79,8 +79,8 @@ export default abstract class Human extends Entity implements IHasInsulation {
     turns: number;
     vehicleItemReference: ItemReference | undefined;
     walkSoundCounter: number;
-    containerSortInfo: Record<string, IContainerSortInfo>;
-    dialogContainerInfo: Record<number, IDialogInfo>;
+    containerSortInfo: Record<string, IContainerSortInfo | undefined>;
+    dialogContainerInfo: Record<number, IDialogInfo | undefined>;
     readonly movementIntent: IMovementIntent;
     walkPath: IWalkPath | undefined;
     identifier: string;

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

@@ -420,9 +420,23 @@ export interface IVoyageInfo {
     wantedItems?: ItemType[];
 }
 export declare enum MovingClientSide {
+    /**
+     * NoInput = Idle
+     */
     NoInput = 0,
+    /**
+     * Is actively moving
+     */
     Moving = 1,
+    /**
+     * Just completed their movement.
+     * They might be about to move again.
+     */
     Moved = 2,
+    /**
+     * The game registered the end of the movement.
+     * It's about to check if it will move again or finish (state change into Moving or NoInput)
+     */
     PreNoInput = 3
 }
 /**

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

@@ -30,6 +30,7 @@ import type { IPromptDescriptionBase, PromptDescriptionArgs } from "game/meta/pr
 import type { Milestone } from "game/milestones/IMilestone";
 import type { ITile } from "game/tile/ITerrain";
 import type TileEvent from "game/tile/TileEvent";
+import type { IModdable } from "mod/ModRegistry";
 import type { IRGB } from "utilities/Color";
 import type { Direction } from "utilities/math/Direction";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
@@ -188,7 +189,7 @@ export interface IActionNotUsable extends Partial<IPackedMessage> {
     source?: never;
 }
 export declare type AnyActionDescription = IActionDescription<Array<ActionArgument | ActionArgument[]>, Entity, any, IActionUsable, any[]>;
-export interface IActionDescription<A extends Array<ActionArgument | ActionArgument[]> = Array<ActionArgument | ActionArgument[]>, E extends Entity = Entity, R = void, CU extends IActionUsable = IActionUsable, AV extends any[] = ActionArgumentTupleTypes<A>> {
+export interface IActionDescription<A extends Array<ActionArgument | ActionArgument[]> = Array<ActionArgument | ActionArgument[]>, E extends Entity = Entity, R = void, CU extends IActionUsable = IActionUsable, AV extends any[] = ActionArgumentTupleTypes<A>> extends IModdable {
     type?: number;
     argumentTypes: A;
     usability: {

package/definitions/game/game/entity/action/usable/UsableAction.d.ts

@@ -9,8 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Doodad from "game/doodad/Doodad";
-import type { ActionDisplayLevel, IActionNotUsable, IActionUsable } from "game/entity/action/IAction";
-import { ActionType } from "game/entity/action/IAction";
+import type { ActionDisplayLevel, ActionType, IActionNotUsable, IActionUsable } from "game/entity/action/IAction";
 import type UsableActionRegistrar from "game/entity/action/usable/UsableActionRegistrar";
 import type { UsableActionTypePlaceholder } from "game/entity/action/usable/UsableActionType";
 import { UsableActionType } from "game/entity/action/usable/UsableActionType";
@@ -141,7 +140,7 @@ export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionR
     /**
      * The icon this action should have, if any.
      */
-    icon?: SupplierOr<UsableActionIconReference, [using: IUsableActionPossibleUsing, action: UsableAction<REQUIREMENTS>]>;
+    icon?: SupplierOr<UsableActionIconReference | false, [using: IUsableActionPossibleUsing, action: UsableAction<REQUIREMENTS>]>;
     /**
      * Where the icon should appear, when slotted with an item. Defaults to bottom right.
      *

package/definitions/game/game/entity/action/usable/UsableActionType.d.ts

@@ -8,60 +8,70 @@
  * 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 { IModdable } from "mod/ModRegistry";
+export declare enum ActionTypeStarts {
+    ActionType = 0,
+    ModActionType = 10000,
+    UsableActionType = 100000,
+    UsableActionTypePlaceholder = 200000,
+    ModUsableActionType = 300000,
+    ModUsableActionTypePlaceholder = 400000
+}
 export declare enum UsableActionType {
-    Use = 1000000,
-    QuickSlotRemove = 1000001,
-    QuickSlotAdd = 1000002,
-    QuickSlotAddToFree = 1000003,
-    QuickSlotAddToSlot = 1000004,
-    MoveToInventory = 1000005,
-    DropMenu = 1000006,
-    DropAll = 1000007,
-    DropAllOfSameQuality = 1000008,
-    RepairWithItem = 1000009,
-    ReinforceWithItem = 1000010,
-    EnhanceWithItem = 1000011,
-    EnchantWithItem = 1000012,
-    TransmogrifyWithItem = 1000013,
-    UpgradeWithItem = 1000014,
-    AlterWithItem = 1000015,
-    RefineWithItem = 1000016,
-    PreserveWithItem = 1000017,
-    AddFuelWithItem = 1000018,
-    IgniteWithItem = 1000019,
-    AbsorbWithItem = 1000020,
-    ExudeWithItem = 1000021,
-    MoveToInventoryMenu = 1000022,
-    MoveToActiveContainerMenu = 1000023,
-    MoveToFacingContainerMenu = 1000024,
-    Move = 1000025,
-    MoveAll = 1000026,
-    MoveAllOfSameQuality = 1000027,
-    TradeTraderSell = 1000028,
-    TradeTraderBuy = 1000029,
-    ItemActions = 1000030,
-    Actions = 1000031,
-    GatherWithHands = 1000032,
-    HarvestWithHands = 1000033,
-    DigWithHands = 1000034,
-    TillWithHands = 1000035,
-    PickUpExcrementWithHands = 1000036,
-    EquipHeld = 1000037,
-    EquipLegs = 1000038,
-    EquipChest = 1000039,
-    EquipHead = 1000040,
-    EquipBelt = 1000041,
-    EquipFeet = 1000042,
-    EquipNeck = 1000043,
-    EquipHands = 1000044,
-    EquipBack = 1000045,
-    EquipMainHand = 1000046,
-    EquipOffHand = 1000047
+    Use = 100000,
+    QuickSlotRemove = 100001,
+    QuickSlotAdd = 100002,
+    QuickSlotAddToFree = 100003,
+    QuickSlotAddToSlot = 100004,
+    MoveToInventory = 100005,
+    DropMenu = 100006,
+    DropAll = 100007,
+    DropAllOfSameQuality = 100008,
+    RepairWithItem = 100009,
+    ReinforceWithItem = 100010,
+    EnhanceWithItem = 100011,
+    EnchantWithItem = 100012,
+    TransmogrifyWithItem = 100013,
+    UpgradeWithItem = 100014,
+    AlterWithItem = 100015,
+    RefineWithItem = 100016,
+    PreserveWithItem = 100017,
+    AddFuelWithItem = 100018,
+    IgniteWithItem = 100019,
+    AbsorbWithItem = 100020,
+    ExudeWithItem = 100021,
+    MoveToInventoryMenu = 100022,
+    MoveToActiveContainerMenu = 100023,
+    MoveToFacingContainerMenu = 100024,
+    Move = 100025,
+    MoveAll = 100026,
+    MoveAllOfSameQuality = 100027,
+    TradeTraderSell = 100028,
+    TradeTraderBuy = 100029,
+    ItemActions = 100030,
+    Actions = 100031,
+    GatherWithHands = 100032,
+    HarvestWithHands = 100033,
+    DigWithHands = 100034,
+    TillWithHands = 100035,
+    PickUpExcrementWithHands = 100036,
+    EquipHeld = 100037,
+    EquipLegs = 100038,
+    EquipChest = 100039,
+    EquipHead = 100040,
+    EquipBelt = 100041,
+    EquipFeet = 100042,
+    EquipNeck = 100043,
+    EquipHands = 100044,
+    EquipBack = 100045,
+    EquipMainHand = 100046,
+    EquipOffHand = 100047
 }
 export declare enum UsableActionTypePlaceholder {
-    TradeItem = 2000000,
-    MoveAllToInventory = 2000001,
-    MoveAllOfSameQualityToInventory = 2000002,
-    Paddle = 2000003,
-    Operate = 2000004
+    TradeItem = 200000,
+    MoveAllToInventory = 200001,
+    MoveAllOfSameQualityToInventory = 200002,
+    Paddle = 200003,
+    Operate = 200004
 }
+export declare const usableActionDescriptions: PartialRecord<UsableActionType | UsableActionTypePlaceholder, IModdable>;

package/definitions/game/game/inspection/infoProviders/UseInfo.d.ts

@@ -14,6 +14,7 @@ import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
 import type { InfoProvider } from "game/inspection/InfoProvider";
 import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
 import type { Quality } from "game/IObject";
+import type Island from "game/island/Island";
 import type Translation from "language/Translation";
 import type { TranslationGenerator } from "ui/component/IComponent";
 export interface IDescribed {
@@ -21,6 +22,7 @@ export interface IDescribed {
     type: number;
     referenceId?: number;
     quality?: Quality;
+    island: Island;
     description(): any;
 }
 export declare type DescribedDescription<T extends IDescribed> = Exclude<ReturnType<T["description"]>, undefined>;

package/definitions/game/game/inspection/infoProviders/doodad/Gatherability.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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 Doodad from "game/doodad/Doodad";
+import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
+import { InfoProvider } from "game/inspection/InfoProvider";
+import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
+export default class GatherabilityInfoProvider extends InfoProvider {
+    private readonly doodad;
+    static get(doodad: Doodad): false | GatherabilityInfoProvider | undefined;
+    private gatherMessage;
+    private constructor();
+    getClass(): string[];
+    getDefaultDisplayLevel(_context: InfoProviderContext): InfoDisplayLevel;
+    hasContent(): boolean;
+    get(): import("../../../../language/impl/TranslationImpl").default;
+    onTickEnd(): void;
+    private getGatherabilityMessage;
+}

package/definitions/game/game/inspection/infoProviders/doodad/Harvestability.d.ts

@@ -15,7 +15,7 @@ import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
 export default class HarvestabilityInfoProvider extends InfoProvider {
     private readonly doodad;
     static get(doodad: Doodad): false | HarvestabilityInfoProvider | undefined;
-    private message;
+    private harvestMessage;
     private constructor();
     getClass(): string[];
     getDefaultDisplayLevel(_context: InfoProviderContext): InfoDisplayLevel;

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

@@ -51,19 +51,20 @@ export interface IItemEvents {
      * @param human The human object
      * @param slot The slot
      */
-    equip?(human: Human, slot: EquipType): void;
+    equip(human: Human, slot: EquipType): any;
     /**
      * Called when the human unequip an item from a slot
      * @param human The human object
      * @param slot The slot
      */
-    unequip?(human: Human, slot: EquipType): void;
+    unequip(human: Human, slot: EquipType): any;
     /**
      * Called when an item is damaged
      * @param modifier The damage modifier
      * @returns The amount of damage the item shouldd take or undefined to use the default logic
      */
-    shouldDamage?(modifier?: number): number | false | undefined;
+    shouldDamage(modifier?: number): number | false | undefined;
+    qualityChange(quality: Quality, oldQuality: Quality): any;
 }
 export default class Item extends EventEmitter.Host<IItemEvents> implements IReferenceable, Partial<IContainer>, IContainable, IUnserializedCallback, IObject<ItemType>, IObjectOptions, IContainable, Partial<IContainer>, ITemperatureSource, IHasInsulation, IHasMagic {
     readonly objectType = CreationId.Item;
@@ -275,7 +276,7 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
      * @param action The ActionType you are trying to get the level for.
      * @returns A number (possibly 0 if no quality or action level).
      */
-    getItemUseBonus(action?: ActionType): number;
+    getItemUseBonus(action: ActionType): number;
     getBestRangedWeapon(human: Human): Item | undefined;
     /**
      * Extinguishes to item if it is lit.

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

@@ -215,12 +215,19 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     countItemsInContainerByGroup(containers: IContainer | IContainer[], itemTypeGroupSearch: ItemTypeGroup, ignoreItem?: Item): number;
     /**
      * Get the best items sorted by how good they are
+     * Usability/custom (ie the sorting for melee/start fire) > Action tier (+quality if there's an action tier on both items) > quality > durability
      */
     getBestSafeItems(human: Human, container: IContainer, options?: Partial<IGetBestItemsOptions>): Item[];
     /**
      * Get the best item
      */
     getBestSafeItem(human: Human, container: IContainer, options?: Partial<IGetBestItemsOptions>): Item | undefined;
+    /**
+     * Gets the item's quality and action level (how good it is at doing the action).
+     * @param action The ActionType you are trying to get the level for.
+     * @returns A number (possibly 0 if no quality or action level).
+     */
+    getItemUseBonus(itemType: ItemType, action: ActionType, quality: Quality | undefined): number;
     getItemInContainer(container: IContainer, itemTypeSearch: ItemType, options?: Partial<IGetItemOptions>): Item | undefined;
     getItemForHuman(human: Human, search: ItemType | ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;
     getItemInContainerByGroup(container: IContainer, itemTypeGroupSearch: ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;

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

@@ -20,7 +20,7 @@ declare class MilestoneModifiersManager extends GameplayModifiersManager<Milesto
     isGlobal(milestone: Milestone): boolean;
     isNotGlobal(milestone: Milestone): boolean;
     getGroup(milestone: Milestone): import("game/options/modifiers/milestone/MilestoneModifier").MilestoneModifierGroup | undefined;
-    sort(a: Milestone, b: Milestone): 0 | 1 | -1;
+    sort(a: Milestone, b: Milestone): 1 | 0 | -1;
     private areOptionsGlobal;
 }
 declare const _default: MilestoneModifiersManager;

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

@@ -47,65 +47,66 @@ declare enum Dictionary {
     Input = 35,
     InspectType = 36,
     InterruptChoice = 37,
-    IslandModifier = 38,
-    IslandName = 39,
-    IslandNameBiomeDescriptor = 40,
-    IslandNameBiomeNoun = 41,
-    IslandNameModifierDescriptor = 42,
-    IslandNameOverrunWithCreatureDescriptor = 43,
-    Item = 44,
-    ItemGroup = 45,
-    JoinServerRetryReason = 46,
-    Level = 47,
-    Loading = 48,
-    Macro = 49,
-    MagicalPropertyType = 50,
-    MapQuality = 51,
-    MenuBarButton = 52,
-    Message = 53,
-    MessagesDefaultFilter = 54,
-    MessagesTimestampMode = 55,
-    Milestone = 56,
-    MilestoneModifierGroup = 57,
-    Misc = 58,
-    ModLoadError = 59,
-    ModLoadFailureReason = 60,
-    ModProvide = 61,
-    ModSort = 62,
-    ModType = 63,
-    MultiplayerCompatibility = 64,
-    MultiplayerDisconnectReason = 65,
-    MusicPlaylist = 66,
-    Note = 67,
-    Npc = 68,
-    Number = 69,
-    PartOfDay = 70,
-    PowerMode = 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,
-    Ui = 90,
-    UiQuadrant = 91,
-    UnableToJoinReason = 92,
-    UnlockedRecipesStrategy = 93,
-    UsableActionType = 94,
-    Website = 95,
-    WeightStatus = 96,
-    WorldLayer = 97
+    InventorySort = 38,
+    IslandModifier = 39,
+    IslandName = 40,
+    IslandNameBiomeDescriptor = 41,
+    IslandNameBiomeNoun = 42,
+    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,
+    PowerMode = 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,
+    Ui = 91,
+    UiQuadrant = 92,
+    UnableToJoinReason = 93,
+    UnlockedRecipesStrategy = 94,
+    UsableActionType = 95,
+    Website = 96,
+    WeightStatus = 97,
+    WorldLayer = 98
 }
 export default Dictionary;