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

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

@@ -12,20 +12,26 @@ import type { SfxType } from "audio/IAudio";
 import type { BiomeType } from "game/biome/IBiome";
 import type Doodad from "game/doodad/Doodad";
 import type Creature from "game/entity/creature/Creature";
+import type { IEntityWithStatsEvents } from "game/entity/EntityWithStats";
 import type Human from "game/entity/Human";
-import type { AiType, DamageType, Defense, ICausesStatusEffect, IEntityEvents, MoveType } from "game/entity/IEntity";
+import type { DamageType, Defense, ICausesStatusEffect, IStatChangeInfo, MoveType } from "game/entity/IEntity";
+import { AiType } from "game/entity/IEntity";
+import type { IStat } from "game/entity/IStats";
 import type { IPackedMessage } from "game/entity/player/IMessageManager";
 import type { ItemType, ItemTypeGroup } from "game/item/IItem";
+import type Item from "game/item/Item";
 import type { LootGroupType } from "game/item/LootGroups";
 import type { ITemperatureDescription } from "game/temperature/ITemperature";
-import type { ITile } from "game/tile/ITerrain";
 import type { TileEventType } from "game/tile/ITileEvent";
+import type Tile from "game/tile/Tile";
+import type { WorldZ } from "game/WorldZ";
 import type Message from "language/dictionary/Message";
 import type TranslationImpl from "language/impl/TranslationImpl";
 import type Translation from "language/Translation";
 import type { IModdable } from "mod/ModRegistry";
 import type { StatNotificationType } from "renderer/notifier/INotifier";
 import type { IRGB } from "utilities/Color";
+import type { IRange } from "utilities/math/Range";
 export declare enum CreatureType {
     Slime = 0,
     JellyCube = 1,
@@ -82,7 +88,12 @@ export declare enum CreatureType {
     Dryad = 52,
     Coyote = 53,
     KomodoMonitor = 54,
-    BogBody = 55
+    BogBody = 55,
+    WoodGolem = 56,
+    ClayGolem = 57,
+    GraniteGolem = 58,
+    SandstoneGolem = 59,
+    BasaltGolem = 60
 }
 export interface ICreatureOld extends Creature {
     hp: number;
@@ -142,6 +153,14 @@ export interface ICreatureDescription extends IModdable, ITemperatureDescription
      * 100 means the creature always skips their movement
      */
     skipMovementChance?: number;
+    /**
+     * Prevents the creature from spawning for the provided WorldZ's
+     */
+    preventSpawnZs?: Set<WorldZ>;
+    /**
+     * Prevents release the creature from its tamed state
+     */
+    preventRelease?: boolean;
     fishable?: boolean;
     blood?: IRGB;
     aberrantBlood?: IRGB;
@@ -168,6 +187,18 @@ export interface ICreatureDescription extends IModdable, ITemperatureDescription
     particlesOnMove?: boolean;
     particlesOnSpawn?: boolean;
     providesFire?: boolean;
+    /**
+     * If true, creature burns you when you pet it
+     */
+    pettingCausesBurns?: boolean;
+    /**
+     * If true, creature takes damage when you pour water/milk on it
+     */
+    damageOnPour?: boolean;
+    /**
+     * If true, stoking restores the creatures hp a bit
+     */
+    stokingRestoresHealth?: boolean;
     canTrample?: boolean;
     helpPlants?: boolean;
     speed?: number;
@@ -178,16 +209,86 @@ export interface ICreatureDescription extends IModdable, ITemperatureDescription
     texOffsetY?: number;
     isTall?: boolean;
     spawn?: OptionalDescriptions<BiomeType, ICreatureSpawn>;
+    /**
+     * True if the creature moves around by teleporting through time AND space
+     */
+    teleportMovement?: boolean;
+    /**
+     * True if the creature can open doors
+     */
+    canOpenDoors?: boolean;
+    /**
+     * Extra chance for random despawns
+     */
+    extraDespawnChance?: number;
+    /**
+     * Despawn the creature when it's day in the overworld
+     */
+    despawnInDayLight?: boolean;
+    /**
+     * Change ai to be scared when it's day in the overworld
+     */
+    scareDuringDayLight?: boolean;
     /**
      * If true, this creature will get the "produce" stat.
+     * If it's a function, the result value will be the change timer.
      */
-    hasProduce?: boolean;
+    hasProduce?: true | ((creature: Creature) => number);
     /**
      * The chance (for example, 0.25) it will be scared from a scarecrow (in a radius) when moving minus how close it is to the scarecrow (calculated in checkCreatureMove).
      * Also, the chance it will not spawn in the radius of one.
      * If set to 1, it will never move close to a scarecrow when visible to it and it will never spawn in view of one.
      */
     chanceOfScarecrowScare?: number;
+    /**
+     * If set to true, they cannot be caged.
+     */
+    noCage?: boolean;
+    /**
+     * The weight of the creature when placed inside a cage (or something else in the future?).
+     */
+    weight: number;
+    aberrantWeight: number;
+    /**
+     * If set, creature will only listen to certain commands.
+     */
+    allowedCommands?: AiType[];
+    /**
+     * When true, the player will always be able to command the creature, regardless of their taming skill.
+     */
+    alwaysAllowCommands?: boolean;
+    /**
+     * Called when a stat changes
+     */
+    onStatChange?: (creature: Creature, stat: IStat, oldValue: number, info: IStatChangeInfo) => void;
+    /**
+     * Called when the creature dies
+     */
+    onDeath?: (creature: Creature, damageTile: Tile, damageInfo: IDamageInfo) => void;
+    /**
+     * Called when the creature is damaged
+     */
+    onDamaged?: (creature: Creature, damageInfo: IDamageInfo, attackOutcome: number) => void;
+    /**
+     * Called when performing special abilities
+     * @returns True when an ability was performed
+     */
+    specialAbility?: (creature: Creature, enemy: Human | Creature | undefined, bypass?: boolean) => boolean;
+    /**
+     * Special attack stuff
+     */
+    specialAttack?: {
+        /**
+         * Called when checking if a special attack should be called
+         * @returns True when special attack should be called
+         */
+        shouldSpecialAttack: (creature: Creature, specialAttackChanceMultiplier: number) => boolean;
+        /**
+         * Called when special attacking
+         * @returns True when nothing else should be done after the special attack
+         */
+        doSpecialAttack: (creature: Creature, enemy: Creature | Human) => boolean;
+    };
 }
 export interface ICreatureSpawn {
     /**
@@ -239,13 +340,14 @@ export interface IDamageOutcome {
     resistTypes: DamageType[];
     vulnerable: number;
     vulnerableTypes: DamageType[];
+    immunities: DamageType[];
     noDamage: boolean;
     regenerate: number[];
     soundEffect?: SfxType;
     statNotifications: Array<[StatNotificationType, number]>;
     messages: IPackedMessage[];
 }
-export interface ICreatureEvents extends IEntityEvents {
+export interface ICreatureEvents extends IEntityWithStatsEvents {
     /**
      * Called before a creature attacks
      * @param enemy The enemy (human or creature)
@@ -255,13 +357,10 @@ export interface ICreatureEvents extends IEntityEvents {
     /**
      * Called when a creature tries to move
      * @param tile The tile the creature is trying to move to
-     * @param x The x coordinate of the tile
-     * @param y The y coordinate of the tile
-     * @param z The z coordinate of the tile
      * @param moveType The creatures move type
      * @returns True if the creature can move, false if the creature cannot move, or undefined to use the default logic
      */
-    canMove?(tile: ITile, x: number, y: number, z: number, moveType: MoveType): boolean | undefined;
+    canMove?(tile: Tile, moveType: MoveType): boolean | undefined;
     /**
      * Called when a creature tries to face a new direction
      * @param x The x coordinate of the creature's facing direction
@@ -295,3 +394,43 @@ export interface ICreatureEvents extends IEntityEvents {
      */
     damage?(damageInfo: IDamageInfo): number | undefined;
 }
+export declare const CREATURE_FLEE_DISTANCE_SQ: number;
+export declare const TAMED_CREATURE_FOLLOW_CLOSE_DISTANCE = 1;
+export declare const TAMED_CREATURE_FOLLOW_FAR_DISTANCE = 6;
+export declare const settableAiTypes: Set<AiType>;
+export interface ICreatureAttackOutcomeBase {
+    enemy?: Human | Creature;
+    willAttack: boolean;
+    breakAway: boolean;
+    hidden: boolean;
+    ai: AiType;
+}
+export interface ICreatureAttackOutcomeNoAttack extends ICreatureAttackOutcomeBase {
+    willAttack: false;
+    hidden: false;
+}
+export interface ICreatureAttackOutcomeHidden extends ICreatureAttackOutcomeBase {
+    willAttack: true;
+    hidden: true;
+}
+export interface ICreatureAttackOutcomeAttack extends ICreatureAttackOutcomeBase {
+    enemy: Human | Creature;
+    willAttack: true;
+    hidden: false;
+    ai: AiType;
+    maxParryingMultiplier: number;
+    damagedVehicle?: Item;
+    combatNote?: any[];
+    damageEquipment: boolean;
+    creatureHitRange: IRange;
+    enemyDefense: number;
+    pityPointOfDamageChance: number;
+    effectiveness: number;
+    damageScale: number;
+}
+export type CreatureAttackOutcome = ICreatureAttackOutcomeNoAttack | ICreatureAttackOutcomeHidden | ICreatureAttackOutcomeAttack;
+export interface ICreatureCheckMoveOptions {
+    ignoreHuman: Human;
+    ignoreScareCrow: boolean;
+    ignoreMoveTypeNone: boolean;
+}

package/definitions/game/game/{inspection/infoProviders/creature/CreatureHealth.d.ts → entity/creature/SpecialAbilities.d.ts}

@@ -8,10 +8,6 @@
  * 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 Human from "game/entity/Human";
 import type Creature from "game/entity/creature/Creature";
-import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
-import HealthInfoProvider from "game/inspection/infoProviders/entity/Health";
-export default class CreatureHealthInfoProvider extends HealthInfoProvider<Creature> {
-    getDefaultDisplayLevel(): InfoDisplayLevel;
-    getName(): import("../../../../language/impl/TranslationImpl").default;
-}
+export declare const specialAbilityRandomDrops: (creature: Creature, enemy: Human | Creature | undefined, bypass?: boolean) => boolean;

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

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2021 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 { TileGroup } from "game/entity/creature/ICreature";
+import { TerrainType } from "game/tile/ITerrain";
+export declare const tileGroups: Descriptions<TileGroup, Set<TerrainType>>;

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

@@ -8,19 +8,21 @@
  * 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 { IEventEmitter } from "event/EventEmitter";
 import type { ICorpseDescription } from "game/entity/creature/corpse/ICorpse";
+import type { ICreatureDescription } from "game/entity/creature/ICreature";
 import { CreatureType } from "game/entity/creature/ICreature";
-import type { CreationId } from "game/IGame";
+import Entity from "game/entity/Entity";
+import type { IEntityConstructorOptions, IEntityEvents } from "game/entity/IEntity";
+import { EntityType } from "game/entity/IEntity";
+import { TileUpdateType } from "game/IGame";
 import type { IObject } from "game/IObject";
-import type { IslandId } from "game/island/IIsland";
 import { ItemType } from "game/item/IItem";
-import type { IReferenceable } from "game/reference/IReferenceManager";
-import type { ITile } from "game/tile/ITerrain";
-import type { ISerializedTranslation } from "language/ITranslation";
+import type Tile from "game/tile/Tile";
 import type Translation from "language/Translation";
+import type { Article } from "language/Translation";
 import type { IVector3 } from "utilities/math/IVector";
-export interface ICorpseEvents {
+export interface ICorpseEvents extends IEntityEvents {
     /**
      * Called when the entity is created in the game
      * Also called for players that "rejoin" the game
@@ -34,26 +36,30 @@ export interface ICorpseEvents {
 /**
  * TODO: extends Entity?
  */
-export default class Corpse extends EventEmitter.Host<ICorpseEvents> implements IObject<CreatureType>, IVector3, IReferenceable {
+export default class Corpse extends Entity<ICorpseDescription, CreatureType> implements IObject<CreatureType> {
     static is(value: any): value is Corpse;
-    readonly objectType: CreationId.Corpse;
+    get entityType(): EntityType.Corpse;
+    get tileUpdateType(): TileUpdateType;
+    readonly event: IEventEmitter<this, ICorpseEvents>;
     aberrant?: boolean | undefined;
     decay?: number | undefined;
-    startingDecay?: number;
-    id: number;
     qualityBonus?: number | undefined;
-    referenceId?: number;
-    renamed?: string | ISerializedTranslation | undefined;
-    step?: number | undefined;
     respawned?: number;
-    type: CreatureType;
-    x: number;
-    y: number;
-    z: number;
-    islandId: IslandId;
-    private _description;
-    constructor(type?: CreatureType, islandId?: `${number},${number}`, x?: number, y?: number, z?: number, decay?: number);
-    get island(): import("../../../island/Island").default;
+    startingDecay?: number;
+    step?: number | undefined;
+    private _creatureDescription;
+    constructor(entityOptions?: IEntityConstructorOptions<CreatureType>, decay?: number);
+    get asCorpse(): Corpse | undefined;
+    get asCreature(): undefined;
+    get asDoodad(): undefined;
+    get asHuman(): undefined;
+    get asLocalPlayer(): undefined;
+    get asNPC(): undefined;
+    get asPlayer(): undefined;
+    get asTileEvent(): undefined;
+    get asItem(): undefined;
+    get point(): IVector3;
+    get tile(): Tile;
     toString(): string;
     /**
      * @param article Whether to include an article for the name of the creature. Uses the article rules on the language. Defaults to `true`.
@@ -64,12 +70,13 @@ export default class Corpse extends EventEmitter.Host<ICorpseEvents> implements
      * - `corpse.getName(false)` // "acid spitter demon"
      * - `corpse.getName(undefined, 3)` // "acid spitter demons"
      */
-    getName(article?: false | "definite" | "indefinite", count?: number): Translation;
-    description(): ICorpseDescription | undefined;
-    getTile(): ITile;
+    getName(article?: Article, count?: number): Translation;
+    protected getDescription(): ICorpseDescription | undefined;
+    creatureDescription(): ICreatureDescription | undefined;
     isValid(): boolean;
     getDecayAtStart(): number;
-    addToTile(tile: ITile): void;
+    addToTile(tile: Tile): void;
+    removeFromTile(updateTile: boolean): void;
     update(): void;
     getResources(clientSide?: boolean): ItemType[];
     protected onCreated(): void;

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

@@ -11,20 +11,20 @@
 import Stream from "@wayward/goodstream/Stream";
 import Corpse from "game/entity/creature/corpse/Corpse";
 import type { CreatureType } from "game/entity/creature/ICreature";
-import { CreationId } from "game/IGame";
 import { ObjectManager } from "game/ObjectManager";
+import type Tile from "game/tile/Tile";
 import type { TextContext } from "language/ITranslation";
+import { Article } from "language/Translation";
 export interface ICorpseManagerEvents {
     create(corpse: Corpse): any;
     remove(corpse: Corpse): any;
 }
 export default class CorpseManager extends ObjectManager<Corpse, ICorpseManagerEvents> {
-    protected readonly creationId: CreationId;
     load(): void;
-    create(type: CreatureType, x: number, y: number, z: number, decay?: number, aberrant?: boolean, name?: string, qualityBonus?: number, respawned?: number): Corpse | undefined;
+    create(type: CreatureType, tile: Tile, decay?: number, aberrant?: boolean, name?: string, qualityBonus?: number, respawned?: number): Corpse | undefined;
     updateAll(): void;
     remove(corpse: Corpse): void;
-    getName(typeOrCorpse: CreatureType | Corpse, article?: false | "definite" | "indefinite", count?: number, showCount?: boolean): import("../../../../language/impl/TranslationImpl").default;
-    getCorpseTranslations(corpses: Corpse[], article?: false | "definite" | "indefinite", context?: TextContext): Stream<import("../../../../language/impl/TranslationImpl").default>;
-    getCorpseListTranslation(corpses: Corpse[], article?: false | "definite" | "indefinite", context?: TextContext): import("../../../../language/impl/TranslationImpl").default;
+    getName(typeOrCorpse: CreatureType | Corpse, article?: Article, count?: number, showCount?: boolean): import("../../../../language/impl/TranslationImpl").default;
+    getCorpseTranslations(corpses: Corpse[], article?: Article, context?: TextContext): Stream<import("../../../../language/impl/TranslationImpl").default>;
+    getCorpseListTranslation(corpses: Corpse[], article?: Article, context?: TextContext): import("../../../../language/impl/TranslationImpl").default;
 }

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

@@ -11,4 +11,3 @@
 import type { ICorpseDescription } from "game/entity/creature/corpse/ICorpse";
 import { CreatureType } from "game/entity/creature/ICreature";
 export declare const corpseDescriptions: OptionalDescriptions<CreatureType, ICorpseDescription>;
-export default corpseDescriptions;

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

@@ -10,6 +10,9 @@
  */
 import type { SkillType } from "game/entity/IHuman";
 import type { ItemType } from "game/item/IItem";
+import type { TerrainType } from "game/tile/ITerrain";
+import type { TileEventType } from "game/tile/ITileEvent";
+import type Message from "language/dictionary/Message";
 import type { IModdable } from "mod/ModRegistry";
 import type { IRGB } from "utilities/Color";
 export interface ICorpseDescription extends IModdable {
@@ -25,8 +28,22 @@ export interface ICorpseDescription extends IModdable {
     isFlammable?: boolean;
     isTall?: boolean;
     respawns?: boolean;
+    /**
+     * Things to do when a corpse decays
+     */
+    createOnDecay?: Partial<ICorpseCreateOnSideEffects>;
+    /**
+     * Things to do when a corpse is butchered
+     */
+    createOnButcher?: Partial<ICorpseCreateOnSideEffects> & {
+        message?: Message;
+    };
 }
 export interface ICorpseResourceDrop {
     item: ItemType;
     chance?: number;
 }
+export interface ICorpseCreateOnSideEffects {
+    tileType: TerrainType;
+    tileEvent: TileEventType;
+}

package/definitions/game/game/entity/flowfield/FlowField.d.ts

@@ -15,6 +15,7 @@ export default class FlowField implements IPreSerializeCallback {
     readonly x: number;
     readonly y: number;
     readonly z: number;
+    readonly mapSize: number;
     readonly size: number;
     readonly moveType: MoveType;
     encodedFlowField: Uint32Array | undefined;
@@ -22,13 +23,12 @@ export default class FlowField implements IPreSerializeCallback {
     private instance;
     private flowField;
     private penaltyField;
-    constructor(x: number | undefined, y: number, z: number, size: number, moveType: MoveType);
+    constructor(x: number | undefined, y: number, z: number, mapSize: number, size: number, moveType: MoveType);
     toString(): string;
     preSerializeObject(): void;
     load(): void;
     unload(): void;
     getZ(): number;
-    getHashCodes(): string[];
     getFieldValue(x: number, y: number): number;
     updateField(flowFieldHumans: Human[]): void;
     resetPenalty(gridIndex: number): void;

package/definitions/game/game/entity/flowfield/FlowFieldManager.d.ts

@@ -24,7 +24,7 @@ export default class FlowFieldManager {
     private readonly island;
     private readonly size;
     delegate: DebugRendererDelegate;
-    flowFields: Record<string, FlowField>;
+    flowFields: Map<"-1-0" | "-1-1" | "-1-2" | "-1-4" | "-1-8" | "-1-16" | "-1-32" | "-1-64" | "-1-128" | "-1-256" | "-1-512" | "-1-1024" | "-1-15" | "0-0" | "0-1" | "0-2" | "0-4" | "0-8" | "0-16" | "0-32" | "0-64" | "0-128" | "0-256" | "0-512" | "0-1024" | "0-15" | "1-0" | "1-1" | "1-2" | "1-4" | "1-8" | "1-16" | "1-32" | "1-64" | "1-128" | "1-256" | "1-512" | "1-1024" | "1-15", FlowField>;
     humans: IFlowFieldHuman[];
     private _flowFieldHumans;
     constructor(island: Island, size: number);
@@ -50,6 +50,5 @@ export default class FlowFieldManager {
     reset(): void;
     private getDirection;
     private getFlowField;
-    private getFlowFields;
 }
 export {};

package/definitions/game/game/entity/flowfield/IFlowFieldManager.d.ts

@@ -8,4 +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
  */
-export declare const blockedPenalty = 11;
+import type { WorldZ } from "game/WorldZ";
+import type { MoveType } from "game/entity/IEntity";
+export declare const flowFieldBlockedPenalty = 11;
+export type FlowFieldKey = `${WorldZ}-${MoveType}`;

package/definitions/game/game/entity/npc/INPC.d.ts

@@ -8,6 +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 type { IEntityConstructorOptions } from "game/entity/IEntity";
+import type { NPCType } from "game/entity/npc/INPCs";
+export type INPCConstructorOptions = Omit<IEntityConstructorOptions<NPCType>, "type">;
 export interface INPCOld {
     equipped?: Record<number, number>;
 }
+export declare enum ShipperNPCInteractType {
+    OpenContainer = 0,
+    ShipToIsland = 1
+}

package/definitions/game/game/entity/npc/INPCs.d.ts

@@ -11,5 +11,6 @@
 export declare enum NPCType {
     Merchant = 0,
     DeathKnight = 1,
-    Controllable = 2
+    Controllable = 2,
+    Shipper = 3
 }