@wayward/types 2.14.4-beta.dev.20250104.1 → 2.14.4-beta.dev.20250106.1

package/definitions/game/game/doodad/Doodad.d.ts

@@ -19,7 +19,7 @@ import type Human from "@wayward/game/game/entity/Human";
 import type { IEntityConstructorOptions } from "@wayward/game/game/entity/IEntity";
 import { EntityType } from "@wayward/game/game/entity/IEntity";
 import { SkillType } from "@wayward/game/game/entity/IHuman";
-import { EquipType } from "@wayward/game/game/entity/IHuman";
+import type { EquipType } from "@wayward/game/game/entity/IHuman";
 import { ActionType } from "@wayward/game/game/entity/action/IAction";
 import type Creature from "@wayward/game/game/entity/creature/Creature";
 import type Corpse from "@wayward/game/game/entity/creature/corpse/Corpse";
@@ -210,7 +210,7 @@ export default class Doodad extends EntityMovable<IDoodadDescription, DoodadType
     /**
      * Returns whether the doodad can be trampled
      */
-    canTrample(): boolean | undefined;
+    canTrample(): boolean;
     /**
      * Trampling growing things.
      */

package/definitions/game/game/doodad/DoodadUtilities.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright 2011-2024 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 "@wayward/game/game/doodad/Doodad";
+import type { DoodadType } from "@wayward/game/game/doodad/IDoodad";
+import { GrowingStage } from "@wayward/game/game/doodad/IDoodad";
+import type Human from "@wayward/game/game/entity/Human";
+declare namespace DoodadUtilities {
+    type DoodadIn = Doodad | DoodadType;
+    export function hasGrownEnoughIfCanGrow(doodad: Doodad, requiredGrowthStage: GrowingStage): boolean;
+    export function hasGrownEnoughIfCanGrow(doodad: DoodadIn, requiredGrowthStage: GrowingStage): undefined;
+    export function wouldWalkingOnDealFireDamage(doodad: DoodadIn, human?: Human): boolean;
+    export function wouldWalkingOnDealNormalDamage(doodad: DoodadIn, human?: Human): boolean;
+    export function isDangerous(doodad: DoodadIn, human?: Human): boolean;
+    export function canCauseStatus(doodad: DoodadIn): boolean;
+    export {};
+}
+export default DoodadUtilities;

package/definitions/game/game/doodad/IDoodad.d.ts

@@ -528,6 +528,12 @@ export declare enum GrowingStage {
     Ripening = 5,
     Bare = 6
 }
+export declare namespace Growth {
+    function isAtLeast(growth: GrowingStage | undefined, stage: GrowingStage): boolean;
+    function isAtMost(growth: GrowingStage | undefined, stage: GrowingStage): boolean;
+    function isMoreThan(growth: GrowingStage | undefined, stage: GrowingStage): boolean;
+    function isLessThan(growth: GrowingStage | undefined, stage: GrowingStage): boolean;
+}
 export interface IHasBuilder {
     getBuilder(): Human | undefined;
 }

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

@@ -126,8 +126,6 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
      * Call when this info provider should be removed.
      */
     remove(): this;
-    onStoppingPlay(): void;
-    onPreMoveToIsland(): void;
     private _shouldDisplayWhenEmpty;
     protected shouldDisplayWhenEmpty(): boolean;
     setShouldDisplayWhenEmpty(shouldDisplayWhenEmpty?: boolean): this;

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

@@ -1852,7 +1852,8 @@ export declare enum ItemTypeGroup {
     ExcludedFromRandom = -9856,
     Leaves = -9855,
     Flute = -9854,
-    All = -9853
+    InternalNoDropOnDoodadBreak = -9853,
+    All = -9852
 }
 export type StillContainerBaseItemType = ItemType.Waterskin | ItemType.GlassBottle | ItemType.ClayJug | ItemType.CoconutContainer;
 export interface IItemMovementResult {

package/definitions/game/game/reference/ReferenceManager.d.ts

@@ -53,5 +53,5 @@ export default class ReferenceManager {
     private resolveInternal;
     inspect<REFTYPE extends ReferenceType>(reference: Reference<REFTYPE>, context?: InfoProviderContext): Inspection<any> | undefined;
     inspect(reference: Reference, context?: InfoProviderContext): Inspection<any> | undefined;
-    tooltip(reference: Reference, initializer?: (tooltip: Tooltip, handler: ReferenceTooltipHandler) => any, context?: InfoProviderContext): (tooltip: Tooltip) => Promise<void>;
+    tooltip(reference: Reference, initializer?: (tooltip: Tooltip, handler: ReferenceTooltipHandler) => any, context?: InfoProviderContext): (tooltip: Tooltip) => Promise<boolean>;
 }

package/definitions/game/ui/component/Component.d.ts

@@ -94,7 +94,6 @@ export default class Component<E extends HTMLElement = HTMLElement> extends Even
      */
     get selectable(): SelectableLayer | false;
     constructor(elementType?: string, namespace?: Namespace);
-    toString(): string;
     /**
      * Alias of `.element.addEventListener`, except it returns `this` instead and prevents memory leaks
      */

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

@@ -20,7 +20,7 @@ export default class IslandDropdown<OTHER_OPTIONS extends string = never> extend
     protected getTranslation(islandId: IslandId): TranslationImpl;
     protected sortEnumOptions(o1: IDropdownSortableOption<string>, o2: IDropdownSortableOption<string>): number;
     protected getGroupName(biome: BiomeType): string;
-    protected optionTooltipInitializer: (tooltip: Tooltip, option: string) => Promise<void> | undefined;
+    protected optionTooltipInitializer: (tooltip: Tooltip, option: string) => Promise<boolean> | undefined;
     protected shouldIncludeOtherOptionsInGroupFilter(): boolean;
     protected isInGroup(islandId: IslandId, biome: BiomeType): boolean;
     protected getGroups(): BiomeType[];

package/definitions/game/ui/input/InputManager.d.ts

@@ -74,6 +74,7 @@ export declare class GlobalMouseInfo extends EventEmitter.Host<IGlobalMouseInfoE
      * @param recalcTarget Whether to recalculate the target before this operation. Defaults to `false`
      */
     isTarget<W extends Component | Element | string | undefined>(what?: W, recalcTarget?: boolean): (W extends Component ? W : HTMLElement) | undefined;
+    clearTarget(target?: Element): void;
     private _updateTarget;
 }
 interface IInputInfoEvents {
@@ -106,6 +107,7 @@ declare class InputManager extends EventEmitter.Host<IInputManagerEvents> {
     register(component: Component): this;
     deregister(): this;
     isRegistered(): boolean;
+    private didReset;
     reset(): void;
     /**
      * @param disabler Each `disableUntil` call should be given a unique `disabler`,

package/definitions/game/ui/input/Macros.d.ts

@@ -37,7 +37,7 @@ declare namespace Macros {
     function getCurrent(): Macro;
     function getTouch(): Macro;
     function reset(): void;
-    function setHandled(): void;
+    function setHandled(input: IInput): void;
     function setIsolated(_isolated?: boolean): void;
     function didRequestIsolation(): boolean;
     function handleInput(input: IInput, api: IBindHandlerApi): Macro | undefined;

package/definitions/game/ui/screen/screens/game/InspectionsTooltipHandler.d.ts

@@ -28,7 +28,11 @@ export interface IInspectionsTooltipHandlerEvents<INSPECTIONS_LIST extends Inspe
 export default abstract class InspectionsTooltipHandler<INSPECTIONS_LIST extends InspectionsList, TOOLTIP_ARGS extends any[] = []> extends EventEmitter.Host<IInspectionsTooltipHandlerEvents<INSPECTIONS_LIST, TOOLTIP_ARGS>> {
     protected current: IInspectionsTooltipHandlerCurrent<INSPECTIONS_LIST, TOOLTIP_ARGS> | undefined;
     private lastMousePosition?;
-    initializeTooltip(tooltip: Tooltip, ...args: TOOLTIP_ARGS): Promise<void>;
+    /**
+     * Initializes tooltips
+     * @returns True if the tooltip was initialized. False if it was removed or replaced before so.
+     */
+    initializeTooltip(tooltip: Tooltip, ...args: TOOLTIP_ARGS): Promise<boolean>;
     remove(tooltip?: IInspectionsTooltipHandlerCurrent<INSPECTIONS_LIST, TOOLTIP_ARGS> | undefined): void;
     onInitInspections(handler: (inspections: INSPECTIONS_LIST) => any): void;
     protected abstract initializeInspections(...args: TOOLTIP_ARGS): INSPECTIONS_LIST | undefined;

package/definitions/game/ui/screen/screens/game/ReferenceTooltipHandler.d.ts

@@ -21,7 +21,7 @@ export default class ReferenceTooltipHandler extends InspectionsTooltipHandler<R
     private readonly reference;
     private readonly initializer?;
     constructor(context: InfoProviderContext, reference: Reference, initializer?: ((tooltip: Tooltip, handler: ReferenceTooltipHandler) => any) | undefined);
-    initializeTooltip(tooltip: Tooltip): Promise<void>;
+    initializeTooltip(tooltip: Tooltip): Promise<boolean>;
     protected initializeInspections(): ReferenceInspectionsList;
     protected initializeHints(hints: InspectionTooltipHints): void;
 }

package/definitions/game/ui/screen/screens/game/component/ItemComponent.d.ts

@@ -69,6 +69,11 @@ export declare enum ItemRefreshType {
 export interface IItemComponentEvents extends Events<Component>, IDraggableEvents, IItemSlotEvents, ISortableDraggableEvents {
     deregisterHighlights(): any;
     refresh(type: ItemRefreshType): any;
+    /**
+     * Called when the item (within the item component) is changing.
+     * Usually during a refresh.
+     */
+    itemChange(): any;
 }
 export interface IItemComponentStaticEvents {
     update(type: ItemRefreshType): any;

package/definitions/game/ui/screen/screens/game/dialog/equipment/EquipmentSlotTooltip.d.ts

@@ -24,7 +24,7 @@ export declare enum EquipmentSlotTooltipClasses {
     Hints = "game-dialog-equipment-slot-tooltip-hints"
 }
 export default class EquipmentSlotTooltipHandler extends InspectionsTooltipHandler<EquipmentSlotInspectionsList, [slot: EquipType]> {
-    initializeTooltip(tooltip: Tooltip, slot: EquipType): Promise<void>;
+    initializeTooltip(tooltip: Tooltip, slot: EquipType): Promise<boolean>;
     protected initializeInspections(slot: EquipType): EquipmentSlotInspectionsList;
     protected initializeHints(hints: InspectionTooltipHints, slot: EquipType): void;
     private onSlotChanged;

package/definitions/utilities/Log.d.ts

@@ -129,11 +129,35 @@ declare namespace Log {
      * @param sources A list of sources to log to.
      */
     function trace(...sources: string[]): (...args: any[]) => void;
+    /**
+     * Warns about an occurrence of something, due to a specific caller, once per session.
+     * @param skip Number of callsites to skip. Automatically skips this function and its caller.
+     * If this is called from a function that is registered in `Errors.ts` as a skipped callsite, you might have to pass `-1`.
+     * @param id The ID of this warning. Can be `Log.simplify` strings.
+     */
+    function warnForCaller(skip: number, id: ArrayOr<string | SimplifyString>, ...message: any[]): void;
     /**
      * Warn about something once per session based on unique warning ids.
      * This is like how node.js does warnings in console.
      */
-    function warnOncePerSession(warningId: string | string[], ...message: any[]): void;
+    function warnOncePerSession(warningId: ArrayOr<string | SimplifyString>, ...message: any[]): void;
+    interface SimplifyString extends String {
+        simplified: string;
+    }
+    namespace SimplifyString {
+        function is(value: unknown): value is SimplifyString;
+        function get(value: unknown): string;
+    }
+    function simplify(segments: TemplateStringsArray, ...interpolations: unknown[]): SimplifyString;
+    function simplify(mainLog: string, simplified: string): SimplifyString;
+    /**
+     * Returns a combination of the object's constructor and the result of calling `toString` on it.
+     *
+     * If the `toString` result is redundant or useless, it is omitted.
+     *
+     * The resulting string will be automatically simplified when reported to the error server.
+     */
+    function objectToString(object?: object): string;
 }
 declare class NullLog extends BaseLog {
     setup(): void;

package/definitions/utilities/prototype/Array.d.ts

@@ -25,7 +25,8 @@ declare global {
         toggle(value: T, includes?: boolean): void;
         awaitAll(): Promise<Array<Awaited<T>>>;
         layerSort(sortInitializer: (sorter: ISorter<T>) => any): T[];
-        groupBy<GROUP>(grouper: (value: T, index: number, obj: T[]) => GROUP): Array<[GROUP, T[]]>;
+        groupBy<GROUP>(grouper: (value: T, index: number, array: T[]) => GROUP): Array<[GROUP, T[]]>;
+        groupBy<GROUP, R>(grouper: (value: T, index: number, array: T[]) => GROUP, mapper: (values: T[], group: GROUP) => R): Array<[GROUP, R]>;
         /**
          * Alias of `.toSet().toArray()`
          */

package/package.json

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