@wayward/types 2.12.3-beta.dev.20230104.1 → 2.13.0-beta

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

@@ -14,7 +14,9 @@ import type { IMessage, IMessageHistoryItem, IMessageManager, IPackedMessage } f
 import { MessageType, Source } from "game/entity/player/IMessageManager";
 import type Player from "game/entity/player/Player";
 import type Island from "game/island/Island";
+import type Dictionary from "language/Dictionary";
 import Message from "language/dictionary/Message";
+import type { TranslationArg } from "language/ITranslation";
 import Translation from "language/Translation";
 import type { IVector4 } from "utilities/math/Vector4";
 export declare class MessageManagerNoOp implements IMessageManager {
@@ -30,13 +32,14 @@ export declare class MessageManagerNoOp implements IMessageManager {
     send(): boolean;
     sendPacked(): boolean;
     sentToAll(sentToAll?: boolean): this;
-    pruneMessageHistory(): boolean;
+    pruneMessageHistory(isLocalPlayer: boolean): boolean;
     addToHistory(messageHistoryItem: IMessageHistoryItem): void;
+    upgrade(): this;
 }
 export interface IMessageManagerOptions {
     shouldDisplayMessage(message: IMessage, id: number): boolean | undefined;
     onDisplayMessage(message: IMessage): void;
-    getMessageStorageMax(): number;
+    getMessageStorageMax(isLocalPlayer: boolean): number;
 }
 export default class MessageManager implements IMessageManager {
     private readonly options;
@@ -70,7 +73,7 @@ export default class MessageManager implements IMessageManager {
     /**
      * Cuts the message history down to the correct bounds (preferring the more recent messages)
      */
-    pruneMessageHistory(): boolean;
+    pruneMessageHistory(isLocalPlayer: boolean): boolean;
     /**
      * Clears the entire message history.
      */
@@ -114,7 +117,7 @@ export default class MessageManager implements IMessageManager {
      *
      * Note: After sending a message, the message source, type, and human (if any) are reset.
      */
-    send(message: Message | Translation, ...args: any[]): boolean;
+    send(message: Message | Translation, ...args: TranslationArg[]): boolean;
     sendPacked(pack: Partial<IPackedMessage>, ...extraSources: Source[]): boolean;
     addToHistory(messageHistoryItem: IMessageHistoryItem): void;
     /**
@@ -122,4 +125,5 @@ export default class MessageManager implements IMessageManager {
      */
     sentToAll(sentToAll?: boolean): this;
     private reset;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }

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

@@ -19,51 +19,62 @@ import NoteManager from "game/entity/player/note/NoteManager";
 import QuestManager from "game/entity/player/quest/QuestManager";
 import { TileUpdateType } from "game/IGame";
 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 { Prompt } from "game/meta/prompt/IPrompt";
 import { Milestone } from "game/milestones/IMilestone";
+import type Tile from "game/tile/Tile";
 import type InterruptChoice from "language/dictionary/InterruptChoice";
 import type IClientStore from "save/clientStore/IClientStore";
-import type { IUnserializedCallback } from "save/serializer/ISerializer";
-import type { IDialogInfo } from "ui/old/IOldUi";
+import type { IPreSerializeCallback, ISerializer, IUnserializedCallback } from "save/serializer/ISerializer";
+import type { IContainerSortInfo, IDialogInfo } from "ui/old/IOldUi";
 import { IActionBarSlotData } from "ui/screen/screens/game/static/actions/IActionBar";
 import { Direction } from "utilities/math/Direction";
-import type { IVector3 } from "utilities/math/IVector";
-export default class Player extends Human implements IUnserializedCallback {
-    event: IEventEmitter<this, IPlayerEvents>;
-    readonly entityType: EntityType.Player;
-    readonly tileUpdateType = TileUpdateType.Player;
+export default class Player extends Human implements IPreSerializeCallback, IUnserializedCallback {
+    get entityType(): EntityType.Player;
+    get tileUpdateType(): TileUpdateType;
+    readonly event: IEventEmitter<this, IPlayerEvents>;
     absentLastUsedTime: number;
+    containerSortInfo: Record<string | number, IContainerSortInfo | undefined>;
+    dialogContainerInfo: Record<number, IDialogInfo | undefined>;
     dialogInfo: Record<string, IDialogInfo>;
     hintSeen: boolean[];
     islandId: IslandId;
     name: string;
     actionBar: IActionBarSlotData[];
+    useActionsWhileMoving: boolean;
     revealedItems: Record<number, boolean>;
     milestoneModifiers: Set<Milestone>;
+    milestoneTitle?: Milestone;
     displayCreature?: CreatureType;
     private updateTablesOnNoInput?;
     private lastTableUpdateId?;
     constructor(identifier?: string);
+    preSerializeObject(serializer: ISerializer): void;
     onUnserialized(): void;
     delete(): void;
-    get island(): Island;
+    isValid(): boolean;
     get clientStore(): IClientStore;
     createNoteManager(): NoteManager;
     createMessageManager(): MessageManager;
     createQuestManager(): QuestManager;
     getDisplayCreature(): CreatureType | undefined;
+    protected updateTile(fromTile: Tile, toTile: Tile): boolean;
     changeId(id: number): void;
-    protected moveToIsland(island: Island, targetPosition: IVector3): void;
+    protected moveToIsland(targetTile: Tile): void;
+    /**
+     * This only does stuff when it's called on the local player
+     */
+    addItemMilestones(item: Item): void;
     checkSkillMilestones(): void;
     protected onCanMove(direction: Direction.Cardinal): false | undefined;
     addMilestone(milestone: Milestone, data?: number | string, update?: boolean): void;
     updateMovementIntent(movementIntent: IMovementIntent): boolean;
     load(): void;
     unload(): void;
-    setup(spawnPoint: IVector3): void;
+    private onLoadOrUnload;
+    setup(spawnPoint: Tile): void;
     protected onNoInput(): void;
     updateTables(source: string, options?: Partial<{
         allowCaching: boolean;
@@ -71,14 +82,14 @@ export default class Player extends Human implements IUnserializedCallback {
     }>): void;
     private updateCraftTable;
     updateDismantleTable(adjacentContainers?: IContainer[], force?: boolean): void;
-    getName(): import("../../../language/impl/TranslationImpl").default;
+    getName(includeTitle?: boolean): import("../../../language/impl/TranslationImpl").default;
     /**
      * Prompts the player
      */
     prompt(type: Prompt, ...args: any[]): Promise<boolean | InterruptChoice>;
-    updateActionSlots(slots: number[], data: IActionBarSlotData[]): void;
-    updateDialogInfo(dialogIndex: string | number): void;
-    getDialogInfo(dialogIndex: string | number): IDialogInfo;
+    updateActionSlots(slots: number[], data: IActionBarSlotData[], enabled?: boolean): void;
+    updateDialogInfo(dialogIndex: string | number | undefined): void;
+    getDialogInfo(dialogIndex: string | number): IDialogInfo | undefined;
     kill(): void;
     respawn(reset: boolean): void;
     /**
@@ -91,7 +102,7 @@ export default class Player extends Human implements IUnserializedCallback {
      * Only use this clientside
      */
     isExploredClientSide(x: number, y: number, z: number): boolean;
-    protected onSkillGain(skill: SkillType, mod: number): void;
+    protected onSkillGain(skill: SkillType, fromValue: number, toValue: number, mod: number): void;
     private canWriteInHours;
     private canWriteNote;
     private onWriteNote;

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

@@ -8,36 +8,46 @@
  * 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 { Events, IEventEmitter } from "event/EventEmitter";
-import EntityManager from "game/entity/EntityManager";
+import EventEmitter from "event/EventEmitter";
+import type { IEntityManagerEvents } from "game/entity/EntityManager";
 import Player from "game/entity/player/Player";
+import type { Game } from "game/Game";
 import type { IPlayerOptions, IPlayOptions } from "game/IGame";
-import { CreationId } from "game/IGame";
-export interface IPlayerManagerEvents extends Events<EntityManager<Player>> {
+export interface IPlayerManagerEvents extends IEntityManagerEvents<Player> {
     /**
      * Called when a player is about to be removed
      * The player is going to be added into absentPlayers
      * @param player The player object
      */
-    preRemove?(player: Player): void;
+    preRemove(player: Player): void;
     /**
      * Called when a player joins the server
      * @param player The player object
      */
-    join?(player: Player): void;
+    join(player: Player): void;
     /**
      * Called when a player leaves the server
      * Note: This hook is not called for the player who left the server (player will never be localPlayer)
      * @param player The player object
      */
-    leave?(player: Player): void;
+    leave(player: Player): void;
+    /**
+     * Called when a player-like human (player / special npc) is spawned
+     */
+    addPlayingEntity(entity: Player): any;
+    /**
+     * Called when a player-like human (player / special npc) is removed
+     */
+    removePlayingEntity(entity: Player): any;
 }
-export default class PlayerManager extends EntityManager<Player> {
-    protected readonly creationId: CreationId;
-    event: IEventEmitter<this, IPlayerManagerEvents>;
-    constructor();
+export default class PlayerManager extends EventEmitter.Host<IPlayerManagerEvents> {
+    private readonly game;
+    readonly players: Array<Player | undefined>;
+    readonly absentPlayers: Array<Player | undefined>;
+    constructor(game: Game);
+    reset(): void;
     /**
-     * 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.
+     * Get players. 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 includeDedicatedServer True to include the dedicated server fake player
@@ -56,7 +66,7 @@ export default class PlayerManager extends EntityManager<Player> {
      * Support loading single player saves in dedicated servers
      * All while not losing data for any players - regardless of if the player was in the server or not at the time of the backup
      */
-    repair(options: Partial<IPlayOptions>): void;
+    repair(options: Partial<IPlayOptions>): Promise<void>;
     /**
      * Removes and deletes a player.
      * Use with caution!

package/definitions/game/game/entity/player/note/Corpse.d.ts

@@ -9,5 +9,5 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Human from "game/entity/Human";
-import type { ITile } from "game/tile/ITerrain";
-export default function writeCorpseNote(human: Human, tile: ITile): void;
+import type Tile from "game/tile/Tile";
+export default function writeCorpseNote(human: Human, tile: Tile): void;

package/definitions/game/game/entity/player/note/NoteManager.d.ts

@@ -10,13 +10,16 @@
  */
 import type Island from "game/island/Island";
 import type { PartOfDay } from "game/time/ITimeManager";
+import type Dictionary from "language/Dictionary";
+import type { TranslationArg } from "language/ITranslation";
+import Translation from "language/Translation";
 import Note from "language/dictionary/Note";
 import type { IModdable } from "mod/ModRegistry";
 import { HelpArticle } from "ui/screen/screens/menu/menus/help/HelpArticleDescriptions";
 export interface INoteDescription extends IModdable {
     learnMore?: HelpArticle;
 }
-export declare const noteDescriptions: OptionalDescriptions<Note, INoteDescription>;
+export declare const noteDescriptions: Map<Note, INoteDescription>;
 export type Time = PartOfDay | string;
 export interface INote {
     id: keyof typeof Note;
@@ -25,7 +28,7 @@ export interface INote {
         time: number;
         skilled: boolean;
     };
-    args: any[];
+    args: TranslationArg[];
     unread?: boolean;
 }
 export interface INoteManager {
@@ -35,6 +38,7 @@ export interface INoteManager {
     write(note: Note, ...args: any[]): void;
     getUnread(): INote[];
     markRead(noteId: number): void;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }
 export interface INoteHost {
     getIsland(): Island;
@@ -47,9 +51,10 @@ export declare class NoteManagerNoOp implements INoteManager {
     readonly notes: INote[];
     getNote(id: number): INote | undefined;
     wasWritten(note: Note): boolean;
-    write(note: Note, ...args: any[]): void;
+    write(note: Note, ...args: TranslationArg[]): void;
     getUnread(): INote[];
     markRead(noteId: number): void;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }
 export default class NoteManager implements INoteManager {
     private readonly host;
@@ -58,7 +63,8 @@ export default class NoteManager implements INoteManager {
     get notes(): INote[];
     getNote(id: number): INote | undefined;
     wasWritten(note: Note): boolean;
-    write(note: Note, ...args: any[]): void;
+    write(note: Note, ...args: TranslationArg[]): void;
     getUnread(): INote[];
     markRead(noteId: number): void;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }

package/definitions/game/game/entity/player/quest/QuestManager.d.ts

@@ -8,14 +8,13 @@
  * 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 Stream from "@wayward/goodstream/Stream";
 import EventEmitter from "event/EventEmitter";
+import type { Game } from "game/Game";
 import type Player from "game/entity/player/Player";
 import type PlayerManager from "game/entity/player/PlayerManager";
 import type { IQuest } from "game/entity/player/quest/quest/IQuest";
 import { QuestType } from "game/entity/player/quest/quest/IQuest";
 import type { RequirementInstance } from "game/entity/player/quest/quest/Quest";
-import type { Game } from "game/Game";
 export interface IQuestManager extends EventEmitter.Host<IQuestManagerEvents> {
     /**
      * Get all quests
@@ -100,10 +99,10 @@ export declare class QuestInstance extends EventEmitter.Host<IQuestInstanceEvent
     constructor(host: Player, data: IQuest, id: number);
     getTitle(): import("../../../../language/impl/TranslationImpl").default | undefined;
     getDescription(): import("../../../../language/impl/TranslationImpl").default | undefined;
-    getRequirements(): Stream<RequirementInstance>;
+    getRequirements(): RequirementInstance[];
     needsManualCompletion(): boolean | undefined;
     complete(): this;
-    getChildren(): Stream<QuestType>;
+    getChildren(): QuestType[];
     getCompletionAmount(): number;
 }
 interface IQuestInstanceEvents {

package/definitions/game/game/entity/player/quest/Quests.d.ts

@@ -10,5 +10,4 @@
  */
 import { QuestType } from "game/entity/player/quest/quest/IQuest";
 import type { Quest } from "game/entity/player/quest/quest/Quest";
-declare const quests: OptionalDescriptions<QuestType, Quest>;
-export default quests;
+export declare const questDescriptions: Map<QuestType, Quest>;

package/definitions/game/game/entity/player/quest/quest/Challenge.d.ts

@@ -8,14 +8,14 @@
  * 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 Stream from "@wayward/goodstream/Stream";
+import { CreatureType } from "game/entity/creature/ICreature";
 import type { RequirementInstance } from "game/entity/player/quest/quest/Quest";
 import { Quest } from "game/entity/player/quest/quest/Quest";
 import type { QuestInstance } from "game/entity/player/quest/QuestManager";
 import type { IQuestRequirement } from "game/entity/player/quest/requirement/IRequirement";
 import type Island from "game/island/Island";
 export default class Challenge extends Quest {
-    static getCreaturesOfRequirements(): Stream<any>;
+    static getCreaturesOfRequirements(): CreatureType[];
     private static readonly possibleRequirements;
     /**
      * These are the only items that can be requested to collect
@@ -39,9 +39,14 @@ export default class Challenge extends Quest {
     private readonly possibleRequirements;
     constructor();
     reset(): void;
-    protected createRequirements(island: Island): Stream<IQuestRequirement<any[], {}>>;
+    protected createRequirements(island: Island): Array<IQuestRequirement<any, any>>;
     protected onUpdate(quest: QuestInstance): void;
     protected onRequirementComplete(quest: QuestInstance, completedRequirement: RequirementInstance): void;
+    /**
+     *
+     * @param island
+     * @returns Technically a IQuestRequirement<any, any>, but specifying the exact types makes the typing much faster
+     */
     private createRandomRequirement;
     private getSpawnableCreatures;
 }

package/definitions/game/game/entity/player/quest/quest/Quest.d.ts

@@ -35,18 +35,18 @@ export declare class Quest extends EventEmitter.Host<IQuestEvents> {
     addRequirement<RA extends any[]>(type: QuestRequirementType, ...args: RA): this;
     setNeedsManualCompletion(): this;
     addChildQuests(...children: QuestType[]): this;
-    getChildren(): import("@wayward/goodstream").default<QuestType>;
+    getChildren(): QuestType[];
     setTitle(translation?: Translation | ((quest: IQuest) => Translation)): this;
     setDescription(translation?: Translation): this;
     create(island: Island, type?: QuestType | undefined): IQuest;
     getTitle(quest: IQuest): import("../../../../../language/impl/TranslationImpl").default | undefined;
     getDescription(quest: IQuest): import("../../../../../language/impl/TranslationImpl").default | undefined;
-    getEventBusTriggers(instance: IQuest): import("@wayward/goodstream").default<[IQuestRequirement<any[], {}>, import("@wayward/goodstream").default<readonly [import("../../../../../event/EventManager").EmitterOrBus, string | number | symbol, (api: IQuestRequirementApi<[], {}>, ...args: any[]) => boolean]>]>;
-    getHostTriggers(instance: IQuest): import("@wayward/goodstream").default<[IQuestRequirement<any[], {}>, IterableIterator<[keyof import("../../IPlayer").IPlayerEvents, (api: IQuestRequirementApi<[], {}>, player: Player, ...args: any[]) => boolean]>]>;
-    getRequirements(host: Player, instance: IQuest): import("@wayward/goodstream").default<RequirementInstance>;
+    getEventBusTriggers(instance: IQuest): [IQuestRequirement<any[], {}>, import("@wayward/goodstream").default<readonly [import("../../../../../event/EventManager").EmitterOrBus, string | number | symbol, (api: IQuestRequirementApi<[], {}>, ...args: any[]) => boolean]>][];
+    getHostTriggers(instance: IQuest): [IQuestRequirement<any[], {}>, IterableIterator<[keyof import("../../IPlayer").IPlayerEvents, (api: IQuestRequirementApi<[], {}>, player: Player, ...args: any[]) => boolean]>][];
+    getRequirements(host: Player, instance: IQuest): RequirementInstance[];
     getRequirement(host: Player, quest: IQuest, requirement: IQuestRequirement): RequirementInstance | undefined;
     needsManualCompletion(): boolean;
-    protected createRequirements(island: Island): import("@wayward/goodstream").default<IQuestRequirement<any[], {}>>;
+    protected createRequirements(island: Island): IQuestRequirement[];
     protected createRequirement<R extends QuestRequirementType>(type: R, ...options: RequirementArgs<R>): IQuestRequirement<RequirementArgs<R>>;
 }
 export declare class RequirementInstance extends EventEmitter.Host<IQuestRequirementEvents> {

package/definitions/game/game/entity/skill/ISkills.d.ts

@@ -17,8 +17,13 @@ export interface ISkillLevel {
     core: number;
 }
 export interface ISkillDescription extends IModdable {
-    attribute?: Stat;
+    attribute?: Stat | ISkillAttribute;
     reputation?: number;
     defaultDamageType?: DamageType;
 }
+export interface ISkillAttribute {
+    stat: Stat;
+    gainChanceOffset?: number;
+    gainMultiplier?: number;
+}
 export declare const skillDescriptions: OptionalDescriptions<SkillType, ISkillDescription>;

package/definitions/game/game/entity/skill/SkillManager.d.ts

@@ -16,7 +16,7 @@ export interface ISkillConfiguration {
     id: GetterOfOr<string | number>;
     getSkillGainMultiplier?(skill: SkillType): number;
     canSkillGain?(skill: SkillType): boolean;
-    onSkillGain?(skill: SkillType, mod: number): any;
+    onSkillGain?(skill: SkillType, fromValue: number, toValue: number, mod: number): any;
 }
 export interface ISkillEvents {
     /**

package/definitions/game/game/entity/status/StatusEffect.d.ts

@@ -9,7 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import EventEmitter from "event/EventEmitter";
-import type Entity from "game/entity/Entity";
+import type EntityWithStats from "game/entity/EntityWithStats";
 import type { StatusType } from "game/entity/IEntity";
 import { StatusEffectChangeReason } from "game/entity/IEntity";
 import { MessageType } from "game/entity/player/IMessageManager";
@@ -31,7 +31,7 @@ export interface IStatusEffectIconDescription {
      */
     frames?: number;
 }
-export type StatusEffectClass = Class<StatusEffect, [StatusType, Entity]> & IModdable;
+export type StatusEffectClass = Class<StatusEffect, [StatusType, EntityWithStats]> & IModdable;
 export declare enum StatusEffectBadness {
     Neutral = 0,
     Bad = 1,
@@ -64,8 +64,8 @@ export default abstract class StatusEffect extends EventEmitter.Host<IStatusEffe
     static update(effect: StatusEffect): void;
     private registered;
     private readonly _entity;
-    constructor(type: StatusType, entity?: Entity);
-    protected get entity(): Entity;
+    constructor(type: StatusType, entity?: EntityWithStats);
+    protected get entity(): EntityWithStats;
     getOptions(): IGameOptionsStatusEffect;
     register(): void;
     /**

package/definitions/game/game/entity/status/handler/BadTemperatureEffect.d.ts

@@ -24,7 +24,7 @@ export default abstract class BadTemperatureEffect extends StatusEffect {
     protected onTick(): void;
     protected abstract getConsequenceEffect(): StatusType;
     protected abstract getConsequenceStat(): Stat;
-    private onGameTickStart;
+    private onGameTick;
     private onPlayerTurnStart;
     private isLevelTwoBadTemp;
 }

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

@@ -24,9 +24,11 @@ export declare module InfoDisplayLevel {
     function canDisplay(level: InfoDisplayLevel, ...toDisplay: InfoDisplayLevel[]): boolean;
 }
 export declare enum InfoClass {
-    Title = "title",
-    Description = "description",
-    List = "list"
+    Title = "info-provider-title",
+    Subtitle = "info-provider-subtitle",
+    Description = "info-provider-description",
+    List = "info-provider-list",
+    MultiTextParagraph = "info-provider-multi-text-paragraph"
 }
 export interface IInspector {
     asEntity?: Entity;

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

@@ -43,5 +43,6 @@ export declare enum InfoIcon {
     PinSelf = 2,
     PinFriend = 3,
     PinMap = 4,
-    ActionUndiscovered = 5
+    ActionUndiscovered = 5,
+    PinLighthouse = 6
 }

package/definitions/game/game/inspection/InfoProvider.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 { EventBus } from "event/EventBuses";
 import EventEmitter from "event/EventEmitter";
 import type { Emitter, EmitterOrBus, Event, Handler } from "event/EventManager";
 import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
@@ -42,6 +43,10 @@ export interface IInfoProviderEvents {
     /**
      * Should be emitted when the info provider should be removed.
      */
+    requestRemove(): any;
+    /**
+     * Emitted when the info provider has been removed.
+     */
     remove(): any;
     /**
      * Should be emitted when the info provider's display level changes.
@@ -68,13 +73,16 @@ export interface ISerializedIcon extends IIcon {
     path: string | ISerializedImagePath;
 }
 export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProviderEvents> implements IRefreshable {
+    static multiTextParagraph: string;
     private static uniqueInitializationId;
     static create(...translations: TranslationGenerator[]): SimpleInfoProvider;
+    static dynamic<T>(observer: InfoProvider.Observer<T>, supplier: (value: T) => InfoProvider | undefined): SimpleInfoProvider;
     static of(...classes: string[]): SimpleInfoProvider;
     static title(...translations: Array<TranslationGenerator | undefined>): SimpleInfoProvider;
+    static subtitle(...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 list(...translations: Array<InfoProvider | TranslationGenerator | undefined>): SimpleInfoProvider;
     static ofComponent(componentSupplier: () => Component): InfoProvider;
     private displayLevel?;
     protected component?: Component;
@@ -83,9 +91,11 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
     abstract get(context: InfoProviderContext): ArrayOr<TranslationGenerator | InfoProvider>;
     abstract getClass(): string[];
     getDefaultDisplayLevel(_context: InfoProviderContext): InfoDisplayLevel | Set<InfoDisplayLevel>;
-    setDisplayLevel(...displayLevel: InfoDisplayLevel[]): this;
+    setDisplayLevel(...displayLevel: Array<InfoDisplayLevel | undefined>): this;
     getDisplayLevel(context: InfoProviderContext): Set<InfoDisplayLevel>;
     setComponent(componentClass: Class<Component>): this;
+    private componentInitializer?;
+    setComponentInitializer(initializer: (componenent: Component) => any): this;
     private icon?;
     getIcon(): IIcon | string | undefined;
     setIcon(icon?: IIcon | string): this;
@@ -94,12 +104,20 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
     setSynchronous(): this;
     init(): void;
     private readonly refreshEvents;
+    subscribeRefreshOnTick(observer: InfoProvider.Observer<any>): this;
+    subscribeRefreshOnTick(predicate: (...params: Parameters<Handler<EventBus.Game, "tickEnd">>) => boolean): this;
     /**
      * Marks this info provider as to subscribe refresh events to the given host.
      * Note: Any existing initialized components will not be retroactively subscribed.
      * @param predicate A predicate function for whether or not this info provider should actually refresh when the event is hit
      */
     subscribeRefreshOn<E extends EmitterOrBus, K extends Event<E>>(emitterOrBus: E, ...args: [...events: K[], predicate: (...params: Parameters<Handler<E, K>>) => boolean]): this;
+    /**
+     * Marks this info provider as to subscribe refresh events to the given host.
+     * Note: Any existing initialized components will not be retroactively subscribed.
+     * @param observer An observer that will only trigger a refresh if the value has changed
+     */
+    subscribeRefreshOn<E extends EmitterOrBus, K extends Event<E>>(emitterOrBus: E, ...args: [...events: K[], observer: InfoProvider.Observer<any>]): this;
     /**
      * Marks this info provider as to subscribe refresh events to the given host.
      * Note: Any existing initialized components will not be retroactively subscribed.
@@ -131,13 +149,21 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
     };
     protected initChildTextComponent(text: TranslationGenerator): Text;
 }
+export declare namespace InfoProvider {
+    class Observer<T> {
+        private readonly _observe;
+        value: T;
+        constructor(_observe: () => T);
+        observe(): boolean;
+    }
+}
 export declare class SimpleInfoProvider extends InfoProvider {
     private readonly classes;
     private readonly contents;
     private childComponentClass;
     private validWhen?;
     constructor(...translations: Array<TranslationGenerator | InfoProvider>);
-    get(): (import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | (() => import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | Iterable<import("../../utilities/string/Interpolator").IStringSection> | undefined) | InfoProvider)[];
+    get(): (import("../../language/impl/TranslationImpl").default | import("../../language/ITranslation").ISerializedTranslation | import("../../language/dictionary/UiTranslation").default | (() => import("../../language/impl/TranslationImpl").default | import("../../language/ITranslation").ISerializedTranslation | import("../../language/dictionary/UiTranslation").default | import("../../utilities/string/Interpolator").IStringSection[] | undefined) | InfoProvider)[];
     add(...translations: Array<TranslationGenerator | InfoProvider | Falsy>): this;
     onlyIfHasContents(): this | undefined;
     addInfoGetter(provider: () => InfoProvider | undefined): this;

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

@@ -8,15 +8,19 @@
  * 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 { IInspector, InfoDisplayLevel } from "game/inspection/IInfoProvider";
-import { TextContext } from "language/ITranslation";
+import type { IInspector } from "game/inspection/IInfoProvider";
+import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
+export declare enum InfoProviderContextType {
+    Tooltip = 0,
+    Generic = 1
+}
 export declare class InfoProviderContext {
-    static readonly UI: new (inspector: IInspector, maxDisplayLevel: InfoDisplayLevel) => InfoProviderContext;
-    static readonly RAW: new (inspector: IInspector, maxDisplayLevel: InfoDisplayLevel) => InfoProviderContext;
+    static readonly GENERIC: new (inspector?: IInspector | undefined, maxDisplayLevel?: InfoDisplayLevel | undefined) => InfoProviderContext;
+    static readonly TOOLTIP: new (inspector?: IInspector | undefined, maxDisplayLevel?: InfoDisplayLevel | undefined) => InfoProviderContext;
     protected readonly _inspector: WeakRef<IInspector>;
-    readonly textContext: TextContext;
+    readonly type: InfoProviderContextType;
     readonly maxDisplayLevel: InfoDisplayLevel;
     constructor(context: InfoProviderContext);
-    constructor(textContext: TextContext, inspector: IInspector, maxDisplayLevel: InfoDisplayLevel);
+    constructor(type: InfoProviderContextType, inspector?: IInspector, maxDisplayLevel?: InfoDisplayLevel);
     get inspector(): IInspector | undefined;
 }

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

@@ -15,15 +15,14 @@ import type { InspectionClass } from "game/inspection/InspectionTypeMap";
 import type { EnumReferenceResolved, EnumReferenceTypes, ReferenceType } from "game/reference/IReferenceManager";
 import type { TranslationGenerator } from "ui/component/IComponent";
 import type Text from "ui/component/Text";
+import type { InspectionTooltipHints } from "ui/screen/screens/game/InspectionsTooltipHandler";
 import type { IVector3 } from "utilities/math/IVector";
 export default abstract class Inspection<O> extends InfoProvider {
     readonly type: InspectType;
     readonly value: O;
-    static createEnumReferenceHandler<R extends ReferenceType, E, K extends string>(referenceType: R, enumObject: {
-        [key in K]: E;
-    }, predicate?: (reference: [R, E], context?: InfoProviderContext) => any): (type: InspectType, value: unknown, context?: InfoProviderContext) => any;
+    static createEnumReferenceHandler<R extends ReferenceType, E, K extends string>(referenceType: R, enumObject: Record<K, E>, predicate?: (reference: [R, E], context?: InfoProviderContext) => any): (type: InspectType, value: unknown, context?: InfoProviderContext) => boolean;
     static createAnyHandler(...handlers: Array<Exclude<InspectionClass["handles"], undefined>>): (type: InspectType, ...args: any[]) => boolean;
-    static createReferenceHandler<REFTYPE extends EnumReferenceTypes>(referenceType: REFTYPE, handler?: (resolvedReference: EnumReferenceResolved<REFTYPE>, context?: InfoProviderContext) => any): (type: InspectType, value: unknown, context?: InfoProviderContext) => any;
+    static createReferenceHandler<REFTYPE extends EnumReferenceTypes>(referenceType: REFTYPE, handler?: (resolvedReference: EnumReferenceResolved<REFTYPE>, context?: InfoProviderContext) => any): (type: InspectType, value: unknown, context?: InfoProviderContext) => boolean;
     static verifyHumanity(_: any, context?: InfoProviderContext): boolean;
     static getDefaultPriority(inspectType: InspectType): number;
     constructor(type: InspectType, value: O);
@@ -34,6 +33,7 @@ export default abstract class Inspection<O> extends InfoProvider {
      * Returns a string that should differentiate this inspection from other inspections of the same type.
      */
     abstract getId(): string;
+    renderHints(hints: InspectionTooltipHints): void;
     protected createIdFromVector3(vec3: IVector3): string;
     protected initChildTextComponent(text: TranslationGenerator): Text;
 }