@wayward/types 2.11.3-beta.dev.20220124.1 → 2.11.4-beta.dev.20220128.1

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

@@ -8,11 +8,9 @@
  * 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 { IMoveTypeZ } from "game/entity/creature/ICreatureManager";
 import type Entity from "game/entity/Entity";
-import type { IEntityManager } from "game/entity/IEntityManager";
+import type { IEntityManager, IPlayerBound } from "game/entity/IEntityManager";
 import { ObjectManager } from "game/ObjectManager";
-import Bound3 from "utilities/math/Bound3";
 export interface IEntityManagerEvents<T extends Entity> {
     spawn(entity: T): any;
     remove(entity: T): any;
@@ -25,10 +23,8 @@ export interface IEntityCanCreateOptions {
     chanceOfScarecrowScare?: number;
 }
 export default abstract class EntityManager<T extends Entity> extends ObjectManager<T, IEntityManagerEvents<T>> implements IEntityManager<T> {
-    private readonly moveTypesInFov;
     remove(entity: T): void;
-    updateFov(bounds: Bound3[]): number;
-    getMoveTypesInFov(): IMoveTypeZ[];
+    updateFov(playerBounds: IPlayerBound[]): void;
     /**
      * Checks if the target position is a good spot for a new entity
      */

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

@@ -9,15 +9,14 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Entity from "game/entity/Entity";
-import type { MoveType } from "game/entity/IEntity";
+import type Player from "game/entity/player/Player";
 import type { IBound3 } from "utilities/math/Bound3";
 export interface IEntityManager<T extends Entity> {
     remove(entity: T): void;
-    updateFov(bounds: IBound3[]): number;
-    getMoveTypesInFov(): IMoveTypeZ[];
+    updateFov(playerBounds: IPlayerBound[]): void;
 }
 export default IEntityManager;
-export interface IMoveTypeZ {
-    moveType: MoveType;
-    z: number;
+export interface IPlayerBound {
+    player: Player;
+    bound: IBound3;
 }

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

@@ -9,12 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { CreatureType } from "game/entity/creature/ICreature";
-import type { MoveType } from "game/entity/IEntity";
 export interface ISpawnableCreatures {
     pool: CreatureType[];
     aberrantChance: number;
 }
-export interface IMoveTypeZ {
-    moveType: MoveType;
-    z: number;
-}

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

@@ -219,6 +219,12 @@ export default class Player extends Human implements IUnserializedCallback {
      * Only use this clientside
      */
     isExploredClientSide(x: number, y: number, z: number): boolean;
+    /**
+     * Multiply the reputation amount with whatever is set via milestone modifiers or custom game options for this player.
+     * @param reputation A number or undefined to be mutiplied.
+     * @returns A number or undefined if a reputation number was not passed.
+     */
+    getReputationMultiplier(reputation: number | undefined): number | undefined;
     /**
      * @deprecated Do not call this with players.
      */

package/definitions/game/game/island/Island.d.ts

@@ -20,7 +20,8 @@ import type Human from "game/entity/Human";
 import { SkillType } from "game/entity/IHuman";
 import NPCManager from "game/entity/npc/NPCManager";
 import Player from "game/entity/player/Player";
-import { CreationId, FireType, IGameOld, TickFlag, TileUpdateType } from "game/IGame";
+import type { IGameOld } from "game/IGame";
+import { CreationId, FireType, TickFlag, TileUpdateType } from "game/IGame";
 import { Quality } from "game/IObject";
 import type { IIslandEvents, IIslandLoadOptions, ISeeds, IWaterContamination, IWaterFill, IWell } from "game/island/IIsland";
 import { WaterType } from "game/island/IIsland";
@@ -95,6 +96,11 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
      * Set of players on this island
      */
     readonly players: Set<Player>;
+    /**
+     * Entity move types in fov on this island
+     * `${z}-${moveType}` -> Players
+     */
+    readonly moveTypesInFov: Map<string, Set<Player>>;
     previousSaveVersion: IVersionInfo | undefined;
     brokenReferencesCount: number;
     civilizationScore: number;

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

@@ -10,8 +10,34 @@
  */
 import type Doodad from "game/doodad/Doodad";
 import type { DoodadType, DoodadTypeGroup } from "game/doodad/IDoodad";
+import type { ActionType } from "game/entity/action/IAction";
+import type Item from "game/item/Item";
 import type TileEvent from "game/tile/TileEvent";
 import type { IVector3 } from "utilities/math/IVector";
+/**
+ * Includes all protected items by default
+ */
+export interface IGetItemOptions {
+    /**
+     * True to exclude protected items
+     */
+    excludeProtectedItems: boolean;
+    /**
+     * True to only include protected items if they pass an item.willBreakOnDamage() check.
+     * excludeProtectedItems must be set to true for this to work.
+     */
+    includeProtectedItemsThatWillNotBreak: ActionType;
+    /**
+     * Item will be ignored
+     */
+    ignoreItem?: Item;
+}
+export interface IGetItemsOptions extends IGetItemOptions {
+    /**
+     * Include sub containers in the search
+     */
+    includeSubContainers: boolean;
+}
 export declare enum CraftStatus {
     Invalid = 0,
     Failed = 1,

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

@@ -17,7 +17,7 @@ import type Player from "game/entity/player/Player";
 import { Quality } from "game/IObject";
 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";
+import type { IAddToContainerOptions, IGetItemOptions, IGetItemsOptions, IRequirementInfo } from "game/item/IItemManager";
 import { CraftStatus, WeightType, ContainerReferenceSource } from "game/item/IItemManager";
 import Item from "game/item/Item";
 import type ItemRecipeRequirementChecker from "game/item/ItemRecipeRequirementChecker";
@@ -188,16 +188,16 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     /**
      * Get the best tier item
      */
-    getBestSafeItemInContainerByUse(container: IContainer, action: ActionType, allowProtectedItems?: boolean, actionMayDamageItem?: boolean, consumable?: boolean): Item | undefined;
-    getItemInContainer(container: IContainer, itemTypeSearch: ItemType, ignoreItem?: Item, allowProtectedItems?: boolean): Item | undefined;
-    getItemForHuman(human: Human, search: ItemType | ItemTypeGroup, ignoreItem?: Item, allowProtectedItems?: boolean): Item | undefined;
-    getItemInContainerByGroup(container: IContainer, itemTypeGroupSearch: ItemTypeGroup, ignoreItem?: Item, allowProtectedItems?: boolean): Item | undefined;
+    getBestSafeItemInContainerByUse(container: IContainer, action: ActionType, options?: Partial<IGetItemsOptions>, consumable?: boolean): Item | undefined;
+    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;
     getItemInAdjacentContainersByGroup(position: IVector3, itemTypeGroupSearch: ItemTypeGroup): Item | undefined;
-    getItemsInContainer(container: IContainer, includeSubContainers?: boolean, allowProtectedItems?: boolean): Item[];
-    getItemsInContainerByType(container: IContainer, itemType: ItemType, includeSubContainers?: boolean, filterText?: string): Item[];
-    getItemsInContainerByGroup(container: IContainer, itemGroup: ItemTypeGroup, includeSubContainers?: boolean): Item[];
-    getItemInInventoryByGroup(human: Human, itemTypeGroupSearch: ItemTypeGroup, ignoreItem?: Item): Item | undefined;
-    isItemInContainer(container: IContainer, itemTypeSearch: ItemType, ignoreItem?: Item): boolean;
+    getItemsInContainer(container: IContainer, options?: Partial<IGetItemsOptions>): Item[];
+    getItemsInContainerByType(container: IContainer, itemType: ItemType, options?: Partial<IGetItemsOptions>, filterText?: string): Item[];
+    getItemsInContainerByGroup(container: IContainer, itemGroup: ItemTypeGroup, options?: Partial<IGetItemsOptions>): Item[];
+    getItemInInventoryByGroup(human: Human, itemTypeGroupSearch: ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;
+    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;
@@ -207,7 +207,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
      * Returns ordered items for the containers
      * Note: It may return the real containedItems array!
      */
-    getOrderedContainerItems(container: IContainer, allowProtectedItems?: boolean): Item[];
+    getOrderedContainerItems(container: IContainer, options?: Partial<IGetItemOptions>): Item[];
     reduceDismantleWeight(createdItems: Item[], itemWeight: number): void;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup): Translation;
     getItemTypeTranslation(itemType: ItemType | ItemTypeGroup, count: number): Translation;

package/definitions/game/multiplayer/IMultiplayer.d.ts

@@ -105,6 +105,8 @@ export declare enum MultiplayerSyncCheck {
 export declare const maxPlayers = 32;
 export declare const packetTickRate = 16;
 export declare const defaultServerPort = 38740;
+export declare const defaultSshServerPort = 38742;
+export declare const defaultSshServerUsername = "wayward";
 export declare const steamLobbyPrefix = "steam:";
 export declare const checkConnectionMatchmakingId = "check";
 export declare const defaultSyncChecks: MultiplayerSyncCheck[];

package/definitions/game/multiplayer/dedicatedServer/ssh/ISsh.d.ts

@@ -8,6 +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 * as ssh2 from "ssh2";
 import type Log from "utilities/Log";
 export declare const globalHistory: Map<string, string[]>;
 export declare const maxHistory = 50;
@@ -20,7 +21,7 @@ export interface ISshStream {
         toString(): string;
     }) => void): void;
 }
-export interface ISshSession {
+export interface ISshSession extends ssh2.Session {
     clientId: string;
     clientLog: Log;
 }

package/definitions/game/multiplayer/dedicatedServer/ssh/SshServer.d.ts

@@ -8,9 +8,10 @@
  * 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 * as ssh2 from "ssh2";
 import type { IFileSystem } from "@hosts/shared/ipc/fileSystem";
 export interface ISshServerOptions {
-    ssh2: any;
+    ssh2: typeof ssh2;
     crypto: any;
     fs: IFileSystem;
     serverName: string;

package/definitions/game/renderer/fieldOfView/FieldOfView.d.ts

@@ -62,7 +62,7 @@ export default class FieldOfView extends EventEmitter.Host<IFieldOfViewEvents> {
     /**
      * Gets the field of view radius based on either the field of view object, player, or the default value
      */
-    private static getRadius;
+    static getRadius(fieldOfView: FieldOfView | undefined, player: Player | undefined): number;
     /**
      * Marks a set of tiles as exploreed
      */

package/definitions/game/steamworks/ISteamworks.d.ts

@@ -35,8 +35,8 @@ export interface IDedicatedServerInfo {
         dailyChallenge?: boolean;
     };
     ssh: boolean;
-    sshPort?: number;
-    sshUsername?: string;
+    sshPort: number;
+    sshUsername: string;
     sshPassword?: string;
     devMode: boolean;
     syncChecks: MultiplayerSyncCheckLevel;

package/definitions/game/ui/component/dropdown/CreatureDropdown.d.ts

@@ -12,5 +12,5 @@ import { CreatureType } from "game/entity/creature/ICreature";
 import type { IDropdownOption } from "ui/component/Dropdown";
 import EnumDropdown from "ui/component/dropdown/EnumDropdown";
 export default class CreatureDropdown<OTHER_OPTIONS extends string = never> extends EnumDropdown<typeof CreatureType, OTHER_OPTIONS> {
-    constructor(defaultOption: OTHER_OPTIONS | CreatureType, options: Iterable<IDropdownOption<OTHER_OPTIONS>>);
+    constructor(defaultOption: OTHER_OPTIONS | CreatureType, options?: Iterable<IDropdownOption<OTHER_OPTIONS>>);
 }

package/definitions/game/ui/old/screens/InGameScreen.d.ts

@@ -8,6 +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 { ActionType } from "game/entity/action/IAction";
 import { EquipType } from "game/entity/IHuman";
 import type { IContainer, IDismantleComponent } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";
@@ -79,7 +80,6 @@ export default class InGameScreen extends BaseScreen {
     actionsMenuCentered: boolean;
     private activeContainer;
     private multipleContainersOpened;
-    private contextMenuBindPressed;
     private sortableElement;
     private sortableElementPosition;
     private sortableElementTargetContainer;
@@ -237,7 +237,6 @@ export default class InGameScreen extends BaseScreen {
     onItemEquipToggle(api: IBindHandlerApi): boolean;
     onItemProtectToggle(api: IBindHandlerApi): boolean;
     onContextMenu(api: IBindHandlerApi): boolean;
-    onContextMenuReleased(_api: IBindHandlerApi): void;
     onQuickSlotToggle(api: IBindHandlerApi): boolean;
     onQuickSlot(api: IBindHandlerApi): boolean;
     onQuickSlotClear(api: IBindHandlerApi): boolean;
@@ -252,6 +251,7 @@ export default class InGameScreen extends BaseScreen {
     onHandToggle(api: IBindHandlerApi): boolean;
     onInput(api: IBindHandlerApi): void;
     private clearActionsMenuTileOverlay;
+    getAutoActionItem(actionType: ActionType, allowProtectedItems?: boolean): Item | undefined;
     private runAutoAction;
     private runAction;
     private updateContextMenu;

package/definitions/game/utilities/SearchParams.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * 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
+ */
+declare module SearchParams {
+    function hasSwitch(switchName: string): boolean;
+    function getSwitchValue(switchName: string): string | undefined;
+}
+export default SearchParams;

package/definitions/hosts/shared/globals.d.ts

@@ -8,6 +8,6 @@
  * 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
  */
-export declare const gameVersionStage = "beta", gameVersionMajor = 2, gameVersionMinor = 11, gameVersionPatch = 3, gameVersionName = "Horizons";
+export declare const gameVersionStage = "beta", gameVersionMajor = 2, gameVersionMinor = 11, gameVersionPatch = 4, gameVersionName = "Horizons";
 export declare const gameVersion: string;
 export declare function registerGlobals(globalObject: any): void;

package/package.json

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

package/tsconfig.mod.base.json

@@ -1,6 +1,6 @@
 {
     "compilerOptions": {
-        "target": "ES2019",
+        "target": "ES2021",
         "module": "AMD",
         "composite": true,
         "experimentalDecorators": true,
@@ -36,13 +36,10 @@
         },
         "types": [],
         "lib": [
-            "WebWorker.ImportScripts",
             "DOM",
             "DOM.Iterable",
-            "ScriptHost",
-            "ES2019",
-            "ES2020.String",
-            "ES2021.WeakRef"
+            "ES2021",
+            "WebWorker.ImportScripts",
         ]
     }
 }