@wayward/types 2.14.0-beta.dev.20240213.1 → 2.14.0-beta.dev.20240216.1

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

@@ -174,6 +174,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     getGameMode(): GameMode;
     getGameOptionsBeforeModifiers(): IGameOptions;
     getGameOptions(): IGameOptions;
+    uncacheGameOptions(): void;
     updateGameOptions(gameOptions: IGameOptions): void;
     initializeGameOptions(seed: string | number, mode?: GameMode, options?: IGameOptions, milestoneModifiers?: Set<Milestone>): void;
     initializeModifiers(): void;

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

@@ -33,6 +33,12 @@ import type Version from "@wayward/game/utilities/Version";
 import type { IVector2, IVector3 } from "@wayward/game/utilities/math/IVector";
 import type { IRange } from "@wayward/utilities/math/Range";
 export interface IGameEvents {
+    /**
+     * Called when game options are first processed, after modifiers are applied.
+     *
+     * You can use this combined with `game.uncacheGameOptions()` to dynamically modify game options.
+     */
+    getGameOptions(gameOptions: IGameOptions): IGameOptions;
     /**
      * Called when the game is starting
      * @param isLoadingSave True if a save game was loaded

package/definitions/game/game/deity/AlignmentManager.d.ts

@@ -53,7 +53,7 @@ export declare class Alignment implements IReadableAlignment {
     /**
      * Reduce the "good" of the player. The value will be rounded and clamped.
      */
-    reduceGood(value: number, check?: boolean): this;
+    reduceGood(value: number, capCheck?: boolean): this;
     get goodCap(): number;
     /**
      * The current "evil" of the player. A positive integer from 0 to maximum value.
@@ -71,7 +71,7 @@ export declare class Alignment implements IReadableAlignment {
     /**
      * Reduce the "evil" of the player. The value will be rounded and clamped.
      */
-    reduceEvil(value: number, check?: boolean): this;
+    reduceEvil(value: number, capCheck?: boolean): this;
     get evilCap(): number;
     get fraction(): number;
     get deity(): number;

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

@@ -27,7 +27,7 @@ import type NPC from "@wayward/game/game/entity/npc/NPC";
 import type Player from "@wayward/game/game/entity/player/Player";
 import type { IWell } from "@wayward/game/game/island/IIsland";
 import { LiquidType } from "@wayward/game/game/island/IIsland";
-import type { ContainerSort, DisplayableItemType, IContainer, IItemVehicle, ILiquidGather, ItemTypeExtra } from "@wayward/game/game/item/IItem";
+import type { ContainerSort, DisplayableItemType, IContainer, IItemVehicle, ILiquidGather, IUncastableContainer, ItemTypeExtra } from "@wayward/game/game/item/IItem";
 import { ItemType } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 import type { IHasMagic } from "@wayward/game/game/magic/MagicalPropertyManager";
@@ -137,6 +137,7 @@ export default class Doodad extends EntityMovable<IDoodadDescription, DoodadType
     get asPlayer(): undefined;
     get asTileEvent(): undefined;
     get asItem(): undefined;
+    get asTile(): undefined;
     get asContainer(): this & IContainer | undefined;
     isCorpse(): this is Corpse;
     isCreature(): this is Creature;
@@ -147,6 +148,8 @@ export default class Doodad extends EntityMovable<IDoodadDescription, DoodadType
     isPlayer(): this is Player;
     isTileEvent(): this is TileEvent;
     isItem(): this is Item;
+    isTile(): this is Tile;
+    isContainer(): this is IUncastableContainer;
     toString(): string;
     getRegistrarId(): number;
     /**
@@ -281,6 +284,7 @@ export default class Doodad extends EntityMovable<IDoodadDescription, DoodadType
      * @param growthBonus The bonus that is applied (on top of a default of 10) to the plants decay (so it grows faster).
      */
     healOrHarmPlant(liquid: LiquidType, growthBonus?: number): void;
+    initializeMagicalPropertyManager(): MagicalPropertyManager;
     isLitAndCanRevert(): boolean;
     /**
      * Reverts lit doodads if they provide fire and have a revert doodad type set.

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

@@ -138,6 +138,10 @@ export interface IDoodadDescription extends IObjectDescription, IModdable, ICaus
     tileOverLayerType?: TileLayerType;
     trapDamage?: number;
     waterStill?: boolean;
+    /**
+     * Whether magical properties have no effect on this doodad.
+     */
+    magicInert?: true;
     /**
      * The region where items are stacked.
      * The default region is { xMin: 0, xMax: 0, yMin: 1, yMax: 1 }

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

@@ -15,7 +15,7 @@ import type Doodad from "@wayward/game/game/doodad/Doodad";
 import type EntityMovable from "@wayward/game/game/entity/EntityMovable";
 import type EntityWithStats from "@wayward/game/game/entity/EntityWithStats";
 import type Human from "@wayward/game/game/entity/Human";
-import type { IEntityConstructorOptions, IEntityEvents } from "@wayward/game/game/entity/IEntity";
+import type { ICastable, IEntityConstructorOptions, IEntityEvents } from "@wayward/game/game/entity/IEntity";
 import { EntityType } from "@wayward/game/game/entity/IEntity";
 import type { IHumanBound } from "@wayward/game/game/entity/IEntityManager";
 import type { ActionType } from "@wayward/game/game/entity/action/IAction";
@@ -26,6 +26,7 @@ import type Player from "@wayward/game/game/entity/player/Player";
 import type { IInspector } from "@wayward/game/game/inspection/IInfoProvider";
 import type { IslandId } from "@wayward/game/game/island/IIsland";
 import type Island from "@wayward/game/game/island/Island";
+import type { IUncastableContainer } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 import type { EntityReferenceTypes, IReferenceable, Reference } from "@wayward/game/game/reference/IReferenceManager";
 import type { ITemperatureSource } from "@wayward/game/game/temperature/ITemperature";
@@ -39,7 +40,7 @@ import type { IVector3 } from "@wayward/game/utilities/math/IVector";
 import type { IVector4 } from "@wayward/game/utilities/math/Vector4";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
 import type { WorldZ } from "@wayward/utilities/game/WorldZ";
-export default abstract class Entity<DescriptionType = unknown, TypeType extends number = number, EntityReferenceType extends EntityReferenceTypes = EntityReferenceTypes, TagType = unknown> extends EventEmitter.Host<IEntityEvents> implements IReferenceable, IInspector, ITemperatureSource, INotificationLocation, IVector4 {
+export default abstract class Entity<DescriptionType = unknown, TypeType extends number = number, EntityReferenceType extends EntityReferenceTypes = EntityReferenceTypes, TagType = unknown> extends EventEmitter.Host<IEntityEvents> implements IReferenceable, IInspector, ITemperatureSource, INotificationLocation, IVector4, ICastable {
     abstract readonly entityType: EntityType;
     abstract readonly tileUpdateType: TileUpdateType;
     id: number;
@@ -157,6 +158,8 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
     abstract get asPlayer(): Player | undefined;
     abstract get asTileEvent(): TileEvent | undefined;
     abstract get asItem(): Item | undefined;
+    abstract get asTile(): Tile | undefined;
+    abstract get asContainer(): (this & IUncastableContainer) | undefined;
     abstract isCorpse(): this is Corpse;
     abstract isCreature(): this is Creature;
     abstract isDoodad(): this is Doodad;
@@ -166,5 +169,9 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
     abstract isPlayer(): this is Player;
     abstract isTileEvent(): this is TileEvent;
     abstract isItem(): this is Item;
+    abstract isTile(): this is Tile;
+    abstract isContainer(): this is IUncastableContainer;
+    isEntity(): this is Entity;
     asType(type: TypeType): this | undefined;
+    get asUnion(): Player | NPC | Creature | TileEvent | Item | Corpse | Doodad;
 }

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

@@ -36,7 +36,7 @@ import type { ISkillAttribute } from "@wayward/game/game/entity/skill/ISkills";
 import SkillManager from "@wayward/game/game/entity/skill/SkillManager";
 import type { IMobCheck, IMoveToIslandOptions, IslandId } from "@wayward/game/game/island/IIsland";
 import type Island from "@wayward/game/game/island/Island";
-import type { EquipEffectByType, EquipEffects, IContainer, IRanged, RecipeLevel } from "@wayward/game/game/item/IItem";
+import type { ContainerSort, ContainerType, EquipEffectByType, EquipEffects, IContainer, IRanged, IUncastableContainer, RecipeLevel } from "@wayward/game/game/item/IItem";
 import { EquipEffect, ItemType, ItemTypeGroup } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 import ItemReference from "@wayward/game/game/item/ItemReference";
@@ -55,6 +55,7 @@ import Message from "@wayward/game/language/dictionary/Message";
 import type TranslationImpl from "@wayward/game/language/impl/TranslationImpl";
 import type { FieldOfView } from "@wayward/game/renderer/fieldOfView/FieldOfView";
 import { CanASeeBType } from "@wayward/game/renderer/fieldOfView/IFieldOfView";
+import type { SortDirection } from "@wayward/game/save/ISaveManager";
 import type { IOptions } from "@wayward/game/save/data/ISaveDataGlobal";
 import { Direction } from "@wayward/game/utilities/math/Direction";
 import type { IVector2, IVector3 } from "@wayward/game/utilities/math/IVector";
@@ -65,7 +66,7 @@ interface IEquip {
     item: Item;
     equipType: EquipType;
 }
-export default abstract class Human<TypeType extends number = number, EntityReferenceType extends ReferenceType.Player | ReferenceType.NPC = ReferenceType.Player | ReferenceType.NPC> extends EntityWithStats<unknown, TypeType, EntityReferenceType> implements IHasInsulation {
+export default abstract class Human<TypeType extends number = number, EntityReferenceType extends ReferenceType.Player | ReferenceType.NPC = ReferenceType.Player | ReferenceType.NPC> extends EntityWithStats<unknown, TypeType, EntityReferenceType> implements IHasInsulation, IContainer {
     static getNameTranslation(): TranslationImpl;
     event: IEventEmitter<this, IHumanEvents>;
     anim: number;
@@ -88,7 +89,6 @@ export default abstract class Human<TypeType extends number = number, EntityRefe
     equippedReferences: Map<EquipType, ItemReference>;
     flyingDelay?: number;
     handEquippedToLast: EquipType.OffHand | EquipType.MainHand;
-    inventory: IContainer;
     isConnecting: boolean;
     lastAttackedByReference?: Reference;
     manualTickActionDelay?: number;
@@ -108,6 +108,9 @@ export default abstract class Human<TypeType extends number = number, EntityRefe
     vehicleItemReference: ItemReference | undefined;
     connectedVehicleId?: number;
     walkSoundCounter: number;
+    containedItems: Item[];
+    sort?: ContainerSort;
+    sortDirection?: SortDirection;
     readonly movementIntent: IMovementIntent;
     walkPath?: IWalkPath;
     identifier: string;
@@ -115,7 +118,10 @@ export default abstract class Human<TypeType extends number = number, EntityRefe
     quests: IQuestManager;
     messages: IMessageManager;
     notes: INoteManager;
+    /** @deprecated (use the entity itself) */
+    readonly inventory: IContainer;
     private readonly privateStore;
+    containerType?: ContainerType;
     nextMoveTime: number;
     nextMoveDirection?: Direction.Cardinal | Direction.None;
     private lastVehicleMoveDirection?;
@@ -131,7 +137,7 @@ export default abstract class Human<TypeType extends number = number, EntityRefe
     protected gameOptionsCached?: IGameOptionsPlayer;
     protected cachedMovementPenalty?: number;
     constructor(entityOptions?: IEntityConstructorOptions<TypeType>);
-    protected getDescription(): void;
+    protected getDescription(): undefined;
     abstract createNoteManager(): INoteManager;
     abstract createMessageManager(): IMessageManager;
     abstract createQuestManager(): IQuestManager;
@@ -452,15 +458,20 @@ export default abstract class Human<TypeType extends number = number, EntityRefe
     get asCorpse(): undefined;
     get asCreature(): undefined;
     get asDoodad(): undefined;
-    get asHuman(): Human;
+    get asHuman(): this;
+    get asGenericHuman(): Human;
     get asTileEvent(): undefined;
     get asItem(): undefined;
+    get asTile(): undefined;
+    get asContainer(): this & IUncastableContainer;
     isCorpse(): this is Corpse;
     isCreature(): this is Creature;
     isDoodad(): this is Doodad;
     isHuman(): this is Human;
     isTileEvent(): this is TileEvent;
     isItem(): this is Item;
+    isTile(): this is Tile;
+    isContainer(): this is IUncastableContainer;
     get point(): IVector3;
     get tile(): Tile;
     /**

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

@@ -11,10 +11,17 @@
 import type { IMovementTime } from "@wayward/game/game/IGame";
 import type Doodad from "@wayward/game/game/doodad/Doodad";
 import type Entity from "@wayward/game/game/entity/Entity";
+import type Human from "@wayward/game/game/entity/Human";
 import type { Delay, MovingState, SkillType } from "@wayward/game/game/entity/IHuman";
 import type { 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";
+import type NPC from "@wayward/game/game/entity/npc/NPC";
+import type Player from "@wayward/game/game/entity/player/Player";
+import type { IUncastableContainer } from "@wayward/game/game/item/IItem";
 import type Item from "@wayward/game/game/item/Item";
 import type Tile from "@wayward/game/game/tile/Tile";
+import type TileEvent from "@wayward/game/game/tile/TileEvent";
 import type { Direction } from "@wayward/game/utilities/math/Direction";
 export interface IEntityEvents {
     /**
@@ -42,6 +49,33 @@ export interface IEntityConstructorOptions<TypeType extends number> {
     tile: Tile;
 }
 export declare function asEntity(value?: unknown): Entity | undefined;
+export interface ICastable {
+    get asEntity(): Entity | undefined;
+    get asUnion(): Corpse | Creature | Doodad | Human | NPC | Player | TileEvent | Item | Tile | undefined;
+    get asCorpse(): Corpse | undefined;
+    get asCreature(): Creature | undefined;
+    get asDoodad(): Doodad | undefined;
+    get asHuman(): Human | undefined;
+    get asNPC(): NPC | undefined;
+    get asPlayer(): Player | undefined;
+    get asLocalPlayer(): Player | undefined;
+    get asTileEvent(): TileEvent | undefined;
+    get asItem(): Item | undefined;
+    get asTile(): Tile | undefined;
+    get asContainer(): (this & IUncastableContainer) | undefined;
+    isEntity(): this is Entity;
+    isCorpse(): this is Corpse;
+    isCreature(): this is Creature;
+    isDoodad(): this is Doodad;
+    isHuman(): this is Human;
+    isNPC(): this is NPC;
+    isPlayer(): this is Player;
+    get isLocalPlayer(): boolean;
+    isTileEvent(): this is TileEvent;
+    isItem(): this is Item;
+    isTile(): this is Tile;
+    isContainer(): this is IUncastableContainer;
+}
 export declare enum StatusEffectChangeReason {
     Gained = 0,
     Passed = 1,