@wayward/types 2.12.2-beta.dev.20221219.1 → 2.12.3-beta

package/definitions/game/game/island/Island.d.ts

@@ -1,339 +1,339 @@
-/*!
- * 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 EventEmitter from "event/EventEmitter";
-import type { BiomeTypes } from "game/biome/IBiome";
-import DoodadManager from "game/doodad/DoodadManager";
-import CorpseManager from "game/entity/creature/corpse/CorpseManager";
-import Creature from "game/entity/creature/Creature";
-import CreatureManager from "game/entity/creature/CreatureManager";
-import type { IDamageInfo, IDamageOutcome, IDamageOutcomeInput } from "game/entity/creature/ICreature";
-import FlowFieldManager from "game/entity/flowfield/FlowFieldManager";
-import Human from "game/entity/Human";
-import { SkillType } from "game/entity/IHuman";
-import NPCManager from "game/entity/npc/NPCManager";
-import type { IGameOld } from "game/IGame";
-import { FireType, TickFlag, TileUpdateType } from "game/IGame";
-import { Quality } from "game/IObject";
-import type { IIslandEvents, IIslandLoadOptions, ISeeds, IslandId, IWaterContamination, IWaterFill, IWell } from "game/island/IIsland";
-import { WaterType } from "game/island/IIsland";
-import type { ILiquidGather } from "game/item/IItem";
-import type { IRequirementInfo } from "game/item/IItemManager";
-import ItemManager from "game/item/ItemManager";
-import type DrawnMap from "game/mapping/DrawnMap";
-import type { IGameOptions } from "game/options/IGameOptions";
-import type { IslandModifiersCollection } from "game/options/modifiers/island/IslandModifiers";
-import type { IReferenceable } from "game/reference/IReferenceManager";
-import TemperatureManager from "game/temperature/TemperatureManager";
-import type { ITerrainDescription, ITile, ITileContainer, ITileData } from "game/tile/ITerrain";
-import { TerrainType } from "game/tile/ITerrain";
-import type { ITerrainLoot, ITerrainLootItem } from "game/tile/TerrainResources";
-import TileEventManager from "game/tile/TileEventManager";
-import TimeManager from "game/time/TimeManager";
-import Translation from "language/Translation";
-import World from "renderer/world/World";
-import type { IPreSerializeCallback, ISerializer } from "save/serializer/ISerializer";
-import { Direction } from "utilities/math/Direction";
-import type { IVector2, IVector3 } from "utilities/math/IVector";
-import Vector3 from "utilities/math/Vector3";
-import type { Random, SeededGenerator } from "utilities/random/Random";
-import type { IVersionInfo } from "utilities/Version";
-export interface IIslandDetails {
-    seed: number;
-    random: Random;
-    biomeType: BiomeTypes;
-    offset: IVector2;
-}
-export declare module IIslandDetails {
-    const NOOP: IIslandDetails;
-}
-/**
- * Represents the worlds island
- * Items, Creatures, Npcs, etc.. all exist on the island
- */
-export default class Island extends EventEmitter.Host<IIslandEvents> implements IReferenceable, IPreSerializeCallback {
-    static getBiomeType(x: number, y: number): BiomeTypes;
-    static getDetails(x: number, y: number): IIslandDetails;
-    static generateDetails(position: IVector2, seed?: number): IIslandDetails;
-    corpses: CorpseManager;
-    creatures: CreatureManager;
-    doodads: DoodadManager;
-    flowFieldManager: FlowFieldManager;
-    items: ItemManager;
-    npcs: NPCManager;
-    temperature: TemperatureManager;
-    tileEvents: TileEventManager;
-    time: TimeManager;
-    biomeType: BiomeTypes;
-    civilizationScore: number;
-    civilizationScoreTiles: Record<number, number>;
-    contaminatedWater: IWaterContamination[];
-    creatureSpawnTimer: number;
-    mapGenVersion: string;
-    name?: string;
-    position: IVector2;
-    referenceId?: number;
-    saveVersion: string;
-    tileContainers: ITileContainer[];
-    tileData: SaferNumberIndexedObject<SaferNumberIndexedObject<SaferNumberIndexedObject<ITileData[]>>>;
-    treasureMaps: DrawnMap[];
-    version: string;
-    wellData: SaferNumberIndexedObject<IWell>;
-    loadCount: number;
-    seeds: ISeeds;
-    readonly seededRandom: Random<SeededGenerator>;
-    /**
-     * Set of players on this island
-     */
-    readonly players: Set<Human>;
-    /**
-     * Entity move types in fov on this island
-     * `${z}-${moveType}` -> Humans
-     */
-    readonly moveTypesInFov: Map<string, Set<Human>>;
-    previousSaveVersion: IVersionInfo | undefined;
-    brokenReferencesCount: number;
-    spawnPoint: IVector3;
-    private _loadedReferences;
-    private _tiles;
-    private _world;
-    modifiersCollection?: IslandModifiersCollection;
-    details?: IIslandDetails;
-    ranUpgrades: boolean;
-    constructor(position?: IVector2, seed?: number);
-    toString(): string;
-    private registerMemoryLeakDetector;
-    preSerializeObject(serializer: ISerializer): void;
-    onUnserialized(): void;
-    get id(): `${number},${number}`;
-    get biome(): import("game/biome/IBiome").IBiomeDescription;
-    get isLoaded(): boolean;
-    get hasLoadedItemReferences(): boolean;
-    get isLocalIsland(): boolean;
-    get world(): World;
-    /**
-     * Check if this island has players on it
-     */
-    get isActive(): boolean;
-    get isDefaultIsland(): boolean;
-    getDetails(): IIslandDetails;
-    onActivated(): void;
-    onDeactivated(): void;
-    private gameOptionsCached?;
-    getGameOptions(): IGameOptions;
-    clearGameOptionsCache(): void;
-    rename(human: Human, newName: string): void;
-    private generatedName?;
-    getName(useGenerated?: boolean): string;
-    private getNameDescriptor;
-    private getNameNoun;
-    getNeighboringIslands(): Island[];
-    load(options?: Partial<IIslandLoadOptions>): Promise<void>;
-    private initializeIslandModifiers;
-    /**
-     * Unload the island from memory
-     * Removes all players and stores tiles references
-     * @param resetState True if the game state is resetting
-     */
-    unload(): void;
-    delete(): void;
-    private deleteIfDeserialized;
-    private fastForward;
-    hydrateFromOldGame(oldGame: IGameOld): void;
-    /**
-     * Gets the total distance away the current island is from 0, 0 as a positive value.
-     * @returns The distance as a positive number.
-     */
-    getIslandDistance(): number;
-    /**
-     * Gets the default terrain type that should be under a tile (in the case of melting or removing it in some way).
-     * @param tile ITile that we are getting the default terrain type for.
-     * @returns The default terrain type with a fallback to dirt (which shouldn't happen without mods or bugs).
-     */
-    getDefaultTerrainType(tile: ITile): TerrainType;
-    checkForHiddenMob(human: Human, x: number, y: number, z: number): void;
-    isMapEdge(x: number, y: number): boolean;
-    /**
-     * Ensures a point is valid and is not the edge of the map
-     */
-    ensureValidPoint<T extends IVector2>(point?: T): T | undefined;
-    getTileFromPoint(point: IVector3): ITile;
-    getTile(x: number, y: number, z: number): ITile;
-    getTileSafe(x: number, y: number, z: number): ITile | undefined;
-    setTile(x: number, y: number, z: number, tile: ITile): ITile;
-    setTiles(tiles: ITile[]): void;
-    getOrCreateTile(index: number): ITile;
-    changeTile(newTileInfo: TerrainType | ITileData, x: number, y: number, z: number, stackTiles: boolean, dropTiles?: boolean): void;
-    makeLavaPassage(human: Human): TerrainType | undefined;
-    makeCaveEntrance(human: Human, chance?: number): TerrainType | undefined;
-    getTileData(x: number, y: number, z: number): ITileData[] | undefined;
-    getOrCreateTileData(x: number, y: number, z: number): ITileData[];
-    updateFlowFieldTile(tile: ITile, x: number, y: number, z: number, tileUpdateType: TileUpdateType, updatedRenderer?: boolean): void;
-    isTilled(x: number, y: number, z: number): boolean;
-    packGround(x: number, y: number, z: number): void;
-    /**
-     * Removes the top tiledata (index 0) from the tile
-     * If there is no remaining tile data, a new tile data will be added with the newTileTypeWhenEmpty type
-     */
-    removeTopTile(x: number, y: number, z: number, newTileTypeWhenEmpty: TerrainType | ((tile: ITile) => TerrainType)): void;
-    /**
-     * Checks if island.tileData is synced with ITile.data
-     */
-    checkTileState(): void;
-    isPositionFull(x: number, y: number, z: number): boolean;
-    isTileFull(tile: ITile): boolean;
-    isOnFire(tile: ITile): FireType;
-    isTileEmpty(tile: ITile): boolean;
-    isPositionEmpty(x: number, y: number, z: number): boolean;
-    processWaterContamination(): void;
-    addPlayer(human: Human, refreshStatusEffects?: boolean): void;
-    removePlayer(human: Human, isAbsentPlayer?: boolean): void;
-    getPlayers(includeGhosts?: boolean, includeConnecting?: boolean): Human[];
-    isPlayerAtTile(tile: ITile, includeGhosts?: boolean, includeConnecting?: boolean): boolean;
-    isPlayerAtPosition(x: number, y: number, z: number, includeGhosts?: boolean, includeConnecting?: boolean): boolean;
-    getPlayersAtTile(tile: ITile, includeGhosts?: boolean, includeConnecting?: boolean): Human[];
-    getPlayersAtPosition(position: IVector3, includeGhosts?: boolean, includeConnecting?: boolean): Human[];
-    getPlayersAtPosition(x: number, y: number, z: number, includeGhosts?: boolean, includeConnecting?: boolean): Human[];
-    getPlayersThatSeePosition(x: number, y: number, z: number): Human[];
-    /**
-     * Gets the nearest player based on x/y/z coordinates.
-     * @param x The x coord to get the closest player.
-     * @param y The y coord to get the closest player.
-     * @param z The z coord to get the closest player.
-     * @param canSee If set to true, check if the player can see the x/y/z coords. Defaults to false.
-     */
-    getNearestPlayer(x: number, y: number, z?: number, canSee?: boolean, includeGhosts?: boolean, includeConnecting?: boolean): {
-        player?: Human;
-        distance?: number;
-    };
-    getReputation(): number;
-    getMalignity(): number;
-    getBenignity(): number;
-    getMaxHealth(): number;
-    getMaxWeight(): number;
-    getTactics(): number;
-    getSkillPercent(skill: SkillType): number;
-    getPlayerAverage(calc: (player: Human) => number | undefined, round?: boolean): number;
-    updateReputation(reputation: number): void;
-    /**
-     * Check the amount of water tiles there is connected to a supplied x/y area
-     */
-    checkWaterFill(x: number, y: number, z: number, needed: number, waterType: WaterType, waterFill?: IWaterFill): number;
-    getSpawnPoint(): IVector3;
-    consumeWaterTile(x: number, y: number, z: number): void;
-    calculateDamageOutcome(input: IDamageOutcomeInput): IDamageOutcome | undefined;
-    damage(target: Human | Creature, damageInfo: IDamageInfo, causesBlood?: boolean): number | undefined;
-    /**
-     * Calculates the light level of a tile.
-     * @returns 32bit number representing RED GREEN BLUE ALPHA
-     */
-    calculateTileLightLevel(tile: ITile, x: number, y: number, z: number): number;
-    getLightSourceAt(x: number, y: number, z: number): number;
-    fireBreath(x: number, y: number, z: number, facingDirection: Direction, itemName?: Translation, player?: boolean): void;
-    coolFires(requirements: IRequirementInfo, human: Human): void;
-    isFlammable(x: number, y: number, z: number): boolean;
-    /**
-     * Converts shallow single bodies of fresh/swamp water into seawater.
-     * @param point x/y/z of the tile to check against.
-     */
-    contaminateNonSeawater(point: IVector3): void;
-    /**
-     * Create puddles around a point and limit them (so they can't expand infinitely).
-     * @param point x/y/z of the splash/puddle source.
-     */
-    createPuddles(point: IVector3): void;
-    /**
-     * Cools the tile (such as lava) and reveals to any in-LOS players about it.
-     * @param point x/y/z of the lava tile.
-     * @param islandId The island ID of where we are checking so we can tell players about the cooled lava/tile.
-     */
-    coolTile(point: IVector3, islandId?: IslandId): void;
-    /**
-     * Finds either lava or water ajacent to either lava or water, and cools the lava down based its findings.
-     * @param point x/y/z of the lava or water source.
-     * @param islandId The island ID of where we are checking so we can tell players about the cooled lava.
-     */
-    coolLava(point: IVector3, islandId?: IslandId): void;
-    /**
-     * Contaminate water sources when new ones are created based on the surrounding water.
-     * @param point x/y/z of the water tile created.
-     */
-    contaminateWater(point: IVector3): void;
-    /**
-     * Resets & recalculates the civilization score
-     */
-    recalculateCivilizationScore(): void;
-    /**
-     * Refreshes the provided civ score for the given tile
-     */
-    refreshTileCivilizationScore(tile: ITile, x: number, y: number, z: number, isRecalculating?: boolean): void;
-    /**
-     * Adds civilization score
-     */
-    addCivilizationScore(score: number, source: string | undefined): void;
-    /**
-     * Gets the growing speed (or chance to grow more every tick).
-     * @param quality Quality of the item or tile to check the growing speed of.
-     */
-    getGrowingSpeed(terrainType: TerrainType, quality?: Quality, magicValue?: number): number;
-    processTickFlags(tickFlag: TickFlag, ticks: number, playingHumans: Human[]): void;
-    processTickFlagsAsync(tickFlag: TickFlag, ticks: number, playingHumans: Human[], onProgress: (progess: number) => Promise<void>): Promise<void>;
-    /**
-     * Possibly collapses or opens up a cave (on both sides) and breaks any doodads.
-     * @param point Vector3 of the location to collapse or open the caves (if it exists).
-     * @param checkType TerrainType to check if the tile point equals this before switching.
-     */
-    switchCave(point: Vector3, checkType?: TerrainType): void;
-    /**
-     * Checks to see if there is a cave and if it can be switched to collapsed from open or vice versa.
-     * @param terrainType TerrainType to get the description of.
-     * @param checkType TerrainType to check if the tile point equals this before switching.
-     * @returns TerrainType that we should switch the tile into.
-     */
-    canSwitchCave(terrainType: TerrainType, checkType?: TerrainType): TerrainType | undefined;
-    private updateEntityFov;
-    private processTimers;
-    private runRandomEvents;
-    /**
-     * Plants a random seed at the given coordinates based on what can grow on that tile naturally. This will replace any doodad that is there.
-     * @param x X coordinates.
-     * @param y Y coordinates.
-     * @param z Z coordinates.
-     * @returns True if a seed was planted.
-     */
-    plantRandomSeed(x: number, y: number, z: number): boolean;
-    /**
-     * Synchronizes player events
-     * Usually called when a new player joins
-     */
-    synchronizeStates(playerIds: number[]): void;
-    /**
-     * @returns a range value for the weapon being shot based on the weapon range and the players skill with that weapon type. This value then becomes the maximum potential range of the current shot.
-     */
-    rangeFinder(weaponRange: number, playerSkillLevel: number, get?: "random" | "min" | "max"): number;
-    getRandomQuality(bonusQuality?: number): Quality.None | Quality.Superior | Quality.Remarkable | Quality.Exceptional;
-    getQualityDurabilityBonus(quality: Quality, itemDurability: number, getMax?: boolean): number;
-    /**
-     * Only allow loading references once
-     * Even if an island is unloaded, the loaded references will remain
-     */
-    loadReferences(allowFixesInMultiplayer?: boolean): void;
-    /**
-     * Gets the items/resources from terrain based on the TerrainResources definition and checks if it is based on the current biome type.
-     * @param terrainLoot The resource to check.
-     * @returns undefined if nothing set, or an array of ITerrainLootItem.
-     */
-    getTerrainItems(terrainLoot?: ITerrainLoot): ITerrainLootItem[] | undefined;
-    calculateWell(position: IVector3, existingWell?: IWell): IWell;
-    /**
-     * Returns the type of liquid that can be gathered from the tile
-     */
-    getLiquidGatherType(terrainType: TerrainType, terrainDescription?: ITerrainDescription | undefined): keyof ILiquidGather | undefined;
-}
+/*!
+ * 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 EventEmitter from "event/EventEmitter";
+import type { BiomeTypes } from "game/biome/IBiome";
+import DoodadManager from "game/doodad/DoodadManager";
+import CorpseManager from "game/entity/creature/corpse/CorpseManager";
+import Creature from "game/entity/creature/Creature";
+import CreatureManager from "game/entity/creature/CreatureManager";
+import type { IDamageInfo, IDamageOutcome, IDamageOutcomeInput } from "game/entity/creature/ICreature";
+import FlowFieldManager from "game/entity/flowfield/FlowFieldManager";
+import Human from "game/entity/Human";
+import { SkillType } from "game/entity/IHuman";
+import NPCManager from "game/entity/npc/NPCManager";
+import type { IGameOld } from "game/IGame";
+import { FireType, TickFlag, TileUpdateType } from "game/IGame";
+import { Quality } from "game/IObject";
+import type { IIslandEvents, IIslandLoadOptions, ISeeds, IslandId, IWaterContamination, IWaterFill, IWell } from "game/island/IIsland";
+import { WaterType } from "game/island/IIsland";
+import type { ILiquidGather } from "game/item/IItem";
+import type { IRequirementInfo } from "game/item/IItemManager";
+import ItemManager from "game/item/ItemManager";
+import type DrawnMap from "game/mapping/DrawnMap";
+import type { IGameOptions } from "game/options/IGameOptions";
+import type { IslandModifiersCollection } from "game/options/modifiers/island/IslandModifiers";
+import type { IReferenceable } from "game/reference/IReferenceManager";
+import TemperatureManager from "game/temperature/TemperatureManager";
+import type { ITerrainDescription, ITile, ITileContainer, ITileData } from "game/tile/ITerrain";
+import { TerrainType } from "game/tile/ITerrain";
+import type { ITerrainLoot, ITerrainLootItem } from "game/tile/TerrainResources";
+import TileEventManager from "game/tile/TileEventManager";
+import TimeManager from "game/time/TimeManager";
+import Translation from "language/Translation";
+import World from "renderer/world/World";
+import type { IPreSerializeCallback, ISerializer } from "save/serializer/ISerializer";
+import { Direction } from "utilities/math/Direction";
+import type { IVector2, IVector3 } from "utilities/math/IVector";
+import Vector3 from "utilities/math/Vector3";
+import type { Random, SeededGenerator } from "utilities/random/Random";
+import type { IVersionInfo } from "utilities/Version";
+export interface IIslandDetails {
+    seed: number;
+    random: Random;
+    biomeType: BiomeTypes;
+    offset: IVector2;
+}
+export declare module IIslandDetails {
+    const NOOP: IIslandDetails;
+}
+/**
+ * Represents the worlds island
+ * Items, Creatures, Npcs, etc.. all exist on the island
+ */
+export default class Island extends EventEmitter.Host<IIslandEvents> implements IReferenceable, IPreSerializeCallback {
+    static getBiomeType(x: number, y: number): BiomeTypes;
+    static getDetails(x: number, y: number): IIslandDetails;
+    static generateDetails(position: IVector2, seed?: number): IIslandDetails;
+    corpses: CorpseManager;
+    creatures: CreatureManager;
+    doodads: DoodadManager;
+    flowFieldManager: FlowFieldManager;
+    items: ItemManager;
+    npcs: NPCManager;
+    temperature: TemperatureManager;
+    tileEvents: TileEventManager;
+    time: TimeManager;
+    biomeType: BiomeTypes;
+    civilizationScore: number;
+    civilizationScoreTiles: Record<number, number>;
+    contaminatedWater: IWaterContamination[];
+    creatureSpawnTimer: number;
+    mapGenVersion: string;
+    name?: string;
+    position: IVector2;
+    referenceId?: number;
+    saveVersion: string;
+    tileContainers: ITileContainer[];
+    tileData: SaferNumberIndexedObject<SaferNumberIndexedObject<SaferNumberIndexedObject<ITileData[]>>>;
+    treasureMaps: DrawnMap[];
+    version: string;
+    wellData: SaferNumberIndexedObject<IWell>;
+    loadCount: number;
+    seeds: ISeeds;
+    readonly seededRandom: Random<SeededGenerator>;
+    /**
+     * Set of players on this island
+     */
+    readonly players: Set<Human>;
+    /**
+     * Entity move types in fov on this island
+     * `${z}-${moveType}` -> Humans
+     */
+    readonly moveTypesInFov: Map<string, Set<Human>>;
+    previousSaveVersion: IVersionInfo | undefined;
+    brokenReferencesCount: number;
+    spawnPoint: IVector3;
+    private _loadedReferences;
+    private _tiles;
+    private _world;
+    modifiersCollection?: IslandModifiersCollection;
+    details?: IIslandDetails;
+    ranUpgrades: boolean;
+    constructor(position?: IVector2, seed?: number);
+    toString(): string;
+    private registerMemoryLeakDetector;
+    preSerializeObject(serializer: ISerializer): void;
+    onUnserialized(): void;
+    get id(): `${number},${number}`;
+    get biome(): import("game/biome/IBiome").IBiomeDescription;
+    get isLoaded(): boolean;
+    get hasLoadedItemReferences(): boolean;
+    get isLocalIsland(): boolean;
+    get world(): World;
+    /**
+     * Check if this island has players on it
+     */
+    get isActive(): boolean;
+    get isDefaultIsland(): boolean;
+    getDetails(): IIslandDetails;
+    onActivated(): void;
+    onDeactivated(): void;
+    private gameOptionsCached?;
+    getGameOptions(): IGameOptions;
+    clearGameOptionsCache(): void;
+    rename(human: Human, newName: string): void;
+    private generatedName?;
+    getName(useGenerated?: boolean): string;
+    private getNameDescriptor;
+    private getNameNoun;
+    getNeighboringIslands(): Island[];
+    load(options?: Partial<IIslandLoadOptions>): Promise<void>;
+    private initializeIslandModifiers;
+    /**
+     * Unload the island from memory
+     * Removes all players and stores tiles references
+     * @param resetState True if the game state is resetting
+     */
+    unload(): void;
+    delete(): void;
+    private deleteIfDeserialized;
+    private fastForward;
+    hydrateFromOldGame(oldGame: IGameOld): void;
+    /**
+     * Gets the total distance away the current island is from 0, 0 as a positive value.
+     * @returns The distance as a positive number.
+     */
+    getIslandDistance(): number;
+    /**
+     * Gets the default terrain type that should be under a tile (in the case of melting or removing it in some way).
+     * @param tile ITile that we are getting the default terrain type for.
+     * @returns The default terrain type with a fallback to dirt (which shouldn't happen without mods or bugs).
+     */
+    getDefaultTerrainType(tile: ITile): TerrainType;
+    checkForHiddenMob(human: Human, x: number, y: number, z: number): void;
+    isMapEdge(x: number, y: number): boolean;
+    /**
+     * Ensures a point is valid and is not the edge of the map
+     */
+    ensureValidPoint<T extends IVector2>(point?: T): T | undefined;
+    getTileFromPoint(point: IVector3): ITile;
+    getTile(x: number, y: number, z: number): ITile;
+    getTileSafe(x: number, y: number, z: number): ITile | undefined;
+    setTile(x: number, y: number, z: number, tile: ITile): ITile;
+    setTiles(tiles: ITile[]): void;
+    getOrCreateTile(index: number): ITile;
+    changeTile(newTileInfo: TerrainType | ITileData, x: number, y: number, z: number, stackTiles: boolean, dropTiles?: boolean): void;
+    makeLavaPassage(human: Human): TerrainType | undefined;
+    makeCaveEntrance(human: Human, chance?: number): TerrainType | undefined;
+    getTileData(x: number, y: number, z: number): ITileData[] | undefined;
+    getOrCreateTileData(x: number, y: number, z: number): ITileData[];
+    updateFlowFieldTile(tile: ITile, x: number, y: number, z: number, tileUpdateType: TileUpdateType, updatedRenderer?: boolean): void;
+    isTilled(x: number, y: number, z: number): boolean;
+    packGround(x: number, y: number, z: number): void;
+    /**
+     * Removes the top tiledata (index 0) from the tile
+     * If there is no remaining tile data, a new tile data will be added with the newTileTypeWhenEmpty type
+     */
+    removeTopTile(x: number, y: number, z: number, newTileTypeWhenEmpty: TerrainType | ((tile: ITile) => TerrainType)): void;
+    /**
+     * Checks if island.tileData is synced with ITile.data
+     */
+    checkTileState(): void;
+    isPositionFull(x: number, y: number, z: number): boolean;
+    isTileFull(tile: ITile): boolean;
+    isOnFire(tile: ITile): FireType;
+    isTileEmpty(tile: ITile): boolean;
+    isPositionEmpty(x: number, y: number, z: number): boolean;
+    processWaterContamination(): void;
+    addPlayer(human: Human, refreshStatusEffects?: boolean): void;
+    removePlayer(human: Human, isAbsentPlayer?: boolean): void;
+    getPlayers(includeGhosts?: boolean, includeConnecting?: boolean): Human[];
+    isPlayerAtTile(tile: ITile, includeGhosts?: boolean, includeConnecting?: boolean): boolean;
+    isPlayerAtPosition(x: number, y: number, z: number, includeGhosts?: boolean, includeConnecting?: boolean): boolean;
+    getPlayersAtTile(tile: ITile, includeGhosts?: boolean, includeConnecting?: boolean): Human[];
+    getPlayersAtPosition(position: IVector3, includeGhosts?: boolean, includeConnecting?: boolean): Human[];
+    getPlayersAtPosition(x: number, y: number, z: number, includeGhosts?: boolean, includeConnecting?: boolean): Human[];
+    getPlayersThatSeePosition(x: number, y: number, z: number): Human[];
+    /**
+     * Gets the nearest player based on x/y/z coordinates.
+     * @param x The x coord to get the closest player.
+     * @param y The y coord to get the closest player.
+     * @param z The z coord to get the closest player.
+     * @param canSee If set to true, check if the player can see the x/y/z coords. Defaults to false.
+     */
+    getNearestPlayer(x: number, y: number, z?: number, canSee?: boolean, includeGhosts?: boolean, includeConnecting?: boolean): {
+        player?: Human;
+        distance?: number;
+    };
+    getReputation(): number;
+    getMalignity(): number;
+    getBenignity(): number;
+    getMaxHealth(): number;
+    getMaxWeight(): number;
+    getTactics(): number;
+    getSkillPercent(skill: SkillType): number;
+    getPlayerAverage(calc: (player: Human) => number | undefined, round?: boolean): number;
+    updateReputation(reputation: number): void;
+    /**
+     * Check the amount of water tiles there is connected to a supplied x/y area
+     */
+    checkWaterFill(x: number, y: number, z: number, needed: number, waterType: WaterType, waterFill?: IWaterFill): number;
+    getSpawnPoint(): IVector3;
+    consumeWaterTile(x: number, y: number, z: number): void;
+    calculateDamageOutcome(input: IDamageOutcomeInput): IDamageOutcome | undefined;
+    damage(target: Human | Creature, damageInfo: IDamageInfo, causesBlood?: boolean): number | undefined;
+    /**
+     * Calculates the light level of a tile.
+     * @returns 32bit number representing RED GREEN BLUE ALPHA
+     */
+    calculateTileLightLevel(tile: ITile, x: number, y: number, z: number): number;
+    getLightSourceAt(x: number, y: number, z: number): number;
+    fireBreath(x: number, y: number, z: number, facingDirection: Direction, itemName?: Translation, player?: boolean): void;
+    coolFires(requirements: IRequirementInfo, human: Human): void;
+    isFlammable(x: number, y: number, z: number): boolean;
+    /**
+     * Converts shallow single bodies of fresh/swamp water into seawater.
+     * @param point x/y/z of the tile to check against.
+     */
+    contaminateNonSeawater(point: IVector3): void;
+    /**
+     * Create puddles around a point and limit them (so they can't expand infinitely).
+     * @param point x/y/z of the splash/puddle source.
+     */
+    createPuddles(point: IVector3): void;
+    /**
+     * Cools the tile (such as lava) and reveals to any in-LOS players about it.
+     * @param point x/y/z of the lava tile.
+     * @param islandId The island ID of where we are checking so we can tell players about the cooled lava/tile.
+     */
+    coolTile(point: IVector3, islandId?: IslandId): void;
+    /**
+     * Finds either lava or water ajacent to either lava or water, and cools the lava down based its findings.
+     * @param point x/y/z of the lava or water source.
+     * @param islandId The island ID of where we are checking so we can tell players about the cooled lava.
+     */
+    coolLava(point: IVector3, islandId?: IslandId): void;
+    /**
+     * Contaminate water sources when new ones are created based on the surrounding water.
+     * @param point x/y/z of the water tile created.
+     */
+    contaminateWater(point: IVector3): void;
+    /**
+     * Resets & recalculates the civilization score
+     */
+    recalculateCivilizationScore(): void;
+    /**
+     * Refreshes the provided civ score for the given tile
+     */
+    refreshTileCivilizationScore(tile: ITile, x: number, y: number, z: number, isRecalculating?: boolean): void;
+    /**
+     * Adds civilization score
+     */
+    addCivilizationScore(score: number, source: string | undefined): void;
+    /**
+     * Gets the growing speed (or chance to grow more every tick).
+     * @param quality Quality of the item or tile to check the growing speed of.
+     */
+    getGrowingSpeed(terrainType: TerrainType, quality?: Quality, magicValue?: number): number;
+    processTickFlags(tickFlag: TickFlag, ticks: number, playingHumans: Human[]): void;
+    processTickFlagsAsync(tickFlag: TickFlag, ticks: number, playingHumans: Human[], onProgress: (progess: number) => Promise<void>): Promise<void>;
+    /**
+     * Possibly collapses or opens up a cave (on both sides) and breaks any doodads.
+     * @param point Vector3 of the location to collapse or open the caves (if it exists).
+     * @param checkType TerrainType to check if the tile point equals this before switching.
+     */
+    switchCave(point: Vector3, checkType?: TerrainType): void;
+    /**
+     * Checks to see if there is a cave and if it can be switched to collapsed from open or vice versa.
+     * @param terrainType TerrainType to get the description of.
+     * @param checkType TerrainType to check if the tile point equals this before switching.
+     * @returns TerrainType that we should switch the tile into.
+     */
+    canSwitchCave(terrainType: TerrainType, checkType?: TerrainType): TerrainType | undefined;
+    private updateEntityFov;
+    private processTimers;
+    private runRandomEvents;
+    /**
+     * Plants a random seed at the given coordinates based on what can grow on that tile naturally. This will replace any doodad that is there.
+     * @param x X coordinates.
+     * @param y Y coordinates.
+     * @param z Z coordinates.
+     * @returns True if a seed was planted.
+     */
+    plantRandomSeed(x: number, y: number, z: number): boolean;
+    /**
+     * Synchronizes player events
+     * Usually called when a new player joins
+     */
+    synchronizeStates(playerIds: number[]): void;
+    /**
+     * @returns a range value for the weapon being shot based on the weapon range and the players skill with that weapon type. This value then becomes the maximum potential range of the current shot.
+     */
+    rangeFinder(weaponRange: number, playerSkillLevel: number, get?: "random" | "min" | "max"): number;
+    getRandomQuality(bonusQuality?: number): Quality.None | Quality.Superior | Quality.Remarkable | Quality.Exceptional;
+    getQualityDurabilityBonus(quality: Quality, itemDurability: number, getMax?: boolean): number;
+    /**
+     * Only allow loading references once
+     * Even if an island is unloaded, the loaded references will remain
+     */
+    loadReferences(allowFixesInMultiplayer?: boolean): void;
+    /**
+     * Gets the items/resources from terrain based on the TerrainResources definition and checks if it is based on the current biome type.
+     * @param terrainLoot The resource to check.
+     * @returns undefined if nothing set, or an array of ITerrainLootItem.
+     */
+    getTerrainItems(terrainLoot?: ITerrainLoot): ITerrainLootItem[] | undefined;
+    calculateWell(position: IVector3, existingWell?: IWell): IWell;
+    /**
+     * Returns the type of liquid that can be gathered from the tile
+     */
+    getLiquidGatherType(terrainType: TerrainType, terrainDescription?: ITerrainDescription | undefined): keyof ILiquidGather | undefined;
+}