@wayward/types 2.11.4-beta.dev.20220130.1 → 2.11.4-beta.dev.20220204.1

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

@@ -16,7 +16,7 @@ import type { ICausesDamage } from "game/entity/IEntity";
 import type { ICheckUnderOptions, ICrafted, ICustomizations, IHumanEvents, IRestData, RestCancelReason } from "game/entity/IHuman";
 import { EquipType, SkillType } from "game/entity/IHuman";
 import { Stat } from "game/entity/IStats";
-import type { IAttackHand, IMobCheck } from "game/entity/player/IPlayer";
+import type { IAttackHand, IMobCheck, IMovementIntent, IWalkPath } from "game/entity/player/IPlayer";
 import { WeightStatus, PlayerState } from "game/entity/player/IPlayer";
 import PlayerDefense from "game/entity/player/PlayerDefense";
 import SkillManager from "game/entity/skill/SkillManager";
@@ -36,7 +36,7 @@ import type TileEvent from "game/tile/TileEvent";
 import Message from "language/dictionary/Message";
 import Translation from "language/Translation";
 import type { IOptions } from "save/data/ISaveDataGlobal";
-import type { IVector3 } from "utilities/math/IVector";
+import type { IVector2, IVector3 } from "utilities/math/IVector";
 export declare const REPUTATION_MAX = 64000;
 export default abstract class Human extends Entity implements IHasInsulation {
     static getNameTranslation(): import("../../language/impl/TranslationImpl").default;
@@ -50,14 +50,16 @@ export default abstract class Human extends Entity implements IHasInsulation {
     equippedReferences: Map<EquipType, ItemReference>;
     handToUse: EquipType | undefined;
     inventory: IContainer;
-    islandId: IslandId;
     options: Readonly<IOptions>;
+    islandId: IslandId;
     readonly equipEffects: Map<EquipEffect, EquipEffects>;
     restData: IRestData | undefined;
     score: number;
     state: PlayerState;
     swimming: boolean;
     vehicleItemReference: ItemReference | undefined;
+    readonly movementIntent: IMovementIntent;
+    walkPath: IWalkPath | undefined;
     identifier: string;
     skill: SkillManager;
     private readonly privateStore;
@@ -107,6 +109,10 @@ export default abstract class Human extends Entity implements IHasInsulation {
     burn(fireType: FireType, skipMessage?: boolean, skipParry?: boolean, equipType?: EquipType, fromCombat?: boolean): number | undefined;
     setPosition(point: IVector3): void;
     setZ(z: number, updateFlowField?: boolean): void;
+    getMovementIntent(): IMovementIntent;
+    updateMovementIntent(movementIntent: IMovementIntent): boolean;
+    hasWalkPath(): boolean;
+    walkAlongPath(path: IVector2[] | undefined, force?: boolean): void;
     checkUnder(inFacingDirection?: boolean, options?: ICheckUnderOptions): ICheckUnderOptions;
     damageByInteractingWith(thing: Doodad | TileEvent, options: ICheckUnderOptions | undefined, damageLocation: EquipType): ICheckUnderOptions;
     equip(item: Item, slot: EquipType): boolean;
@@ -137,6 +143,10 @@ export default abstract class Human extends Entity implements IHasInsulation {
     isSwimming(): boolean;
     updateSwimming(): void;
     updatePaddling(): void;
+    /**
+     * Returns the bartering bonus for a given credit value
+     */
+    getBarteringBonus(baseCredits: number): number;
     getInsulation(type: TempType): number;
     protected resetStatTimers(type?: StatChangeCurrentTimerStrategy): void;
     protected getBaseStatBonuses(): OptionalDescriptions<Stat, number>;

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

@@ -17,7 +17,7 @@ import type { AttackType } from "game/entity/IEntity";
 import type { WeightStatus } from "game/entity/player/IPlayer";
 import type { ISkillEvents } from "game/entity/skill/SkillManager";
 import type { IHasImagePath, Quality } from "game/IObject";
-import type { ItemType } from "game/item/IItem";
+import type { IContainer, ItemType } from "game/item/IItem";
 import { RecipeLevel } from "game/item/IItem";
 import type Item from "game/item/Item";
 import { TempType } from "game/temperature/ITemperature";
@@ -25,8 +25,28 @@ import type { ITile } from "game/tile/ITerrain";
 import type { IModdable } from "mod/ModRegistry";
 import type { IRGB } from "utilities/Color";
 import type { Direction } from "utilities/math/Direction";
+import type { IVector2 } from "utilities/math/IVector";
 import type { IRange } from "utilities/math/Range";
 export interface IHumanEvents extends Events<Entity>, ISkillEvents {
+    /**
+     * Called when an item is added to the player's inventory
+     * @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.
+     */
+    inventoryItemAdd(item: Item, container: IContainer): any;
+    /**
+     * Called when an item is removed from the players inventory
+     * @param item The item object
+     * @param container The container object the item was moved to.
+     */
+    inventoryItemRemove(item: Item, container: IContainer): any;
+    /**
+     * Called when an item is moved from one container to another, while still in the players inventory.
+     * @param item The item object
+     * @param container The container object the item was moved to. This container might be inventory or a container within the inventory.
+     * @param previousContainer The container object the item was moved from. This container might be inventory or a container within the inventory.
+     */
+    inventoryItemUpdate(item: Item, container: IContainer, previousContainer?: IContainer): any;
     /**
      * Called when the human faces a different direction
      * @param direction The direction the player is now facing
@@ -67,6 +87,10 @@ export interface IHumanEvents extends Events<Entity>, ISkillEvents {
      * @returns True if the human should be swimming, false if they should not be swimming, or undefined to use the default logic
      */
     isSwimming(isSwimming: boolean): boolean | undefined;
+    /**
+     * Called when the walk path of the player changes.
+     */
+    walkPathChange(walkPath: IVector2[] | undefined): any;
     /**
      * Called when a book is opened by a player
      * @param book The book that was opened

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

@@ -100,7 +100,7 @@ declare const actionDescriptions: {
     32: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
     82: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default, void, [(import("../../item/Item").default | undefined)?]>;
     2: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.AttackType, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [(import("../../item/Item").default | undefined)?, (import("../IEntity").AttackType | undefined)?]>;
-    67: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory]], import("../player/Player").default, void, [import("../../item/Item").default]>;
+    67: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory]], import("../player/Player").default | import("../npc/NPC").default, void, [import("../../item/Item").default]>;
     103: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.Container, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.Boolean, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../player/Player").default | import("../npc/NPC").default, void, [(import("../../item/IItem").IContainer | undefined)?, (boolean | undefined)?]>;
     102: import("./Action").Action<[], import("../player/Player").default | import("../npc/NPC").default, boolean, []>;
     101: import("./Action").Action<[], import("../player/Player").default | import("../npc/NPC").default, void, []>;

package/definitions/game/game/entity/action/actions/Till.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.ItemInventory]], import("../../player/Player").default, void, [import("../../../item/Item").default]>;
+declare const _default: Action<[[ActionArgument.ItemInventory]], import("../../player/Player").default | import("../../npc/NPC").default, void, [import("../../../item/Item").default]>;
 export default _default;

package/definitions/game/game/entity/creature/Creature.d.ts

@@ -82,10 +82,10 @@ export default class Creature extends Entity implements IUnserializedCallback, I
     checkUnder(x?: number, y?: number): boolean;
     /**
      * Check if this creature can swap with the player in the event that the player is moving into them
-     * @param player Player object
+     * @param human Human object
      * @param source Source string. Set to undefined if this is being called from the clientside
      */
-    canSwapWith(player: Player, source: string | undefined): boolean;
+    canSwapWith(human: Human, source: string | undefined): boolean;
     getOwner(): Player | undefined;
     damage(damageInfo: IDamageInfo): number | undefined;
     damage(damageInfo: IDamageInfo, creatureX?: number, creatureY?: number, creatureZ?: number): number | undefined;

package/definitions/game/game/entity/creature/Pathing.d.ts

@@ -8,7 +8,7 @@
  * 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 type Human from "game/entity/Human";
 import type Island from "game/island/Island";
 import type { ITile } from "game/tile/ITerrain";
 import type { IVector2 } from "utilities/math/IVector";
@@ -24,7 +24,7 @@ declare const _default: {
     /**
      * Returns whether the tile is blocked (completely impassible)
      */
-    isWalkToTileBlocked(player: Player, tile: ITile, pos: IVector2, clientSide: boolean): boolean;
+    isWalkToTileBlocked(human: Human, tile: ITile, pos: IVector2, clientSide: boolean): boolean;
     readonly event: import("event/EventEmitter").IEventEmitter<any, IPathingEvents>;
 };
 export default _default;

package/definitions/game/game/entity/npc/NPC.d.ts

@@ -89,10 +89,6 @@ export default abstract class NPC extends Human {
      * Sets the default weightCapacity of an NPC (based on their equipment and starting items).
      */
     generateWeightCapacity(): void;
-    /**
-     * Returns the bartering bonus for a given credit value
-     */
-    getBarteringBonus(baseCredits: number): number;
     getName(): import("../../../language/impl/TranslationImpl").default;
     protected getApplicableStatusEffects(): Set<StatusType>;
     /**
@@ -129,7 +125,7 @@ export default abstract class NPC extends Human {
     protected autoScaleStats(): void;
     protected preMove(fromX: number, fromY: number, fromZ: number, fromTile: ITile, toX: number, toY: number, toZ: number, toTile: ITile): boolean | void | undefined;
     protected postMove(): void;
-    private checkMove;
+    protected checkMove(moveType: MoveType, tileX: number, tileY: number, tileZ: number): 0 | -1 | -2 | -3 | -4 | -5;
     get asNPC(): NPC;
     get asPlayer(): undefined;
     get asLocalPlayer(): undefined;

package/definitions/game/game/entity/player/IPlayer.d.ts

@@ -21,7 +21,6 @@ import type { INote } from "game/entity/player/note/NoteManager";
 import type Player from "game/entity/player/Player";
 import type { IslandId } from "game/island/IIsland";
 import type Island from "game/island/Island";
-import type { IContainer } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
 import type { Prompt } from "game/meta/prompt/IPrompt";
@@ -115,25 +114,6 @@ export interface IPlayerEvents extends Events<Human> {
      * Called when the player attempts to sail off the edge of the map
      */
     sailOffMapEdge(direction: Direction): any;
-    /**
-     * Called when an item is added to the player's inventory
-     * @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.
-     */
-    inventoryItemAdd(item: Item, container: IContainer): any;
-    /**
-     * Called when an item is removed from the players inventory
-     * @param item The item object
-     * @param container The container object the item was moved to.
-     */
-    inventoryItemRemove(item: Item, container: IContainer): any;
-    /**
-     * Called when an item is moved from one container to another, while still in the players inventory.
-     * @param item The item object
-     * @param container The container object the item was moved to. This container might be inventory or a container within the inventory.
-     * @param previousContainer The container object the item was moved from. This container might be inventory or a container within the inventory.
-     */
-    inventoryItemUpdate(item: Item, container: IContainer, previousContainer?: IContainer): any;
     /**
      * Called when the player equips an item to a slot
      * @param player The player object

package/definitions/game/game/entity/player/Player.d.ts

@@ -19,7 +19,7 @@ import type { ICheckUnderOptions, IRestData } from "game/entity/IHuman";
 import { EquipType, RestCancelReason, SkillType } from "game/entity/IHuman";
 import type { IStat } from "game/entity/IStats";
 import { Stat } from "game/entity/IStats";
-import type { ILoadOnIslandOptions, IMovementIntent, IPlayerEvents, IWalkPath } from "game/entity/player/IPlayer";
+import type { ILoadOnIslandOptions, IMovementIntent, IPlayerEvents } from "game/entity/player/IPlayer";
 import { TurnType } from "game/entity/player/IPlayer";
 import MessageManager from "game/entity/player/MessageManager";
 import NoteManager from "game/entity/player/note/NoteManager";
@@ -71,7 +71,6 @@ export default class Player extends Human implements IUnserializedCallback {
     quests: QuestManager;
     messages: MessageManager;
     notes: NoteManager;
-    walkPath: IWalkPath | undefined;
     exploredMap: ExploreMap[] | undefined;
     finishedMovingClientside: boolean;
     nextX: number;
@@ -81,7 +80,6 @@ export default class Player extends Human implements IUnserializedCallback {
     nextMoveTime: number;
     nextMoveDirection: Direction.Cardinal | Direction.None | undefined;
     displayCreature?: CreatureType;
-    private readonly _movementIntent;
     private readonly milestonesCollection;
     private gameOptionsCached?;
     private handEquippedToLast;
@@ -122,8 +120,7 @@ export default class Player extends Human implements IUnserializedCallback {
     equip(item: Item, slot: EquipType, internal?: boolean, switchingHands?: boolean): boolean;
     unequip(item: Item, internal?: boolean, skipMessage?: boolean, skipRevertItem?: boolean): void;
     unequipAll(): void;
-    getMovementIntent(): IMovementIntent;
-    updateMovementIntent(movementIntent: IMovementIntent): void;
+    updateMovementIntent(movementIntent: IMovementIntent): boolean;
     resetStatTimers(type?: StatChangeCurrentTimerStrategy): void;
     /**
      * Gets the max health of the player.
@@ -189,7 +186,6 @@ export default class Player extends Human implements IUnserializedCallback {
     respawn(reset: boolean): Promise<void>;
     getMovementProgress(): number;
     checkUnder(inFacingDirection?: boolean, options?: ICheckUnderOptions): ICheckUnderOptions;
-    hasWalkPath(): boolean;
     walkAlongPath(path: IVector2[] | undefined, force?: boolean): void;
     /**
      * This is only ran on the server
@@ -210,10 +206,6 @@ export default class Player extends Human implements IUnserializedCallback {
      * 2. If a mod is using the `GetPlayerStrength` hook and the calculation needs to be refreshed.
      */
     updateStrength(): void;
-    /**
-     * Returns the bartering bonus for a given credit value
-     */
-    getBarteringBonus(baseCredits: number): number;
     /**
      * Check if a position is marked as explored
      * Only use this clientside

package/definitions/game/game/inspection/inspections/IslandInspection.d.ts

@@ -13,13 +13,13 @@ import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
 import LabelledValue from "game/inspection/infoProviders/LabelledValue";
 import Inspection from "game/inspection/Inspection";
 import Island from "game/island/Island";
-import Vector2 from "utilities/math/Vector2";
-export default class IslandInspection extends Inspection<Vector2> {
+import type { IVector2 } from "utilities/math/IVector";
+export default class IslandInspection extends Inspection<IVector2> {
     private readonly title;
     static getIslandName(island?: Island, useGenerated?: boolean): import("../../../language/impl/TranslationImpl").default;
     static handles(type: InspectType, island: unknown): boolean;
     get island(): Island | undefined;
-    constructor(island: Island | Vector2, title?: boolean);
+    constructor(island: Island | IVector2, title?: boolean);
     getId(): string;
     get(context: InfoProviderContext): (import("game/inspection/InfoProvider").SimpleInfoProvider | LabelledValue)[];
     private getTreasureMaps;

package/definitions/game/game/inspection/inspections/NPCInspection.d.ts

@@ -9,11 +9,12 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import NPC from "game/entity/npc/NPC";
+import { InspectType } from "game/inspection/IInspection";
 import HumanInspection from "game/inspection/inspections/HumanInspection";
 import type { IVector3 } from "utilities/math/IVector";
 export default class NPCInspection extends HumanInspection<NPC> {
     static getFromTile(position: IVector3): never[] | NPCInspection;
-    static handles(npc: unknown): boolean;
+    static handles(type: InspectType, npc: unknown): boolean;
     constructor(npc: NPC);
     getBorder(): string;
 }

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

@@ -17,7 +17,6 @@ import type Entity from "game/entity/Entity";
 import type Human from "game/entity/Human";
 import { DamageType, EntityType } from "game/entity/IEntity";
 import { EquipType, SkillType } from "game/entity/IHuman";
-import type NPC from "game/entity/npc/NPC";
 import type Player from "game/entity/player/Player";
 import { CreationId } from "game/IGame";
 import type { IObject, IObjectOptions } from "game/IObject";
@@ -202,22 +201,22 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
     rerollMagicalPropertyValues(): void;
     addMagicalProperty(type: MagicalPropertyType, subType?: MagicalSubPropertySubTypes): boolean;
     getMagicalPropertyInfo(type: MagicalPropertyType): IMagicalPropertyInfo | undefined;
-    acquireNotify(player: Player): void;
+    acquireNotify(human: Human): void;
     getStokeFireValue(): number | undefined;
     getStokeFireBonusValue(): number;
     getOnUseBonus(): number;
     /**
      * Gets the worth of an item used for merchant trading. Does not consider batering or modifiers bonuses; use Item.getTraderSellPrice for that.
-     * @param player The player that is trading the item for its worth (used for durability calculations).
+     * @param human The human that is trading the item for its worth (used for durability calculations).
      * @param magicalWorth Include the value of `MagicalPropertyType.Worth`, defaults to true
      */
-    getWorth(player: Player | undefined, magicalWorth?: boolean): number;
+    getWorth(human: Human | undefined, magicalWorth?: boolean): number;
     /**
-     * The full price the item will go for when traded to a merchant NPC. Considers modifiers and a player's bartering skill.
-     * @param player The player that is trading the item.
+     * The full price the item will go for when traded to a merchant NPC. Considers modifiers and a human's bartering skill.
+     * @param human The human that is trading the item.
      * @param magicalWorth Include the value of `MagicalPropertyType.Worth`, defaults to true
      */
-    getTraderSellPrice(player: Player | undefined, magicalWorth?: boolean): number;
+    getTraderSellPrice(human: Human | undefined, magicalWorth?: boolean): number;
     canBurnPlayer(): boolean;
     getBaseDefense(): number;
     getDurabilityCharge(): number;
@@ -259,12 +258,12 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
      * @returns A number (possibly 0 if no quality or action level).
      */
     getItemUseBonus(action: ActionType): number;
-    getRangedWeapon(player: Player | NPC): Item | boolean;
+    getRangedWeapon(human: Human): Item | boolean;
     /**
      * Extinguishes to item if it is lit.
-     * @param player Player or NPC entity that is carrying the item to extinguish.
+     * @param human Human entity that is carrying the item to extinguish.
      */
-    extinguish(player: Player | NPC | undefined): void;
+    extinguish(human: Human | undefined): void;
     /**
      * Get the maximum durability for an item based on many factors.
      * @param human Player that we checking to get the maximum item durability (as game options can affect this).

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

@@ -200,7 +200,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     isItemInContainer(container: IContainer, itemTypeSearch: ItemType, options?: Partial<IGetItemOptions>): boolean;
     isContainableInContainer(containable: IContainable, container: IContainer): boolean;
     getAdjacentContainers(humanOrPosition: Human | IVector3, includeNpcs?: boolean, ignoreOptions?: boolean): IContainer[];
-    isContainableInAdjacentContainer(player: Player, containable: IContainable, includeNpcs?: boolean, ignoreOptions?: boolean): boolean;
+    isContainableInAdjacentContainer(human: Human, containable: IContainable, includeNpcs?: boolean, ignoreOptions?: boolean): boolean;
     isInInventory(containable: IContainable): boolean;
     isTileContainer(container: IContainer | undefined): boolean;
     /**
@@ -253,11 +253,11 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     /**
      * Summons a void dweller based on item worth and chance or provides a hint message.
      * @param item Item to get the worth of.
-     * @param player The player that is dropping the item.
+     * @param human The human that is dropping the item.
      * @param point The point in which we are dropping the item.
      * @returns True or false based on if we get a message or not.
      */
-    summonVoidDweller(item: Item, player: Player | NPC, point: IVector3): boolean;
+    summonVoidDweller(item: Item, human: Human, point: IVector3): boolean;
     /**
      * Note: don't print items to the console because the console will hold the item indefinitely
      */

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 | Player[] | readonly Milestone[] | readonly ItemType[] | readonly SkillType[] | IterableIterator<Island> | 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 SkillType[] | readonly ItemType[] | IterableIterator<Island> | readonly Stat[];
     private referenceCursor;
     create(): number;
     get(thing: Referenceable): Reference | undefined;

package/package.json

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