factorio-types 1.2.53 → 1.2.55

package/README.md

@@ -23,7 +23,7 @@ This library includes [tsconfig.base.json](https://github.com/sguest/factorio-ty
 
 ## Stages
 
-Factorio mods and the api go through [three distinct stages](https://lua-api.factorio.com/latest/). Types are organized into namespaces `runtime`, `prototype`, and `settings` representing the types to be used in each stage. These types, and therefore their corresponding namespaces, are a compile-time-only feature as lua does not have types, however using a type from the wrong namespace during the wrong stage is likely to result in a runtime error as you will be attempting to access something Factorio does not let you access at that time.
+Factorio mods and the api go through [three distinct stages](https://lua-api.factorio.com/latest/). Types are organized into namespaces `runtime`, `prototype`, and `settings` representing the types to be used in each stage. These types, and therefore their corresponding namespaces, are a compile-time-only feature as lua does not have types, so accessing a _type_ during the wrong phase is safe. Sometimes this is OK, such as when referencing utility functions that operate on values without interacting with game API like math functions. However, many game APIs will only work with types from the correct phase, so using an API that takes types from the wrong phase should be a red flag that you might encounter a runtime error.
 
 Note there is some overlap between the types for the Settings and Prototype phases since both regularly provide prototype data to `data.extend()`, and in fact the settings-phase prototypes extend `prototype.PrototypeBase`. However, you should only be providing types from the `settings` namespace during the settings phase, and from the `prototype` namespace during the prototype phase.
 
@@ -70,6 +70,20 @@ end
 
 Factorio makes various lua functions available to mods via [LuaLib](https://github.com/wube/factorio-data/tree/master/core/lualib)
 
-Unlike the main parts of the factorio API, these do not exist as ambient globals but instead must be imported
+Unlike the main parts of the factorio API, these do not exist as ambient globals but instead must be imported. If you inherit the recommended [tsconfig.base.json](https://github.com/sguest/factorio-types/blob/master/tsconfig.base.json), these import paths will all be set to `noResolvePaths`, meaning TSTL will not attempt to resolve them and will simply emit `require` statements that will allow Factorio to load the lualib files at runtime.
 
-The `noise` lualib definitions were previous present in this library. However, as of version 2.0.7, `noise.lua` was [removed from lualib in the factorio-data repo](https://github.com/wube/factorio-data/commit/7522d3763e76e09ce1a46cba676dfc2b6d12b127). This was accompanied by many of the required supporting types being removed from the prototype definitions, and therefore the noise definitions have been removed from this library, at least temporarily.
+```typescript
+import { split } from 'util';
+
+let splitStr = split('a|b', '|');
+```
+
+```typescript
+import * as util from 'util';
+
+let result = util.split_whitespace('a b');
+```
+
+The LuaLib definitions are not part of the machine-readable API spec that feeds the generation of the rest of the types in this repo. The devs [have said](https://forums.factorio.com/viewtopic.php?p=599930#p599930) better docs for lualib are in their longterm plans, but for now the only documentation is the files themselves in the `factorio-data` repo and any associated comments. Therefore, the lualib docs are hand-written by reading through the files and are more likely to contain errors. If you encounter any errors, please raise an issue and/or pull request.
+
+The `noise` lualib definitions were previously present in this library. However, as of version 2.0.7, `noise.lua` was [removed from lualib in the factorio-data repo](https://github.com/wube/factorio-data/commit/7522d3763e76e09ce1a46cba676dfc2b6d12b127). This was accompanied by many of the required supporting types being removed from the prototype definitions, and therefore the noise definitions have been removed from this library, at least temporarily.

package/dist/classes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace runtime {
@@ -5120,7 +5120,7 @@ interface LuaControl {
      */
     can_reach_entity(this: void, entity: LuaEntity): boolean;
     /**
-     * Cancels crafting the given count of the given crafting queue index.
+     * Cancels the given amount of crafts at the given crafting queue position. If this causes any later crafts that depend on the cancelled one to have insufficient ingredients, those crafts will also be cancelled.
      * @param table.index The crafting queue index.
      * @param table.count The count to cancel crafting.
      */
@@ -6327,7 +6327,7 @@ interface LuaEntity extends LuaControl {
      * @param index Index of the transport line. Transport lines are 1-indexed.
      * @param position Linear position along the transport line. Clamped to the transport line range.
      */
-    get_line_item_position(this: void, index: uint32, position: float): MapPosition;
+    get_line_item_position(this: void, index: defines.transport_line, position: float): MapPosition;
     /**
      * Gets all the `LuaLogisticPoint`s that this entity owns. Optionally returns only the point specified by the index parameter.
      * @param index If provided, this method only returns the `LuaLogisticPoint` specified by this index, or `nil` if it doesn't exist.
@@ -6344,7 +6344,7 @@ interface LuaEntity extends LuaControl {
     /**
      * Get the maximum transport line index of a belt or belt connectable entity.
      */
-    get_max_transport_line_index(this: void): uint32;
+    get_max_transport_line_index(this: void): defines.transport_line;
     /**
      * Inventory for storing modules of this entity; `nil` if this entity has no module inventory.
      */
@@ -6481,7 +6481,7 @@ interface LuaEntity extends LuaControl {
      * Get a transport line of a belt or belt connectable entity.
      * @param index Index of the requested transport line. Transport lines are 1-indexed.
      */
-    get_transport_line(this: void, index: uint32): LuaTransportLine;
+    get_transport_line(this: void, index: defines.transport_line): LuaTransportLine;
     /**
      * Returns the new entity prototype and its quality.
      * @returns [0] - `nil` if this entity is not marked for upgrade.
@@ -6492,11 +6492,11 @@ interface LuaEntity extends LuaControl {
         LuaQualityPrototype | null
     ]>;
     /**
-     * Gets a single wire connector of this entity
+     * Gets a single wire connector of this entity, if any.
      * @param wire_connector_id Identifier of a specific connector to get
      * @param or_create If true and connector does not exist, it will be allocated if possible
      */
-    get_wire_connector(this: void, wire_connector_id: defines.wire_connector_id, or_create: boolean): LuaWireConnector;
+    get_wire_connector(this: void, wire_connector_id: defines.wire_connector_id, or_create: boolean): LuaWireConnector | null;
     /**
      * Gets all wire connectors of this entity
      * @param or_create If true, it will try to create all connectors possible
@@ -7486,10 +7486,10 @@ interface LuaEntity extends LuaControl {
      *
      * - When called on a pipe-connectable entity, this is an array of entity arrays of all entities a given fluidbox is connected to.
      * - When called on an underground transport belt, this is the other end of the underground belt connection, or `nil` if none.
-     * - When called on a wall-connectable entity or reactor, this is a dictionary of all connections indexed by the connection direction "north", "south", "east", and "west".
+     * - When called on a wall-connectable entity, reactor or heat pipe, this is a dictionary of all connections indexed by the connection direction "north", "south", "east", and "west".
      * - When called on a cliff entity, this is a dictionary of all connections indexed by the connection direction "north", "south", "east", and "west".
      */
-    readonly neighbours?: Record<string, LuaEntity[]> | LuaEntity[][] | LuaEntity;
+    readonly neighbours?: Record<string, LuaEntity> | LuaEntity[][] | LuaEntity;
     /**
      * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
      */
@@ -7672,7 +7672,7 @@ interface LuaEntity extends LuaControl {
      */
     readonly rocket?: LuaEntity;
     /**
-     * Number of rocket parts in the silo.
+     * Number of rocket parts in this rocket silo.
      */
     rocket_parts: uint32;
     /**
@@ -7705,6 +7705,10 @@ interface LuaEntity extends LuaControl {
      * {@link LuaEntityPrototype::selection_box | runtime:LuaEntityPrototype::selection_box} around entity's given position and respecting the current entity orientation.
      */
     readonly selection_box: BoundingBox;
+    /**
+     * Whether this rocket silo is set to send items to orbit automatically. Only relevant if there is an item prototype with {@link launch products | runtime:LuaItemPrototype::rocket_launch_products} with automated {@link send_to_orbit_mode | runtime:LuaItemPrototype::send_to_orbit_mode}, such as the satellite in vanilla (without Space Age mod).
+     */
+    send_to_orbit_automatically: boolean;
     /**
      * The shooting target for this turret, if any. Can't be set to `nil` via script.
      */
@@ -9009,9 +9013,6 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
     readonly ticks_to_keep_aiming_direction?: uint32;
     readonly ticks_to_keep_gun?: uint32;
     readonly ticks_to_stay_in_combat?: uint32;
-    /**
-     * The tile buildability rules of this entity prototype.
-     */
     readonly tile_buildability_rules?: TileBuildabilityRule[];
     /**
      * Specifies the tiling size of the entity, is used to decide, if the center should be in the center of the tile (odd tile size dimension) or on the tile border (even tile size dimension)
@@ -13955,7 +13956,7 @@ interface LuaLogisticPoint {
     /**
      * The Logistic member index of this logistic point.
      */
-    readonly logistic_member_index: uint32;
+    readonly logistic_member_index: defines.logistic_member_index;
     readonly logistic_network: LuaLogisticNetwork;
     /**
      * The logistic mode.
@@ -19281,6 +19282,10 @@ interface BaseLuaSurfaceCreateEntityParams {
      * If provided, the entity will attempt to pull stored values from this item (for example; creating a spidertron from a previously named and mined spidertron)
      */
     'item'?: LuaItemStack;
+    /**
+     * Whether this entity is mirrored. Defaults to `false`.
+     */
+    'mirror'?: boolean;
     /**
      * If true, any characters that are in the way of the entity are teleported out of the way.
      */

package/dist/concepts.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace runtime {

package/dist/datacollection.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace prototype {

package/dist/defines.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace defines {
@@ -1365,6 +1365,9 @@ enum logistic_group_type {
 enum logistic_member_index {
     car_provider = 10,
     car_requester = 9,
+    cargo_landing_pad_provider = 19,
+    cargo_landing_pad_requester = 18,
+    cargo_landing_pad_trash_provider = 20,
     character_provider = 5,
     character_requester = 3,
     character_storage = 4,

package/dist/events.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace runtime {

package/dist/global.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 /**

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+// Type definitions for Factorio modding API
+// Factorio API reference https://lua-api.factorio.com/latest/index.html
+// Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json and https://lua-api.factorio.com/latest/prototype-api.json
+// Definition source https://github.com/sguest/factorio-types
+
+/// <reference path="./global.d.ts" />
+/// <reference path="./classes.d.ts" />
+/// <reference path="./concepts.d.ts" />
+/// <reference path="./defines.d.ts" />
+/// <reference path="./events.d.ts" />
+/// <reference path="./prototypes.d.ts" />
+/// <reference path="./types.d.ts" />
+/// <reference path="./datacollection.d.ts" />

package/dist/prototypes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace prototype {
@@ -3216,6 +3216,8 @@ interface EntityPrototype extends Prototype {
      * This allows you to replace an entity that's already placed, with a different one in your inventory. For example, replacing a burner inserter with a fast inserter. The replacement entity can be a different rotation to the replaced entity and you can replace an entity with the same type.
      *
      * This is simply a string, so any string can be used here. The entity that should be replaced simply has to use the same string here.
+     *
+     * Entities with the same fast replaceable group can be configured as upgrades for each other in the upgrade planner. Refer to the {@link upgrade planner prototype's page | prototype:UpgradeItemPrototype} the full requirements for entities to be shown in the upgrade planner.
      */
     fast_replaceable_group?: string;
     flags?: EntityPrototypeFlags;
@@ -3287,7 +3289,7 @@ interface EntityPrototype extends Prototype {
     mined_sound?: Sound;
     mining_sound?: Sound;
     /**
-     * Name of the entity that will be automatically selected as the upgrade of this entity when using the {@link upgrade planner | https://wiki.factorio.com/Upgrade_planner} without configuration.
+     * Name of the entity that will be automatically selected as the upgrade of this entity when using the {@link upgrade planner | prototype:UpgradeItemPrototype} without configuration.
      *
      * This entity may not have "not-upgradable" flag set and must be minable. This entity mining result must not contain item product with {@link hidden | prototype:ItemPrototype::hidden} set to `true`. Mining results with no item products are allowed. This entity may not be a {@link RollingStockPrototype | prototype:RollingStockPrototype}.
      *
@@ -6517,7 +6519,7 @@ interface QualityPrototype extends Prototype {
      */
     beacon_power_usage_multiplier?: float;
     /**
-     * Only affects beacons with {@link BeaconPrototype::quality_affects_supply_area | prototype:BeaconPrototype::quality_affects_supply_area} set.
+     * Only affects beacons with {@link BeaconPrototype::quality_affects_supply_area_distance | prototype:BeaconPrototype::quality_affects_supply_area_distance} set.
      *
      * Must be >= 0 and <= 64.
      */
@@ -6608,6 +6610,11 @@ interface QualityPrototype extends Prototype {
      * Must be >= 0.01.
      */
     logistic_cell_charging_energy_multiplier?: double;
+    /**
+     * Only affects roboports with {@link RoboportPrototype::charging_station_count_affected_by_quality | prototype:RoboportPrototype::charging_station_count_affected_by_quality} set.
+     *
+     * Only affects roboport equipment with {@link RoboportEquipmentPrototype::charging_station_count_affected_by_quality | prototype:RoboportEquipmentPrototype::charging_station_count_affected_by_quality} set.
+     */
     logistic_cell_charging_station_count_bonus?: uint32;
     /**
      * Only affects mining drills with {@link MiningDrillPrototype::quality_affects_mining_radius | prototype:MiningDrillPrototype::quality_affects_mining_radius} set.
@@ -10071,6 +10078,14 @@ interface UnitPrototype extends EntityWithOwnerPrototype {
 }
 /**
  * An {@link upgrade planner | https://wiki.factorio.com/Upgrade_planner}.
+ *
+ * For an entity to be allowed as an upgrade source, it must be minable, may not have "not-upgradable" flag set and may not be {@link hidden | prototype:PrototypeBase::hidden}. Additionally, the source entity's mining result must not be an item product that is {@link hidden | prototype:ItemPrototype::hidden}. Mining results with no item products are allowed.
+ *
+ * For an entity to be allowed as an upgrade target, it must have least 1 item that builds it that isn't hidden.
+ *
+ * For two entities to be upgrades of each other, the two entities must have the same {@link fast replaceable group | prototype:EntityPrototype::fast_replaceable_group}, the same {@link collision box | prototype:EntityPrototype::collision_box} and the same {@link collision mask | prototype:EntityPrototype::collision_mask}. Additionally, {@link underground belts | prototype:UndergroundBeltPrototype} cannot be upgraded to {@link transport belts | prototype:TransportBeltPrototype} and vice versa.
+ *
+ * For an entity to be automatically upgraded to another entity without configuring the upgrade planner, the {@link next upgrade | prototype:EntityPrototype::next_upgrade} of the upgrade source entity must be set.
  */
 interface UpgradeItemPrototype extends SelectionToolPrototype {
     /**

package/dist/types.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.72
+// Factorio version 2.0.73
 // API version 6
 
 declare namespace prototype {
@@ -3736,58 +3736,6 @@ interface DirectTriggerItem extends TriggerItem {
     filter_enabled?: boolean;
     type: 'direct';
 }
-/**
- * Usually specified by using {@link defines.direction | runtime:defines.direction}.
- */
-type Direction = /**
- * North
- */
-0 | /**
- * NorthNorthEast
- */
-1 | /**
- * NorthEast
- */
-2 | /**
- * EastNorthEast
- */
-3 | /**
- * East
- */
-4 | /**
- * EastSouthEast
- */
-5 | /**
- * SouthEast
- */
-6 | /**
- * SouthSouthEast
- */
-7 | /**
- * South
- */
-8 | /**
- * SouthSouthWest
- */
-9 | /**
- * SouthWest
- */
-10 | /**
- * WestSouthWest
- */
-11 | /**
- * West
- */
-12 | /**
- * WestNorthWest
- */
-13 | /**
- * NorthWest
- */
-14 | /**
- * NorthNorthWest
- */
-15;
 interface DirectionShift {
     east?: Vector;
     north?: Vector;
@@ -5157,6 +5105,9 @@ interface GigaCargoHatchDefinition {
  * Note that when any technology prototype changes (regardless of which mod it belongs to), the game re-applies all researched technology effects, including `"give-item"` modifiers. This means that players will receive the item again, even if they already received it previously. This can be undesirable.
  */
 interface GiveItemModifier extends BaseModifier {
+    /**
+     * Must be >= `1`.
+     */
     count?: ItemCountType;
     item: ItemID;
     quality?: QualityID;
@@ -5269,7 +5220,7 @@ interface HeatConnection {
     /**
      * The "outward" direction of this heat connection. For a connection to succeed, the other heat connection must face the opposite direction (a south-facing connection needs a north-facing connection to succeed). A connection rotates with the entity.
      */
-    direction: Direction;
+    direction: defines.direction;
     /**
      * The location of the heat pipe connection, relative to the center of the entity in the north-facing direction.
      */
@@ -6374,7 +6325,7 @@ interface MapLocation {
     /**
      * Direction this connection point will be facing to.
      */
-    direction: Direction;
+    direction: defines.direction;
     /**
      * Position relative to entity's position where the connection point will be located at.
      */
@@ -7220,7 +7171,7 @@ interface PipeConnectionDefinition {
      *
      * Only loaded, and mandatory if `connection_type` is `"normal"` or `"underground"`.
      */
-    direction?: Direction;
+    direction?: defines.direction;
     /**
      * Array of the {@link WorkingVisualisation::name | prototype:WorkingVisualisation::name} of working visualisations to enable when this pipe connection is present.
      *
@@ -8503,7 +8454,7 @@ interface RotatedAnimation extends AnimationParameters {
      *
      * The sequential animation instance is loaded equal to the entities direction within the `direction_count` setting.
      *
-     * Direction count to {@link Direction | prototype:Direction} (animation sequence number):
+     * Direction count to {@link defines.direction | runtime:defines.direction} (animation sequence number):
      *
      * - `1`: North (1)
      *
@@ -10758,6 +10709,11 @@ interface TileBuildSound {
     medium?: Sound;
     small?: Sound;
 }
+/**
+ * Defines restrictions on what tiles an entity can or must be built on.
+ *
+ * Note that once the entity has been placed, placing new tiles is not always restricted by these rules for performance reasons. In particular, for most entities these rules are only checked when placing tiles within the collision box of the entity. The exception to this are thrusters and asteroid collectors, for which the rules are always checked.
+ */
 interface TileBuildabilityRule {
     area: SimpleBoundingBox;
     colliding_tiles?: CollisionMaskConnector;

package/index.d.ts

@@ -3,15 +3,6 @@
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json and https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
 
-/// <reference path="./src/core.d.ts" />
-/// <reference path="./src/settings.d.ts" />
-/// <reference path="./src/serpent.d.ts" />
-/// <reference path="./dist/global.d.ts" />
-/// <reference path="./dist/classes.d.ts" />
-/// <reference path="./dist/concepts.d.ts" />
-/// <reference path="./dist/defines.d.ts" />
-/// <reference path="./dist/events.d.ts" />
-/// <reference path="./dist/prototypes.d.ts" />
-/// <reference path="./dist/types.d.ts" />
-/// <reference path="./dist/datacollection.d.ts" />
+/// <reference path="./src/index.d.ts" />
+/// <reference path="./dist/index.d.ts" />
 /// <reference types="lua-types/jit" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.53",
+  "version": "1.2.55",
   "description": "Typescript declarations for the Factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,11 +23,11 @@
     "src/**/*.d.ts",
     "dist/**/*.d.ts"
   ],
-  "factorioVersion": "2.0.72",
+  "factorioVersion": "2.0.73",
   "dependencies": {
     "lua-types": "^2.13.1"
   },
   "peerDependencies": {
     "typescript-to-lua": "^1.26.0"
   }
-}
+}

package/src/core.d.ts

@@ -8,17 +8,22 @@ declare namespace table {
     function compare(this: void, table1: object | [], table2: object | []): boolean;
 }
 
-declare const data: {
-    raw: prototype.dataCollection,
+interface DataType {
+    raw: prototype.dataCollection;
     extend(values: prototype.dataExtendType[]): void,
-};
+}
+
+declare const data: DataType;
 
 /**
  * Mapping of currently loaded mods to their version. Only exists at the data stage.
  */
 declare const mods: { [key: string] : string}
 
-declare const global: { [key: string]: any };
+/**
+ * Mod-specific storage lookup that is persisted to save files https://lua-api.factorio.com/latest/auxiliary/storage.html
+ */
+declare const storage: { [key: string]: any };
 
 declare function log(str: runtime.LocalisedString): void;
 

package/src/index.d.ts

@@ -0,0 +1,9 @@
+// Type definitions for Factorio modding API
+// Factorio API reference https://lua-api.factorio.com/latest/index.html
+// src mappings manually written to cover aspects not in the machine-readable API spec
+// Definition source https://github.com/sguest/factorio-types
+
+/// <reference path="./core.d.ts" />
+/// <reference path="./settings.d.ts" />
+/// <reference path="./serpent.d.ts" />
+/// <reference path="./lualib/index.d.ts" />

package/src/lualib/autoplace_utils.d.ts

@@ -0,0 +1,32 @@
+// https://github.com/wube/factorio-data/blob/master/core/lualib/autoplace_utils.lua
+declare module "autoplace_utils" {
+    export interface AutoplacePeakValue {
+        influence: number;
+        richness_influence: number;
+        min_influence: number;
+        temperature_optimal: number;
+        temperature_range: number;
+        temperature_max_range: number;
+        water_optimal: number;
+        water_range: number;
+        water_max_range: number;
+    }
+
+    export type RectangleSpecification = [[number, number], [number, number], number?];
+
+    /**
+     * Add a list of autoplace peaks based on rectangles to the table ret.
+     * Rectangles is a table of rectangle specifications:
+     *  {{max_temp, max_water}, {min_temp, min_water}, influence}
+     * temperatures range from 35 to -25 (°C), water from 0 to 1.
+     * the peak resulting from each rectangle has a preset influence
+     * within the rectangle and goes to zero after 5°C or 0.1 water level outside
+     * of the rectangle.
+     * Influence is optional and has default value of default_influence or 1.
+     */
+    export function peaks(
+        this: void,
+        rectangles: RectangleSpecification[],
+        ret: AutoplacePeakValue[],
+        default_influence?: number): AutoplacePeakValue[];
+}