@wayward/types 2.12.1-beta.dev.20221012.1 → 2.12.1-beta.dev.20221014.1

package/definitions/game/game/Game.d.ts

@@ -90,7 +90,17 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     readonly saveLoad: typeof SaveLoad;
     toString(): string;
     get isPaused(): boolean;
-    getPlayingHumans(includeGhosts?: boolean, includeConnecting?: boolean, includeServer?: boolean): Human[];
+    /**
+     * Get humans in the game; ie, players, NPCs, and other non-player humans.
+     * Parameters include additional players that may not be relevant, such as ghosts, connecting players, absent players, the dedicated server fake player.
+     * Only want players? @see {@link PlayerManager.getAll}
+     * @param includeGhosts True to include players that are ghosts
+     * @param includeConnecting True to include players that are connecting
+     * @param includeDedicatedServer True to include the dedicated server fake player
+     * @param includeAbsent True to include the absent players
+     * @returns Array of Human objects
+     */
+    getPlayingHumans(includeGhosts?: boolean, includeConnecting?: boolean, includeDedicatedServer?: boolean, includeAbsent?: boolean): Human[];
     getNonPlayerHumans(): Human[];
     initializeRenderer(): void;
     globalSlotReady(): void;

package/definitions/game/game/IGame.d.ts

@@ -24,6 +24,7 @@ import type { ITileContainer, ITileData } from "game/tile/ITerrain";
 import type TileEvent from "game/tile/TileEvent";
 import type TimeManager from "game/time/TimeManager";
 import type { IMultiplayerOptions, IMultiplayerWorldData, ServerInfo } from "multiplayer/IMultiplayer";
+import type Renderer from "renderer/Renderer";
 import type { IReplayLogEntry } from "replay/IReplayLogEntry";
 import type { IHighscoreOld, IOptions } from "save/data/ISaveDataGlobal";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
@@ -81,6 +82,10 @@ export interface IGameEvents {
     glLostContext(): any;
     glSetup(restored: boolean): any;
     glInitialized(): any;
+    /**
+     * Called when the game creates the primary renderer
+     */
+    rendererCreated(renderer: Renderer): any;
     /**
      * Called after the field of view has initialized
      */

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

@@ -76,6 +76,7 @@ export default abstract class Human extends Entity implements IHasInsulation {
     state: PlayerState;
     swimming: boolean;
     tamedCreatures: Map<`${number},${number}`, number[]>;
+    ticksSpent: Map<`${number},${number}`, number>;
     turns: number;
     vehicleItemReference: ItemReference | undefined;
     walkSoundCounter: number;
@@ -245,6 +246,7 @@ export default abstract class Human extends Entity implements IHasInsulation {
     private recalculateInsulation;
     private getEquipmentInsulation;
     discoverRecipe(recipeType: ItemType, crafted?: ICrafted, discoveredClientSide?: boolean): void;
+    incrementIslandTickCount(): void;
     passTurn(turnType?: TurnTypeFlag): void;
     /**
      * Ticks a player

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

@@ -65,6 +65,7 @@ declare class UsableAction<REQUIREMENTS extends IUsableActionRequirements = IUsa
     private translator?;
     getTranslation(using?: IUsableActionPossibleUsing, which?: ActionTranslation, context?: UsableActionDisplayContext): Translation | undefined;
     getOrder(using?: IUsableActionPossibleUsing): number;
+    canUseOnMoveWhenDiscovered(): boolean;
     canUseOnMove(): boolean;
 }
 export interface IUsableActionFactory<REQUIREMENTS extends IUsableActionRequirements> {

package/definitions/game/game/entity/action/usable/actions/item/UsableActionsUseItem.d.ts

@@ -12,6 +12,8 @@ import { ActionType } from "game/entity/action/IAction";
 import type { IUsableActionDynamicDefinition } from "game/entity/action/usable/actions/UsableActionsDynamic";
 import UsableActionsDynamic from "game/entity/action/usable/actions/UsableActionsDynamic";
 import type { ActionId, IUsableActionItemRequirement, IUsableActionPossibleUsing, IUsableActionRequirements } from "game/entity/action/usable/IUsableAction";
+import UsableActionItemFinder from "game/entity/action/usable/UsableActionItemFinder";
+import type Player from "game/entity/player/Player";
 import type { IGetBestItemsOptions } from "game/item/IItemManager";
 import type Item from "game/item/Item";
 export interface IUseItemAction extends IUsableActionDynamicDefinition {
@@ -20,7 +22,11 @@ export interface IUseItemAction extends IUsableActionDynamicDefinition {
     allowAnyItems?: true;
     allowNoItem?: true;
     hasNoBestItem?: true;
-    validate?(item: Item): boolean;
+    filterFind?(item: Item, player: Player): boolean;
+    validate?(item: Item, player: Player): boolean;
+    initialiseFinder?(finder: UsableActionItemFinder): any;
+    onFinderTrack?(finder: UsableActionItemFinder): any;
+    onFinderDispose?(finder: UsableActionItemFinder): any;
 }
 export declare namespace IUseItemAction {
     function getGetItemOptions(actionType: ActionType, useItemAction?: Omit<IUseItemAction, keyof IUsableActionDynamicDefinition>): Partial<IGetBestItemsOptions>;

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

@@ -37,13 +37,14 @@ export default class PlayerManager extends EntityManager<Player> {
     event: IEventEmitter<this, IPlayerManagerEvents>;
     constructor();
     /**
-     * Get players in the game. Set all args to true to ensure all players are returned
+     * Get players in the game. Parameters include additional players that may not be relevant, such as ghosts, connecting players, absent players, the dedicated server fake player.
      * @param includeGhosts True to include players that are ghosts
      * @param includeConnecting True to include players that are connecting
-     * @param includeServer True to the server player
+     * @param includeDedicatedServer True to include the dedicated server fake player
+     * @param includeAbsent True to include the absent players
      * @returns Array of Player objects
      */
-    getAll(includeGhosts?: boolean, includeConnecting?: boolean, includeServer?: boolean): Player[];
+    getAll(includeGhosts?: boolean, includeConnecting?: boolean, includeDedicatedServer?: boolean, includeAbsent?: boolean): Player[];
     getByIdentifier(identifier: string, includeAbsent?: boolean): Player | undefined;
     getByName(name: string): Player | undefined;
     getValidName(name: string | undefined): string;

package/definitions/game/game/inspection/InfoProvider.d.ts

@@ -73,6 +73,7 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
     static of(...classes: string[]): SimpleInfoProvider;
     static title(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
     static description(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
+    static text(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
     static list(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
     static ofComponent(componentSupplier: () => Component): InfoProvider;
     private displayLevel?;

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

@@ -26,6 +26,8 @@ export default class IslandInspection extends Inspection<IVector2> {
     private getTreasureMaps;
     private getModifiers;
     private getBiome;
+    private getDaysSpent;
+    private getDaysSpentByPlayer;
     private getPlayers;
     private getPlayerLikeNPCs;
     private getYouAreHereLabel;

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

@@ -230,7 +230,7 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
     getMovementProgress(timeStamp: number): number;
     setQuality(human: Human | undefined, quality?: Quality): void;
     getValidMagicalProperties(): MagicalPropertyType[];
-    addMagicalProperties(count: number): boolean;
+    addMagicalProperties(count: number, source?: string): boolean;
     rerollMagicalProperty(type: MagicalPropertyType, subType?: MagicalSubPropertySubTypes): boolean;
     rerollMagicalPropertyValues(): void;
     addMagicalProperty(type: MagicalPropertyType, subType?: MagicalSubPropertySubTypes): boolean;

package/definitions/game/game/item/ItemFinder.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 EventEmitter from "event/EventEmitter";
 import type Human from "game/entity/Human";
 import type { IContainer } from "game/item/IItem";
 import type { IGetBestItemsOptions } from "game/item/IItemManager";
@@ -18,7 +19,11 @@ export interface IItemFinderOptions extends Partial<IGetBestItemsOptions> {
     fallback?: ItemFinder;
     postFilter?(item: Item): boolean;
 }
-export default class ItemFinder {
+export interface IItemFinderEvents {
+    track(): any;
+    dispose(): any;
+}
+export default class ItemFinder extends EventEmitter.Host<IItemFinderEvents> {
     private readonly options;
     private readonly human;
     private readonly container;

package/definitions/game/game/meta/prompt/IPrompt.d.ts

@@ -95,34 +95,35 @@ export declare enum Prompt {
     MenuOptionsReloadGame = 77,
     MenuOptionsChangeReload = 78,
     MenuOptionsConfirmUnlockMilestones = 79,
-    MenuOptionsConfirmUnlockRecipes = 80,
-    MenuOptionsSaveDataClearAll = 81,
-    MenuOptionsSaveDataClearCharacters = 82,
-    MenuOptionsSaveDataClearHighscores = 83,
-    MenuOptionsSaveDataClearMilestones = 84,
-    MenuOptionsSaveDataClearOptions = 85,
-    MenuOptionsSaveDataClearSaves = 86,
-    MenuOptionsSaveDataClearCraftingRecipes = 87,
-    MenuOptionsSaveDataClearBindings = 88,
-    MenuOptionsConfirmImportGlobalData = 89,
-    MenuPauseGhostKeepSave = 90,
-    MenuPauseReturnToTitleScreen = 91,
-    MenuPauseReturnToTitleScreenChallenge = 92,
-    MenuPauseReturnToTitleScreenChallengeMultiplayer = 93,
-    MenuPauseReturnToTitleScreenMultiplayer = 94,
-    MultiplayerFailedToConnect = 95,
-    MultiplayerRestartServerAfterLoadingSave = 96,
-    MultiplayerDisconnect = 97,
-    MultiplayerDisconnectRejoin = 98,
-    SteamworksURLOpenedInBrowser = 99,
-    SteamworksWorkshopOpenedInBrowser = 100,
-    SteamworksModWithNameAlreadyExists = 101,
-    SteamworksModImportSaveGameFailure = 102,
-    SteamworksModImportedSaveGame = 103,
-    SteamworksOpenFolderFailure = 104,
-    SteamworksModPublishModJsonUpdateFailed = 105,
-    SteamworksNotAvailableOnSteamDeck = 106,
-    UiSaveDrop = 107
+    MenuOptionsConfirmDiscoverActions = 80,
+    MenuOptionsConfirmUnlockRecipes = 81,
+    MenuOptionsSaveDataClearAll = 82,
+    MenuOptionsSaveDataClearCharacters = 83,
+    MenuOptionsSaveDataClearHighscores = 84,
+    MenuOptionsSaveDataClearMilestones = 85,
+    MenuOptionsSaveDataClearOptions = 86,
+    MenuOptionsSaveDataClearSaves = 87,
+    MenuOptionsSaveDataClearCraftingRecipes = 88,
+    MenuOptionsSaveDataClearBindings = 89,
+    MenuOptionsConfirmImportGlobalData = 90,
+    MenuPauseGhostKeepSave = 91,
+    MenuPauseReturnToTitleScreen = 92,
+    MenuPauseReturnToTitleScreenChallenge = 93,
+    MenuPauseReturnToTitleScreenChallengeMultiplayer = 94,
+    MenuPauseReturnToTitleScreenMultiplayer = 95,
+    MultiplayerFailedToConnect = 96,
+    MultiplayerRestartServerAfterLoadingSave = 97,
+    MultiplayerDisconnect = 98,
+    MultiplayerDisconnectRejoin = 99,
+    SteamworksURLOpenedInBrowser = 100,
+    SteamworksWorkshopOpenedInBrowser = 101,
+    SteamworksModWithNameAlreadyExists = 102,
+    SteamworksModImportSaveGameFailure = 103,
+    SteamworksModImportedSaveGame = 104,
+    SteamworksOpenFolderFailure = 105,
+    SteamworksModPublishModJsonUpdateFailed = 106,
+    SteamworksNotAvailableOnSteamDeck = 107,
+    UiSaveDrop = 108
 }
 export declare enum PromptType {
     Info = 0,

package/definitions/game/game/meta/prompt/PromptDescriptions.d.ts

@@ -101,6 +101,7 @@ export declare const promptMenuMilestoneModifiersImportFailure: import("game/met
 export declare const promptMenuOptionsReloadGame: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;
 export declare const promptMenuOptionsChangeReload: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;
 export declare const promptMenuOptionsConfirmUnlockMilestones: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;
+export declare const promptMenuOptionsConfirmDiscoverActions: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;
 export declare const promptMenuOptionsConfirmUnlockRecipes: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;
 export declare const promptMenuOptionsSaveDataClearAll: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;
 export declare const promptMenuOptionsSaveDataClearCharacters: import("game/meta/prompt/IPrompt").IPromptConfirmDescription<[]>;