@wayward/types 2.13.1-beta.dev.20230514.1 → 2.13.2-beta

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Wayward
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+The MIT License (MIT)
+
+Copyright (c) 2019 Wayward
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,11 +1,27 @@
-# Wayward Types
-
-TypeScript declarations used for modding Wayward.
-
-## Usage
-
-Visit the [Wiki](https://github.com/WaywardGame/types/wiki/mod-create-&-update) of this repository for more information on `+mod create` to create mods and `+mod update` to update preexisting mods.
-
-## Documentation
-
-Visit [waywardgame.github.io](https://waywardgame.github.io/) for documentation and an organized view of these types.
+# [Wayward Modding Guide](https://github.com/WaywardGame/types/wiki)
+Learn how to mod Wayward.
+
+## **[➡ New Modders Start Here! ⬅](https://github.com/WaywardGame/types/wiki)**
+
+## Documentation
+- [`+mod create` & `+mod update`](https://github.com/WaywardGame/types/wiki/mod-create-&-update) — Documentation on the commands used to generate starter files for modding, and updating script mods.
+- [`mod.json`](https://github.com/WaywardGame/types/wiki/mod.json) — Documentation on what all can be declared in the main mod metadata file.
+- [Extracting assets](https://github.com/WaywardGame/types/wiki/Extracting-Wayward-Assets) — A guide on extracting textures, sounds, and more from Wayward.
+
+## Mod Content
+- [Scripts](https://github.com/WaywardGame/types/wiki/Script-Mods) — Create mods that change the functionality of the game, or add new content
+- [Languages & Extensions](https://github.com/WaywardGame/types/wiki/Languages-&-Extensions) — Adding new languages to Wayward, or adding translatable strings to mods.
+- [Customizations](https://github.com/WaywardGame/types/wiki/Customizations) — Adding new hair styles, hair colours, and skin tones
+- [Image Overrides](https://github.com/WaywardGame/types/wiki/Image-Overrides) — Replacing default sprites & textures
+- [Stylesheets](https://github.com/WaywardGame/types/wiki/Stylesheets) — Changing the appearance of the UI
+
+# Other Useful Links
+
+## [Wayward Types Viewer](https://waywardgame.github.io/)
+A pretty, searchable list of all the type definitions in Wayward. This `types` repository is actually the same stuff you can find on this website, but it's the *raw* form of it!
+
+## [Modding Examples](https://github.com/WaywardGame)
+Every official mod created for Wayward, and some other Wayward-related projects.
+
+## [Steam Workshop](http://steamcommunity.com/app/379210/workshop/)
+Where Wayward mods are published.

package/definitions/cplusplus/index.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/IGlobal.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:
@@ -36,6 +36,7 @@ import "utilities/typesglobal/Iterables";
 import "utilities/typesglobal/Misc";
 import "utilities/typesglobal/Objects";
 import "utilities/typesglobal/Types";
+import type Version from "utilities/Version";
 declare global {
     let audio: WAudio | undefined;
     let game: Game;
@@ -50,7 +51,7 @@ declare global {
     let saveData: SaveData;
     let saveDataGlobal: SaveDataGlobal;
     let ui: Ui;
-    const gameVersion: string;
+    const gameVersion: Version.String;
     const gameVersionStage: string;
     const gameVersionMajor: number;
     const gameVersionMinor: number;

package/definitions/game/Init.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/Production.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/Uninit.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/audio/Audio.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/audio/DefaultMusicHandler.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/audio/IAudio.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/audio/IMusic.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/audio/Music.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/audio/SoundEffects.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/CommandManager.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/Commands.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/ICommand.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/ICommandManager.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Backup.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Ban.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Banned.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Commands.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Kick.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Noclip.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Pause.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Ping.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Players.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Save.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Sync.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/command/commands/Unban.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/event/EventBuses.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/event/EventEmitter.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/event/EventManager.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:
@@ -49,6 +49,7 @@ import { Uninit } from "Uninit";
 import type { IVector2 } from "utilities/math/IVector";
 import type { Random } from "utilities/random/Random";
 import type { IVersionInfo } from "utilities/Version";
+import Version from "utilities/Version";
 import { WebWorkerManager } from "webWorker/WebWorkerManager";
 export declare class Game extends EventEmitter.Host<IGameEvents> {
     get isChallenge(): boolean;
@@ -57,7 +58,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     difficulty: GameMode;
     gameplayModifierData: Record<number, any>;
     replay: ReplayManager | undefined;
-    saveVersion: string;
+    saveVersion: Version.String;
     shouldUpdateTablesAndWeight: boolean;
     tickSpeed: number;
     time: TimeManager;
@@ -68,7 +69,7 @@ export declare class Game extends EventEmitter.Host<IGameEvents> {
     /**
      * The version the save was originally created on
      */
-    version: string;
+    version: Version.String;
     readonly interval = 16.6666;
     readonly autoSave: AutoSave;
     readonly commandManager: CommandManager;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:
@@ -30,6 +30,7 @@ import type { IReplayLogEntry } from "replay/IReplayLogEntry";
 import type { IHighscoreOld, IOptions } from "save/data/ISaveDataGlobal";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
 import type { IRange } from "utilities/math/Range";
+import type Version from "utilities/Version";
 export interface IGameEvents {
     /**
      * Called when the game is starting
@@ -128,7 +129,7 @@ export type IGameOld = Partial<Game> & Partial<{
     monsters: Creature[];
     tamedCreatures: number[];
     options: IOptions;
-    lastPlayedVersion: string | undefined;
+    lastPlayedVersion: Version.String | undefined;
     highscores: IHighscoreOld[];
     playedCount: number;
     dailyChallenge: boolean;
@@ -221,17 +222,18 @@ export declare enum TileUpdateType {
     DoodadOrientation = 14,
     DoodadOverHidden = 15,
     DoodadRemove = 16,
-    Item = 17,
-    ItemDrop = 18,
-    ItemMovement = 19,
-    Mod = 20,
-    NPC = 21,
-    NPCSpawn = 22,
-    Player = 23,
-    Terrain = 24,
-    TileEvent = 25,
-    TileEventManager = 26,
-    Tilled = 27
+    DoodadAddWater = 17,
+    Item = 18,
+    ItemDrop = 19,
+    ItemMovement = 20,
+    Mod = 21,
+    NPC = 22,
+    NPCSpawn = 23,
+    Player = 24,
+    Terrain = 25,
+    TileEvent = 26,
+    TileEventManager = 27,
+    Tilled = 28
 }
 export declare enum PauseSource {
     /**

package/definitions/game/game/ILoot.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/IObject.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/ItemDoodadGroups.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/ObjectManager.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/VotingManager.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/WorldZ.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/Biomes.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/IBiome.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:
@@ -8,6 +8,8 @@
  * 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 { WorldZ } from "game/WorldZ";
+import { type FerocityLevelThresholds } from "game/deity/IDeities";
 import type { IBiomeMapGen, MapGenVersions } from "game/mapgen/IMapGen";
 import type { IBiomeTemperature } from "game/temperature/ITemperature";
 import type { TerrainType } from "game/tile/ITerrain";
@@ -21,6 +23,17 @@ export interface IBiomeDescription extends IModdable {
     temperature?: IBiomeTemperature;
     mapGen: MapGenVersions<IBiomeMapGen>;
     fog?: IFogDescription;
+    /**
+     * A record defining maximum thresholds for each ferocity level.
+     *
+     * When a layer's ferocity thresholds are not set, thresholds for `WorldZ.Overworld` are used.
+     * When no thresholds are set *at all*, {@link DEFAULT_FEROCITY_LEVEL_THRESHOLDS} is used.
+     *
+     * The current ferocity level is equivalent to the level with the threshold *closest* to the current alignment value, without exceeding it.
+     *
+     * When no thresholds are applicable, `FerocityLevel.Minimal` is used.
+     */
+    ferocity?: PartialRecord<WorldZ, FerocityLevelThresholds>;
 }
 export interface IFogDescription {
     color: IRGB;

package/definitions/game/game/biome/arid/Arid.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:
@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/biome/arid/mapGen/2.10.0.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/arid/mapGen/2.11.0.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/arid/mapGen/2.12.0.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/arid/mapGen/2.13.0.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/arid/mapGen/2.13.2.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2011-2023 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 { IBiomeMapGen } from "game/mapgen/IMapGen";
+export declare const aridMapGen2132: IBiomeMapGen;

package/definitions/game/game/biome/arid/mapGen/2.9.0.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:

package/definitions/game/game/biome/coastal/Coastal.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks:
@@ -17,6 +17,22 @@ declare const _default: {
     readonly fog: {
         color: import("utilities/Color").IRGB;
     };
+    readonly ferocity: {
+        1: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+        0: {
+            1: number;
+            2: number;
+            3: number;
+            4: number;
+            5: number;
+        };
+    };
     mapGen: BiomeMapGen;
     temperature: IBiomeTemperature;
 };

package/definitions/game/game/biome/coastal/mapGen/2.10.0.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2011-2021 Unlok
+ * Copyright 2011-2023 Unlok
  * https://www.unlok.ca
  *
  * Credits & Thanks: