@wayward/types 2.13.0-beta.dev.20230330.1 → 2.13.0-beta.dev.20230331.1

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

@@ -72,7 +72,7 @@ export interface IDoodadEvents extends IEntityEvents {
     durabilityChange(durability: number, oldDurability: number): any;
     durabilityMaxChange(durability: number, oldDurability: number): any;
 }
-export default class Doodad extends Entity<DoodadType, DoodadTag> implements IUnserializedCallback, IObject<DoodadType>, IDoodadOptions, Partial<IContainer>, IHasInsulation, IHasBuilder, IHasMagic {
+export default class Doodad extends Entity<IDoodadDescription, DoodadType, DoodadTag> implements IUnserializedCallback, IObject<DoodadType>, IDoodadOptions, Partial<IContainer>, IHasInsulation, IHasBuilder, IHasMagic {
     static is(value: any): value is Doodad;
     get constructorFunction(): typeof Doodad;
     static getRegistrarId(): number;
@@ -104,7 +104,6 @@ export default class Doodad extends Entity<DoodadType, DoodadTag> implements IUn
     stillContainer?: Item;
     tradedFrom?: string[];
     weight?: number;
-    private _description?;
     private _tileId?;
     /**
      * Separate property just for wells because isInGroup is still expensive for processWell()
@@ -133,7 +132,7 @@ export default class Doodad extends Entity<DoodadType, DoodadTag> implements IUn
      * - `doodad.getName(undefined, 3)` // "stone furnaces"
      */
     getName(article?: false | "definite" | "indefinite", count?: number): import("../../language/impl/TranslationImpl").default;
-    description(): IDoodadDescription | undefined;
+    protected getDescription(): IDoodadDescription | undefined;
     updateTile(tileUpdateType: TileUpdateType): void;
     changeType(doodadType: DoodadType): void;
     isValid(): boolean;

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

@@ -34,7 +34,7 @@ import type EntityWithStats from "game/entity/EntityWithStats";
 import type Tile from "game/tile/Tile";
 import type EntityMovable from "game/entity/EntityMovable";
 import type { RenderSource, UpdateRenderFlag } from "renderer/IRenderer";
-export default abstract class Entity<TypeType extends number = number, TagType = unknown, CounterType = unknown> extends EventEmitter.Host<IEntityEvents> implements IReferenceable, IInspector, ITemperatureSource, INotificationLocation, IVector3 {
+export default abstract class Entity<DescriptionType = unknown, TypeType extends number = number, TagType = unknown, CounterType = unknown> extends EventEmitter.Host<IEntityEvents> implements IReferenceable, IInspector, ITemperatureSource, INotificationLocation, IVector3 {
     abstract readonly entityType: EntityType;
     abstract readonly tileUpdateType: TileUpdateType;
     id: number;
@@ -58,14 +58,23 @@ export default abstract class Entity<TypeType extends number = number, TagType =
      * This should be cleared when x,y,z is changing.
      */
     private _tilesAround;
+    protected _description?: DescriptionType;
     constructor(entityOptions?: IEntityConstructorOptions<TypeType>);
     get island(): import("../island/Island").default;
     get reference(): Reference | undefined;
+    /**
+     * Get the entities description
+     */
+    get description(): DescriptionType | undefined;
     /**
      * Adds a referenceId to the entity if it doesn't already have one
      */
     addReferenceId(): void;
     abstract getName(): Translation;
+    /**
+     * Called when filling out the entities description for the first time
+     */
+    protected abstract getDescription(): DescriptionType | undefined;
     toString(): string;
     getInspectionId(): string;
     /**
@@ -81,7 +90,7 @@ export default abstract class Entity<TypeType extends number = number, TagType =
     get tilesAround(): Tile[] | undefined;
     protected setCachedTile(tile: Tile): void;
     clearTileCache(): void;
-    isNearby(entity: Entity): boolean;
+    isNearby(entity: Entity<DescriptionType>): boolean;
     isInFov(): boolean;
     setInFov(inFov: boolean): void;
     isOnFire(): FireType;
@@ -96,9 +105,9 @@ export default abstract class Entity<TypeType extends number = number, TagType =
     addTag(tag: TagType): void;
     removeTag(tag: TagType): void;
     abstract isValid(): boolean;
-    get asEntity(): Entity<TypeType, TagType>;
-    get asEntityMovable(): EntityMovable<TypeType, TagType> | undefined;
-    get asEntityWithStats(): EntityWithStats<TypeType, TagType> | undefined;
+    get asEntity(): Entity<DescriptionType, TypeType, TagType>;
+    get asEntityMovable(): EntityMovable<DescriptionType, TypeType, TagType> | undefined;
+    get asEntityWithStats(): EntityWithStats<DescriptionType, TypeType, TagType> | undefined;
     abstract get asCorpse(): Corpse | undefined;
     abstract get asCreature(): Creature | undefined;
     abstract get asDoodad(): Doodad | undefined;

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

@@ -39,7 +39,7 @@ export interface IEntityMovableEvents extends IEntityEvents {
 /**
  * Entity class that allows movement
  */
-export default abstract class EntityMovable<TypeType extends number = number, TagType = unknown, CounterType = unknown> extends Entity<TypeType, TagType, CounterType> implements IRendererOrigin {
+export default abstract class EntityMovable<DescriptionType = unknown, TypeType extends number = number, TagType = unknown, CounterType = unknown> extends Entity<DescriptionType, TypeType, TagType, CounterType> implements IRendererOrigin {
     event: IEventEmitter<this, IEntityMovableEvents>;
     /**
      * Not guaranteed to be synced between the server and client for Human entities
@@ -83,7 +83,7 @@ export default abstract class EntityMovable<TypeType extends number = number, Ta
      * @returns False to block the move
      */
     protected abstract updateTile(fromTile: Tile, toTile: Tile): boolean;
-    get asEntityMovable(): EntityMovable<TypeType, TagType>;
+    get asEntityMovable(): EntityMovable<DescriptionType, TypeType, TagType>;
     /**
      * Regular entities don't have a direction so this will be the same as getTile()
      */

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

@@ -31,7 +31,7 @@ export interface IEntityWithStatsEvents extends IEntityMovableEvents, IStatEvent
  * Entity class that includes stats/status system.
  * Note: We're assuming something with stats is also movable!
  */
-export default abstract class EntityWithStats<TypeType extends number = number, TagType = unknown> extends EntityMovable<TypeType, TagType> implements IStatHost {
+export default abstract class EntityWithStats<DescriptionType = unknown, TypeType extends number = number, TagType = unknown> extends EntityMovable<DescriptionType, TypeType, TagType> implements IStatHost {
     event: IEventEmitter<this, IEntityWithStatsEvents>;
     stats: IStats;
     status: IStatus;
@@ -39,7 +39,7 @@ export default abstract class EntityWithStats<TypeType extends number = number,
     private readonly statusHandlers;
     constructor(entityOptions?: IEntityConstructorOptions<TypeType>);
     protected getApplicableStatusEffects(): Set<StatusType> | undefined;
-    get asEntityWithStats(): EntityWithStats<TypeType, TagType>;
+    get asEntityWithStats(): EntityWithStats<DescriptionType, TypeType, TagType>;
     /**
      * Returns whether the entity has the given `StatusType`
      * @param status The status to check

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

@@ -55,7 +55,7 @@ import type { IVector2, IVector3 } from "utilities/math/IVector";
 import Vector2 from "utilities/math/Vector2";
 import type { IVector4 } from "utilities/math/Vector4";
 export declare const REPUTATION_MAX = 64000;
-export default abstract class Human<TypeType extends number = number> extends EntityWithStats<TypeType> implements IHasInsulation {
+export default abstract class Human<TypeType extends number = number> extends EntityWithStats<unknown, TypeType> implements IHasInsulation {
     static getNameTranslation(): import("../../language/impl/TranslationImpl").default;
     event: IEventEmitter<this, IHumanEvents>;
     anim: number;
@@ -119,6 +119,7 @@ export default abstract class Human<TypeType extends number = number> extends En
     protected gameOptionsCached?: IGameOptionsPlayer;
     protected cachedMovementPenalty?: number;
     constructor(entityOptions?: IEntityConstructorOptions<TypeType>);
+    protected getDescription(): void;
     abstract createNoteManager(): INoteManager;
     abstract createMessageManager(): IMessageManager;
     abstract createQuestManager(): IQuestManager;

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

@@ -30,7 +30,7 @@ export default class ActionExecutor<A extends Array<ActionArgument | ActionArgum
      * Note: Prefer `IActionApi.get` if you're calling this from within another action.
      */
     static get<D extends AnyActionDescription>(action: D): D extends IActionDescription<infer A, infer E, infer R, infer CU, infer AV> ? ActionExecutor<A, E, R, CU, AV> : never;
-    static executeMultiplayer(packet: ActionPacket, executor?: Entity<number, unknown, unknown> | undefined, nonMpActionExecutor?: ActionExecutor<Array<ActionArgument | ActionArgument[]>, Entity, any, any, any[]>): any;
+    static executeMultiplayer(packet: ActionPacket, executor?: Entity<unknown, number, unknown, unknown> | undefined, nonMpActionExecutor?: ActionExecutor<Array<ActionArgument | ActionArgument[]>, Entity, any, any, any[]>): any;
     get executor(): E;
     get actionStack(): ActionType[];
     get lastAction(): ActionType;

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

@@ -26,7 +26,7 @@ import type { IUnserializedCallback } from "save/serializer/ISerializer";
 import { Direction } from "utilities/math/Direction";
 import type { IVector3 } from "utilities/math/IVector";
 import Vector2 from "utilities/math/Vector2";
-export default class Creature extends EntityWithStats<CreatureType> implements IUnserializedCallback, IObject<CreatureType> {
+export default class Creature extends EntityWithStats<ICreatureDescription, CreatureType> implements IUnserializedCallback, IObject<CreatureType> {
     static is(value: any): value is Creature;
     get entityType(): EntityType.Creature;
     get tileUpdateType(): TileUpdateType;
@@ -57,7 +57,6 @@ export default class Creature extends EntityWithStats<CreatureType> implements I
     respawned?: number;
     shouldSkipNextUpdate?: true;
     tameTime?: number;
-    private _description;
     spawnAnimationTime: IMovementTime | undefined;
     constructor(entityOptions?: IEntityConstructorOptions<CreatureType>, aberrant?: boolean);
     /**
@@ -74,7 +73,7 @@ export default class Creature extends EntityWithStats<CreatureType> implements I
      * - `creature.getName(undefined, 3)` // "acid spitter demons"
      */
     getName(article?: false | "definite" | "indefinite", count?: number): Translation;
-    description(): ICreatureDescription | undefined;
+    protected getDescription(): ICreatureDescription | undefined;
     hasAi(aiType: AiType): boolean;
     isHidden(): boolean;
     isRetaliator(): boolean;

package/definitions/game/game/entity/creature/corpse/Corpse.d.ts

@@ -35,7 +35,7 @@ export interface ICorpseEvents extends IEntityEvents {
 /**
  * TODO: extends Entity?
  */
-export default class Corpse extends Entity<CreatureType> implements IObject<CreatureType> {
+export default class Corpse extends Entity<ICorpseDescription, CreatureType> implements IObject<CreatureType> {
     static is(value: any): value is Corpse;
     get entityType(): EntityType.Corpse;
     get tileUpdateType(): TileUpdateType;
@@ -46,7 +46,6 @@ export default class Corpse extends Entity<CreatureType> implements IObject<Crea
     respawned?: number;
     startingDecay?: number;
     step?: number | undefined;
-    private _description;
     private _creatureDescription;
     constructor(entityOptions?: IEntityConstructorOptions<CreatureType>, decay?: number);
     get asCorpse(): Corpse | undefined;
@@ -71,7 +70,7 @@ export default class Corpse extends Entity<CreatureType> implements IObject<Crea
      * - `corpse.getName(undefined, 3)` // "acid spitter demons"
      */
     getName(article?: false | "definite" | "indefinite", count?: number): Translation;
-    description(): ICorpseDescription | undefined;
+    protected getDescription(): ICorpseDescription | undefined;
     creatureDescription(): ICreatureDescription | undefined;
     isValid(): boolean;
     getDecayAtStart(): number;

package/definitions/game/game/inspection/infoProviders/UseInfo.d.ts

@@ -23,9 +23,9 @@ export interface IDescribed {
     referenceId?: number;
     quality?: Quality;
     island: Island;
-    description(): any;
+    description: any;
 }
-export type DescribedDescription<T extends IDescribed> = Exclude<ReturnType<T["description"]>, undefined>;
+export type DescribedDescription<T extends IDescribed> = Exclude<T["description"], undefined>;
 export interface IUseInfoBase<T extends IDescribed, A extends ActionType> {
     entityType: T["entityType"];
     value?: T;

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

@@ -69,7 +69,7 @@ export interface IItemEvents extends IEntityMovableEvents {
     durabilityChange(durability: number, oldDurability: number): any;
     durabilityMaxChange(durabilityMax: number, oldDurabilityMax: number): any;
 }
-export default class Item extends EntityMovable<ItemType, ItemTag, ItemCounter> implements Partial<IContainer>, IContainable, IUnserializedCallback, IObject<ItemType>, IObjectOptions, IContainable, Partial<IContainer>, IHasInsulation, IHasMagic {
+export default class Item extends EntityMovable<IItemDescription, ItemType, ItemTag, ItemCounter> implements Partial<IContainer>, IContainable, IUnserializedCallback, IObject<ItemType>, IObjectOptions, IContainable, Partial<IContainer>, IHasInsulation, IHasMagic {
     get entityType(): EntityType.Item;
     get tileUpdateType(): TileUpdateType;
     readonly event: IEventEmitter<this, IItemEvents>;
@@ -107,7 +107,6 @@ export default class Item extends EntityMovable<ItemType, ItemTag, ItemCounter>
     offsetY?: number;
     [SYMBOL_CONTAINER_CACHED_REFERENCE]?: ContainerReference;
     private _movementOptions?;
-    private _description;
     constructor(itemType?: ItemType | undefined, islandId?: IslandId, quality?: Quality, human?: Human);
     get asCorpse(): undefined;
     get asCreature(): undefined;
@@ -162,7 +161,7 @@ export default class Item extends EntityMovable<ItemType, ItemTag, ItemCounter>
      * - `item.getName(undefined, 3)` // "stone axes"
      */
     getName(article?: false | "definite" | "indefinite", count?: number, showCount?: boolean, showQuality?: boolean, showRenamedQuotes?: boolean, showMagicalType?: boolean): import("../../language/impl/TranslationImpl").default;
-    description(): IItemDescription | undefined;
+    protected getDescription(): IItemDescription | undefined;
     isTransient(): boolean;
     isValid(): boolean;
     isProtected(): boolean;

package/definitions/game/game/item/recipe/Crafter.d.ts

@@ -48,7 +48,7 @@ export default class Crafter {
      * @param includeCrafterTile Whether the tile the crafter is on should be included. Defaults to `true`.
      */
     tilesAroundCrafter(includeCrafterTile?: boolean): Stream<any>;
-    getCrafter(): Entity<number, unknown, unknown>;
+    getCrafter(): Entity<unknown, number, unknown, unknown>;
     getUsable<R extends RecipeRequirementType>(type: R, requirement: InstanceType<RecipeRequirementClass<R>>): Set<RecipeInputType<R>>;
     getUsed<R extends RecipeRequirementType>(type: R, requirement?: InstanceType<RecipeRequirementClass<R>>): Stream<RecipeInputType<R>>;
     /**

package/definitions/game/game/tile/Tile.d.ts

@@ -82,7 +82,7 @@ export default class Tile implements IVector4, Partial<ITileContainer>, IFieldOf
      */
     constructor(island: Island, x: number, y: number, z: number, id: number);
     get point(): IVector3;
-    description(): ITerrainDescription | undefined;
+    get description(): ITerrainDescription | undefined;
     toString(): string;
     get type(): TerrainType;
     /**

package/definitions/game/game/tile/TileEvent.d.ts

@@ -28,7 +28,7 @@ export interface ITileEventEvents extends IEntityMovableEvents {
      */
     fireUpdate(tile: Tile, stage: FireStage | undefined): any;
 }
-export default class TileEvent extends EntityMovable<TileEventType> implements IObject<TileEventType> {
+export default class TileEvent extends EntityMovable<ITileEventDescription, TileEventType> implements IObject<TileEventType> {
     static is(value: any): value is TileEvent;
     get entityType(): EntityType.TileEvent;
     get tileUpdateType(): TileUpdateType;
@@ -48,7 +48,6 @@ export default class TileEvent extends EntityMovable<TileEventType> implements I
      */
     fuel?: number;
     private fireStage?;
-    private _description;
     constructor(entityOptions?: IEntityConstructorOptions<TileEventType>);
     isValid(): boolean;
     get asCorpse(): undefined;
@@ -63,7 +62,7 @@ export default class TileEvent extends EntityMovable<TileEventType> implements I
     get point(): IVector3;
     get tile(): Tile;
     toString(): string;
-    description(): ITileEventDescription | undefined;
+    protected getDescription(): ITileEventDescription | undefined;
     getName(article?: false | "definite" | "indefinite", count?: number): import("../../language/impl/TranslationImpl").default;
     getProducedTemperature(): number | undefined;
     updateFire(tile: Tile): void;

package/definitions/game/save/data/ISaveDataGlobal.d.ts

@@ -99,7 +99,8 @@ export declare enum MusicPlaylist {
 export declare enum TooltipVisibilityOption {
     HiddenUnlessBind = 0,
     ShowMoreInformationWithBind = 1,
-    AlwaysShowMoreInformation = 2
+    AlwaysShowMoreInformation = 2,
+    Default = 1
 }
 export type IOptionsOld = Partial<Pick<IOptions, "bindings">> & Partial<{
     alwaysShowMoreInformation: boolean;

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

@@ -42,7 +42,6 @@ export declare enum ItemDetailIconLocation {
 export declare enum ItemClasses {
     Main = "item-component",
     Icon = "item-component-icon",
-    ItemIcon = "item-component-icon-item",
     ItemIconIsReal = "item-component-icon-item-is-real",
     ActionIcon = "item-component-icon-action",
     ActionIconHasItem = "item-component-icon-action-has-item",
@@ -90,7 +89,6 @@ export default class ItemComponent extends Component {
     protected readonly handler: IItemHandler;
     static registerSlot(slot: ItemSlot): void;
     event: IEventEmitter<this, Events<IDraggableComponent> & IItemSlotEvents>;
-    readonly itemIcon: Component<HTMLElement>;
     readonly magicalIcon: Component<HTMLElement>;
     readonly protectedIcon: Component<HTMLElement>;
     readonly actionIcon: Component<HTMLElement> | undefined;

package/package.json

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