factorio-types 0.0.33 → 0.0.35

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 1.1.77
+// Factorio version 1.1.80
 // API version 3
 
 /**
@@ -35,7 +35,7 @@ interface LuaAISettings {
     readonly object_name: string
 
     /**
-     * The pathing resolution modifier, must be between -8 and 8.
+     * Defines how coarse the pathfinder's grid is, where smaller values mean a coarser grid. Defaults to `0`, which equals a resolution of `1x1` tiles, centered on tile centers. Values range from `-8` to `8` inclusive, where each integer increment doubles/halves the resolution. So, a resolution of `-8` equals a grid of `256x256` tiles, and a resolution of `8` equals `1/256` of a tile.
      */
     path_resolution_modifier: number
 
@@ -310,9 +310,11 @@ interface LuaBootstrap {
         handler: (this: void) => any | null): void
 
     /**
-     * Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript | LuaGameScript} is not available. The {@link global | global} table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
+     * Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session.
      * 
-     * The only legitimate uses of this event are the following:
+     * It gives the mod the opportunity to rectify potential differences in local state introduced by the save/load cycle. Doing anything other than the following three will lead to desyncs, breaking multiplayer and replay functionality. Access to {@link LuaGameScript | LuaGameScript} is not available. The {@link global | global} table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
+     * 
+     * The only legitimate uses of this event are these:
      * - Re-setup {@link metatables | https://www.lua.org/pil/13.html} as they are not persisted through the save/load cycle.
      * - Re-setup conditional event handlers, meaning subscribing to an event only when some condition is met to save processing time.
      * - Create local references to data stored in the {@link global | global} table.
@@ -364,6 +366,7 @@ interface LuaBootstrap {
      * - {@link script_raised_built | script_raised_built}
      * - {@link script_raised_destroy | script_raised_destroy}
      * - {@link script_raised_revive | script_raised_revive}
+     * - {@link script_raised_teleported | script_raised_teleported}
      * - {@link script_raised_set_tiles | script_raised_set_tiles}
      * @param data - Table with extra data that will be passed to the event handler. Any invalid LuaObjects will silently stop the event from being raised.
      * @param event - ID of the event to raise.
@@ -474,6 +477,22 @@ interface LuaBootstrap {
      *
      * @param metatable - The metatable to register.
      * @param name - The name of this metatable. Names must be unique per mod.
+     * @example
+     * The metatable first needs to be defined in the mod's root scope, then registered using this method. From then on, it will be properly restored for tables in [global](global). 
+     * ```
+     * local metatable = {
+     *    __index = function(key)
+     *       return "no value for key " .. key
+     *    end
+     * }
+     * script.register_metatable("my_metatable", metatable)
+     * ```
+     *  This previously defined `metatable` can then be set on any table as usual: 
+     * ```
+     * local table = {key="value"}
+     * setmetatable(table, metatable)
+     * ```
+     *
      */
     register_metatable(this: void,
         name: string,
@@ -587,7 +606,7 @@ interface LuaBurner {
     readonly burnt_result_inventory: LuaInventory
 
     /**
-     * The currently burning item.
+     * The currently burning item. Writing `nil` will void the currently burning item without producing a {@link LuaBurner::burnt_result | LuaBurner::burnt_result}.
      * @remarks
      * Writing to this automatically handles correcting {@link LuaBurner::remaining_burning_fuel | LuaBurner::remaining_burning_fuel}.
      *
@@ -882,11 +901,12 @@ interface LuaConstantCombinatorControlBehavior extends LuaControlBehavior {
     help(this: void): void
 
     /**
-     * Sets the signal at the given index
+     * Sets the signal at the given index.
+     * @param signal - Passing `nil` clears the signal.
      */
     set_signal(this: void,
         index: number,
-        signal: Signal): void
+        signal?: Signal): void
 
     /**
      * Turns this constant combinator on and off.
@@ -906,7 +926,7 @@ interface LuaConstantCombinatorControlBehavior extends LuaControlBehavior {
     parameters?: ConstantCombinatorParameters[]
 
     /**
-     * The number of signals this constant combinator supports
+     * The number of signals this constant combinator supports.
      */
     readonly signals_count: number
 
@@ -1370,7 +1390,7 @@ interface LuaControl {
     force: ForceIdentification
 
     /**
-     * Unique ID associated with the force of this entity.
+     * Unique {@link index | LuaForce::index} (ID) associated with the force of this entity.
      */
     readonly force_index: number
 
@@ -1392,18 +1412,18 @@ interface LuaControl {
     /**
      * Current mining state.
      * @remarks
-     * When the player isn't mining tiles the player will mine what ever entity is currently selected. See {@link LuaControl::selected | LuaControl::selected} and {@link LuaControl::update_selected_entity | LuaControl::update_selected_entity}.
+     * When the player isn't mining tiles, the player will mine what ever entity is currently selected. See {@link LuaControl::selected | LuaControl::selected} and {@link LuaControl::update_selected_entity | LuaControl::update_selected_entity}.
      *
      */
     mining_state: {
         
         /**
-         * Whether the player is mining at all
+         * Whether the player is mining at all.
          */
         mining: boolean,
         
         /**
-         * What tiles the player is mining; only used when the player is mining tiles (holding a tile in the cursor).
+         * What location the player is mining. Only relevant if `mining` is `true`.
          */
         position?: MapPosition
     }
@@ -1488,7 +1508,7 @@ interface LuaControl {
     readonly surface: LuaSurface
 
     /**
-     * Unique ID associated with the surface this entity is currently on.
+     * Unique {@link index | LuaSurface::index} (ID) associated with the surface this entity is currently on.
      */
     readonly surface_index: number
 
@@ -2151,6 +2171,19 @@ interface LuaEntity extends LuaControl {
     disconnect_rolling_stock(this: void,
         direction: defines.rail_direction): void
 
+    /**
+     * Returns a table with all entities affected by this beacon
+     * @remarks
+     * Applies to subclasses: Beacon
+     *
+     */
+    get_beacon_effect_receivers(this: void): void
+
+    /**
+     * Returns a table with all beacons affecting this effect receiver. Can only be used when the entity has an effect receiver (AssemblingMachine, Furnace, Lab, MiningDrills)
+     */
+    get_beacons(this: void): void
+
     /**
      * Get the source of this beam.
      * @remarks
@@ -2443,7 +2476,7 @@ interface LuaEntity extends LuaControl {
         direction: defines.rail_direction): void
 
     /**
-     * Current recipe being assembled by this machine or `nil` if no recipe is set.
+     * Current recipe being assembled by this machine, if any.
      * @remarks
      * Applies to subclasses: CraftingMachine
      *
@@ -2807,13 +2840,13 @@ interface LuaEntity extends LuaControl {
     /**
      * Sets the driver of this vehicle.
      * @remarks
-     * This differs over {@link LuaEntity::set_passenger | LuaEntity::set_passenger} in that the passenger can't drive the vehicle.
+     * This differs from {@link LuaEntity::set_passenger | LuaEntity::set_passenger} in that the passenger can't drive the vehicle.
      * Applies to subclasses: Vehicle
      *
-     * @param driver - The new driver or `nil` to eject the current driver if any.
+     * @param driver - The new driver. Writing `nil` ejects the current driver, if any.
      */
     set_driver(this: void,
-        driver: LuaEntity | PlayerIdentification): void
+        driver?: LuaEntity | PlayerIdentification): void
 
     /**
      * Set the filter for a slot in an inserter, loader, or logistic storage container.
@@ -2862,22 +2895,23 @@ interface LuaEntity extends LuaControl {
     /**
      * Sets the passenger of this car or spidertron.
      * @remarks
-     * This differs over {@link LuaEntity::get_driver | LuaEntity::get_driver} in that the passenger can't drive the car.
+     * This differs from {@link LuaEntity::get_driver | LuaEntity::get_driver} in that the passenger can't drive the car.
      * Applies to subclasses: Car,SpiderVehicle
      *
+     * @param passenger - The new passenger. Writing `nil` ejects the current passenger, if any.
      */
     set_passenger(this: void,
-        passenger: LuaEntity | PlayerIdentification): void
+        passenger?: LuaEntity | PlayerIdentification): void
 
     /**
-     * Sets the current recipe in this assembly machine.
+     * Sets the given recipe in this assembly machine.
      * @remarks
      * Applies to subclasses: AssemblingMachine
      *
-     * @param recipe - The new recipe or `nil` to clear the recipe.
+     * @param recipe - The new recipe. Writing `nil` clears the recipe, if any.
      */
     set_recipe(this: void,
-        recipe: string | LuaRecipe): void
+        recipe?: string | LuaRecipe): void
 
     /**
      * Set a logistic requester slot.
@@ -3019,7 +3053,7 @@ interface LuaEntity extends LuaControl {
     auto_launch: boolean
 
     /**
-     * Destination of this spidertron's autopilot, if any.
+     * Destination of this spidertron's autopilot, if any. Writing `nil` clears all destinations.
      * @remarks
      * Applies to subclasses: SpiderVehicle
      *
@@ -3042,6 +3076,11 @@ interface LuaEntity extends LuaControl {
      */
     backer_name?: string
 
+    /**
+     * Number of beacons affecting this effect receiver. Can only be used when the entity has an effect receiver (AssemblingMachine, Furnace, Lab, MiningDrills)
+     */
+    readonly beacons_count?: number
+
     /**
      * The belt connectable neighbours of this belt connectable entity. Only entities that input to or are outputs of this entity. Does not contain the other end of an underground belt, see {@link LuaEntity::neighbours | LuaEntity::neighbours} for that. This is a dictionary with `"inputs"`, `"outputs"` entries that are arrays of transport belt connectable entities, or empty tables if no entities.
      * @remarks
@@ -3362,7 +3401,7 @@ interface LuaEntity extends LuaControl {
     readonly energy_generated_last_tick: number
 
     /**
-     * The label on this entity, if any. `nil` if this is not a spider-vehicule.
+     * The label on this spider-vehicle entity, if any. `nil` if this is not a spider-vehicle.
      */
     entity_label?: string
 
@@ -4166,7 +4205,9 @@ interface LuaEntity extends LuaControl {
     readonly unit_group?: LuaUnitGroup
 
     /**
-     * A universally unique number identifying this entity for the lifetime of the save. Only entities inheriting from {@link EntityWithOwner | https://wiki.factorio.com/Prototype/EntityWithOwner}, as well as {@link ItemRequestProxy | https://wiki.factorio.com/Prototype/ItemRequestProxy} and {@link EntityGhost | https://wiki.factorio.com/Prototype/EntityGhost} are assigned a unit number. `nil` if this entity doesn't have a unit number.
+     * A unique number identifying this entity for the lifetime of the save. These are allocated sequentially, and not re-used (until overflow).
+     * 
+     * Only entities inheriting from {@link EntityWithOwner | https://wiki.factorio.com/Prototype/EntityWithOwner}, as well as {@link ItemRequestProxy | https://wiki.factorio.com/Prototype/ItemRequestProxy} and {@link EntityGhost | https://wiki.factorio.com/Prototype/EntityGhost} are assigned a unit number. Returns `nil` otherwise.
      */
     readonly unit_number?: number
 
@@ -4962,7 +5003,7 @@ interface LuaEntityPrototype {
     readonly idle_energy_usage?: number
 
     /**
-     * A vector of the gun prototypes of this car, spider vehicule, or artillery wagon or turret.
+     * A vector of the gun prototypes of this car, spider vehicle, artillery wagon, or turret.
      * @remarks
      * Applies to subclasses: Car,SpiderVehicle,ArtilleryTurret,ArtilleryWagon
      *
@@ -5126,9 +5167,9 @@ interface LuaEntityPrototype {
     readonly item_slot_count?: number
 
     /**
-     * Items that when placed will produce this entity, if any. Construction bots will always choose the first item in this list to build this entity.
+     * Items that when placed will produce this entity, if any. Construction bots will choose the first item in the list to build this entity.
      */
-    readonly items_to_place_this?: SimpleItemStack[]
+    readonly items_to_place_this?: ItemStackDefinition[]
 
     /**
      * The item prototype names that are the inputs of this lab prototype.
@@ -5326,7 +5367,7 @@ interface LuaEntityPrototype {
     /**
      * The default maximum power output of this generator prototype.
      * @remarks
-     * Applies to subclasses: Generator
+     * Applies to subclasses: BurnerGenerator,Generator
      *
      */
     readonly max_power_output?: number
@@ -6208,7 +6249,7 @@ interface LuaEquipmentGrid {
     readonly height: number
 
     /**
-     * True if this movement bonus equipment is turned off, otherwise false.
+     * Whether this grid's equipment movement bonus is active.
      */
     inhibit_movement_bonus: boolean
 
@@ -7406,7 +7447,7 @@ interface LuaForce {
     ghost_time_to_live: number
 
     /**
-     * Unique ID associated with this force.
+     * This force's index in {@link LuaGameScript::forces | LuaGameScript::forces} (unique ID). It is assigned when a force is created, and remains so until it is {@link merged | on_forces_merged} (ie. deleted). Indexes of merged forces can be reused.
      */
     readonly index: number
 
@@ -7786,7 +7827,7 @@ interface LuaGameScript {
         variables?: {[key: string]: number}): void
 
     /**
-     * Force a CRC check. Tells all peers to calculate their current map CRC; these CRC are then compared against each other. If a mismatch is detected, the game is desynced and some peers are forced to reconnect.
+     * Force a CRC check. Tells all peers to calculate their current CRC, which are then compared to each other. If a mismatch is detected, the game desyncs and some peers are forced to reconnect.
      */
     force_crc(this: void): void
 
@@ -8792,7 +8833,7 @@ interface LuaGui {
  * - `"progressbar"`: A partially filled bar that can be used to indicate progress.
  * - `"table"`: An invisible container that lays out its children in a specific number of columns. The width of each column is determined by the widest element it contains.
  * - `"textfield"`: A single-line box the user can type into. Relevant events: {@link on_gui_text_changed | on_gui_text_changed}, {@link on_gui_confirmed | on_gui_confirmed}
- * - `"radiobutton"`: A clickable element that is functionally identical to a `checkbox`, but has a circular appearance. Relevant event: {@link on_gui_checked_state_changed | on_gui_checked_state_changed}
+ * - `"radiobutton"`: An element that is similar to a `checkbox`, but with a circular appearance. Clicking a selected radio button will not deselect it. Radio buttons are not linked to each other in any way. Relevant event: {@link on_gui_checked_state_changed | on_gui_checked_state_changed}
  * - `"sprite"`: An element that shows an image.
  * - `"scroll-pane"`: An invisible element that is similar to a `flow`, but has the ability to show and use scroll bars.
  * - `"drop-down"`: A drop-down containing strings of text. Relevant event: {@link on_gui_selection_state_changed | on_gui_selection_state_changed}
@@ -9488,6 +9529,11 @@ interface LuaGuiElement {
      */
     position: MapPosition
 
+    /**
+     * Whether this element will raise {@link on_gui_hover | on_gui_hover} and {@link on_gui_leave | on_gui_leave}.
+     */
+    raise_hover_events: boolean
+
     /**
      * Whether this text-box is read-only. Defaults to `false`.
      * @remarks
@@ -11136,6 +11182,15 @@ interface LuaItemStack {
     transfer_stack(this: void,
         stack: ItemStackIdentification): void
 
+    /**
+     * Use the capsule item with the entity as the source, targeting the given position.
+     * @param entity - The entity to use the capsule item with.
+     * @param target_position - The position to use the capsule item with.
+     */
+    use_capsule(this: void,
+        entity: LuaEntity,
+        target_position: MapPosition): void
+
     /**
      * The active blueprint index for this blueprint book. `nil` if this blueprint book is empty.
      * @remarks
@@ -11224,7 +11279,7 @@ interface LuaItemStack {
      * Applies to subclasses: BlueprintItem
      *
      */
-    readonly default_icons: BlueprintItemIcon[]
+    readonly default_icons: BlueprintSignalIcon[]
 
     /**
      * Durability of the contained item. Automatically capped at the item's maximum durability.
@@ -12998,7 +13053,7 @@ interface LuaPlayer extends LuaControl {
     hand_location?: ItemStackLocation
 
     /**
-     * This player's unique index in {@link LuaGameScript::players | LuaGameScript::players}. It is given to them when they are {@link created | on_player_created} and remains assigned to them until they are {@link removed | on_player_removed}.
+     * This player's index in {@link LuaGameScript::players | LuaGameScript::players} (unique ID). It is assigned when a player is created, and remains so (even when the player is not {@link connected | LuaPlayer::connected}) until the player is irreversably {@link removed | on_player_removed}. Indexes of removed players can be reused.
      */
     readonly index: number
 
@@ -13023,9 +13078,14 @@ interface LuaPlayer extends LuaControl {
     minimap_enabled: boolean
 
     /**
-     * The current per-player settings for the this player, indexed by prototype name. Returns the same structure as {@link LuaSettings::get_player_settings | LuaSettings::get_player_settings}.
-     * @remarks
-     * This table will become invalid if its associated player does.
+     * The current per-player settings for the this player, indexed by prototype name. Returns the same structure as {@link LuaSettings::get_player_settings | LuaSettings::get_player_settings}. This table becomes invalid if its associated player does.
+     * 
+     * Even though this attribute is marked as read-only, individual settings can be changed by overwriting their {@link ModSetting | ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
+     * @example
+     * ```
+     * -- Change the value of the "active_lifestyle" setting
+     * player.mod_settings["active_lifestyle"] = {value = true}
+     * ```
      *
      */
     readonly mod_settings: {[key: string]: ModSetting}
@@ -13429,17 +13489,11 @@ interface LuaRecipe {
     hidden_from_flow_stats: boolean
 
     /**
-     * Ingredients for this recipe.
+     * The ingredients to this recipe.
      * @example
-     * What the "steel-chest" recipe would return 
+     * The ingredients of `"advanced-oil-processing"` would look like this: 
      * ```
-     * {{type="item", name="steel-plate", amount=8}}
-     * ```
-     *
-     * @example
-     * What the "advanced-oil-processing" recipe would return 
-     * ```
-     * {{type="fluid", name="crude-oil", amount=10}, {type="fluid", name="water", amount=5}}
+     * {{type="fluid", name="crude-oil", amount=100}, {type="fluid", name="water", amount=50}}
      * ```
      *
      */
@@ -13468,7 +13522,13 @@ interface LuaRecipe {
     readonly order: string
 
     /**
-     * The results of this recipe.
+     * The results/products of this recipe.
+     * @example
+     * The products of `"advanced-oil-processing"` would look like this: 
+     * ```
+     * {{type="fluid", name="heavy-oil", amount=25}, {type="fluid", name="light-oil", amount=45}, {type="fluid", name="petroleum-gas", amount=55}}
+     * ```
+     *
      */
     readonly products: Product[]
 
@@ -13604,7 +13664,13 @@ interface LuaRecipePrototype {
     readonly hidden_from_player_crafting: boolean
 
     /**
-     * Ingredients for this recipe.
+     * The ingredients to this recipe.
+     * @example
+     * The ingredients of `"advanced-oil-processing"` would look like this: 
+     * ```
+     * {{type="fluid", name="crude-oil", amount=100}, {type="fluid", name="water", amount=50}}
+     * ```
+     *
      */
     readonly ingredients: Ingredient[]
 
@@ -13641,7 +13707,13 @@ interface LuaRecipePrototype {
     readonly overload_multiplier: number
 
     /**
-     * The results of this recipe.
+     * The results/products of this recipe.
+     * @example
+     * The products of `"advanced-oil-processing"` would look like this: 
+     * ```
+     * {{type="fluid", name="heavy-oil", amount=25}, {type="fluid", name="light-oil", amount=45}, {type="fluid", name="petroleum-gas", amount=55}}
+     * ```
+     *
      */
     readonly products: Product[]
 
@@ -13747,8 +13819,8 @@ interface LuaRendering {
         id: number): void
 
     /**
-     * Destroys all render objects.
-     * @param mod_name - If provided, only the render objects created by this mod are destroyed.
+     * Destroys all render objects. Passing an empty string (`""`)
+     * @param mod_name - If provided, only the render objects created by this mod are destroyed. An empty string (`""`) refers to all objects not belonging to a mod, such as those created using console commands.
      */
     clear(this: void,
         mod_name?: string): void
@@ -13774,6 +13846,7 @@ interface LuaRendering {
      * @param table.target - Center of the animation.
      * @param table.target_offset - Only used if `target` is a LuaEntity.
      * @param table.time_to_live - In ticks. Defaults to living forever.
+     * @param table.use_target_orientation - Only used if `orientation_target` is a LuaEntity.
      * @param table.visible - If this is rendered to anyone at all. Defaults to true.
      * @param table.x_scale - Horizontal scale of the animation. Default is 1.
      * @param table.y_scale - Vertical scale of the animation. Default is 1.
@@ -13790,6 +13863,7 @@ interface LuaRendering {
             animation_offset?: number,
             orientation_target?: MapPosition | LuaEntity,
             orientation_target_offset?: Vector,
+            use_target_orientation?: boolean,
             oriented_offset?: Vector,
             target: MapPosition | LuaEntity,
             target_offset?: Vector,
@@ -13958,6 +14032,7 @@ interface LuaRendering {
      * @param table.target - Acts like an offset applied to all vertices that are not set to an entity.
      * @param table.target_offset - Only used if `target` is a LuaEntity.
      * @param table.time_to_live - In ticks. Defaults to living forever.
+     * @param table.use_target_orientation - Only used if `orientation_target` is a LuaEntity.
      * @param table.visible - If this is rendered to anyone at all. Defaults to true.
      */
     draw_polygon(this: void,
@@ -13969,6 +14044,7 @@ interface LuaRendering {
             orientation?: RealOrientation,
             orientation_target?: MapPosition | LuaEntity,
             orientation_target_offset?: Vector,
+            use_target_orientation?: boolean,
             surface: SurfaceIdentification,
             time_to_live?: number,
             forces?: ForceIdentification[],
@@ -14021,6 +14097,7 @@ interface LuaRendering {
      * @param table.target - Center of the sprite.
      * @param table.target_offset - Only used if `target` is a LuaEntity.
      * @param table.time_to_live - In ticks. Defaults to living forever.
+     * @param table.use_target_orientation - Only used if `orientation_target` is a LuaEntity.
      * @param table.visible - If this is rendered to anyone at all. Defaults to true.
      * @param table.x_scale - Horizontal scale of the sprite. Default is 1.
      * @param table.y_scale - Vertical scale of the sprite. Default is 1.
@@ -14047,6 +14124,7 @@ interface LuaRendering {
             render_layer?: RenderLayer,
             orientation_target?: MapPosition | LuaEntity,
             orientation_target_offset?: Vector,
+            use_target_orientation?: boolean,
             oriented_offset?: Vector,
             target: MapPosition | LuaEntity,
             target_offset?: Vector,
@@ -14111,7 +14189,7 @@ interface LuaRendering {
 
     /**
      * Gets an array of all valid object ids.
-     * @param mod_name - If provided, get only the render objects created by this mod.
+     * @param mod_name - If provided, get only the render objects created by this mod. An empty string (`""`) refers to all objects not belonging to a mod, such as those created using console commands.
      */
     get_all_ids(this: void,
         mod_name?: string): void
@@ -14434,6 +14512,12 @@ interface LuaRendering {
     get_use_rich_text(this: void,
         id: number): void
 
+    /**
+     * Get whether this uses the target orientation.
+     */
+    get_use_target_orientation(this: void,
+        id: number): void
+
     /**
      * Get the vertical alignment of the text with this id.
      * @remarks
@@ -14885,6 +14969,13 @@ interface LuaRendering {
         id: number,
         use_rich_text: boolean): void
 
+    /**
+     * Set whether this uses the target orientation.
+     */
+    set_use_target_orientation(this: void,
+        id: number,
+        use_target_orientation: boolean): void
+
     /**
      * Set the vertical alignment of the text with this id. Does nothing if this object is not a text.
      * @remarks
@@ -15029,9 +15120,14 @@ interface LuaRoboportControlBehavior extends LuaControlBehavior {
  */
 interface LuaSettings {
     /**
-     * Gets the current per-player settings for the given player, indexed by prototype name. Returns the same structure as {@link LuaPlayer::mod_settings | LuaPlayer::mod_settings}.
-     * @remarks
-     * This table will become invalid if its associated player does.
+     * Gets the current per-player settings for the given player, indexed by prototype name. Returns the same structure as {@link LuaPlayer::mod_settings | LuaPlayer::mod_settings}. This table becomes invalid if its associated player does.
+     * 
+     * Even though this attribute is marked as read-only, individual settings can be changed by overwriting their {@link ModSetting | ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
+     * @example
+     * ```
+     * -- Change the value of the "active_lifestyle" setting
+     * settings.get_player_settings(player_index)["active_lifestyle"] = {value = true}
+     * ```
      *
      */
     get_player_settings(this: void,
@@ -15040,7 +15136,7 @@ interface LuaSettings {
     /**
      * The current global mod settings, indexed by prototype name.
      * 
-     * Even though these are marked as read-only, they can be changed by overwriting individual {@link ModSetting | ModSetting} tables in the custom table. Mods can only change their own settings. Using the in-game console, all global settings can be changed.
+     * Even though this attribute is marked as read-only, individual settings can be changed by overwriting their {@link ModSetting | ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
      */
     readonly global: {[key: string]: ModSetting}
 
@@ -15052,7 +15148,7 @@ interface LuaSettings {
     /**
      * The default player mod settings for this map, indexed by prototype name.
      * 
-     * Even though these are marked as read-only, they can be changed by overwriting individual {@link ModSetting | ModSetting} tables in the custom table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
+     * Even though this attribute is marked as read-only, individual settings can be changed by overwriting their {@link ModSetting | ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
      */
     readonly player: {[key: string]: ModSetting}
 
@@ -16447,7 +16543,7 @@ interface LuaSurface {
      * @param table.entity_to_ignore - Makes the pathfinder ignore collisions with this entity if it is given.
      * @param table.force - The force for which to generate the path, determining which gates can be opened for example.
      * @param table.goal - The position to find a path to.
-     * @param table.path_resolution_modifier - Defines how coarse the pathfinder's grid is. Smaller values mean a coarser grid (negative numbers allowed). Allowed values are from -8 to 8. Defaults to `0`.
+     * @param table.path_resolution_modifier - Defines how coarse the pathfinder's grid is, where smaller values mean a coarser grid. Defaults to `0`, which equals a resolution of `1x1` tiles, centered on tile centers. Values range from `-8` to `8` inclusive, where each integer increment doubles/halves the resolution. So, a resolution of `-8` equals a grid of `256x256` tiles, and a resolution of `8` equals `1/256` of a tile.
      * @param table.pathfind_flags - Flags that affect pathfinder behavior.
      * @param table.radius - How close the pathfinder needs to get to its `goal` (in tiles). Defaults to `1`.
      * @param table.start - The position from which to start pathfinding.
@@ -16614,12 +16710,12 @@ interface LuaSurface {
     generate_with_lab_tiles: boolean
 
     /**
-     * Unique ID associated with this surface.
+     * This surface's index in {@link LuaGameScript::surfaces | LuaGameScript::surfaces} (unique ID). It is assigned when a surface is created, and remains so until it is {@link deleted | on_surface_deleted}. Indexes of deleted surfaces can be reused.
      */
     readonly index: number
 
     /**
-     * The generation settings for this surface. These can be modified to after surface generation, but note that this will not retroactively update the surface. To manually adjust it, {@link LuaSurface::regenerate_entity | LuaSurface::regenerate_entity}, {@link LuaSurface::regenerate_decorative | LuaSurface::regenerate_decorative} and {@link LuaSurface::delete_chunk | LuaSurface::delete_chunk} can be used.
+     * The generation settings for this surface. These can be modified after surface generation, but note that this will not retroactively update the surface. To manually regenerate it, {@link LuaSurface::regenerate_entity | LuaSurface::regenerate_entity}, {@link LuaSurface::regenerate_decorative | LuaSurface::regenerate_decorative}, and {@link LuaSurface::delete_chunk | LuaSurface::delete_chunk} can be used.
      */
     map_gen_settings: MapGenSettings
 
@@ -16688,7 +16784,7 @@ interface LuaSurface {
     wind_orientation_change: number
 
     /**
-     * Current wind speed.
+     * Current wind speed in tiles per tick.
      */
     wind_speed: number
 
@@ -16769,7 +16865,7 @@ interface LuaTechnology {
     readonly research_unit_count: number
 
     /**
-     * The count formula used for this infinite research. `nil` if this research isn't infinite.
+     * The count formula, if this research has any. See the {@link wiki | https://wiki.factorio.com/Prototype/Technology#Technology_data} for details.
      */
     readonly research_unit_count_formula?: string
 
@@ -16883,7 +16979,7 @@ interface LuaTechnologyPrototype {
     readonly research_unit_count: number
 
     /**
-     * The count formula used for this infinite research. `nil` if this research isn't infinite.
+     * The count formula, if this research has any. See the {@link wiki | https://wiki.factorio.com/Prototype/Technology#Technology_data} for details.
      */
     readonly research_unit_count_formula?: string
 
@@ -17054,9 +17150,9 @@ interface LuaTilePrototype {
     readonly emissions_per_second: number
 
     /**
-     * Items that when placed will produce this tile. It is a dictionary indexed by the item prototype name. `nil` (instead of an empty table) if no items can place this tile.
+     * Items that when placed will produce this tile, if any. Construction bots will choose the first item in the list to build this tile.
      */
-    readonly items_to_place_this: SimpleItemStack[]
+    readonly items_to_place_this?: ItemStackDefinition[]
 
     readonly layer: number
 
@@ -18496,6 +18592,11 @@ interface LuaGuiElementAddParamsTextfield extends LuaGuiElementAddParams {
  *
  */
 interface LuaSurfaceCreateEntityParams {
+    /**
+     * If fast_replace is true simulate fast replace using this character.
+     */
+    'character'?: LuaEntity
+
     /**
      * If false, the building effect smoke will not be shown around the new entity.
      */
@@ -18547,7 +18648,7 @@ interface LuaSurfaceCreateEntityParams {
     'raise_built'?: boolean
 
     /**
-     * Source entity. Used for beams and highlight-boxes.
+     * Source entity. Used for beams, projectiles, and highlight-boxes.
      */
     'source'?: LuaEntity | MapPosition
 

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 1.1.77
+// Factorio version 1.1.80
 // API version 3
 
 /**
@@ -309,19 +309,6 @@ interface BlueprintEntity {
     tags?: Tags
 }
 
-interface BlueprintItemIcon {
-    
-    /**
-     * Index of the icon in the blueprint icons slots. Has to be an integer in the range [1, 4].
-     */
-    index: number,
-    
-    /**
-     * Name of the item prototype whose icon should be used.
-     */
-    name: string
-}
-
 interface BlueprintSignalIcon {
     
     /**
@@ -1343,7 +1330,7 @@ interface ItemStackLocation {
  * 
  * The template can contain placeholders such as `__1__` or `__2__`. These will be replaced by the respective parameter in the LocalisedString. The parameters themselves can be other localised strings, which will be processed recursively in the same fashion. Localised strings can not be recursed deeper than 20 levels and can not have more than 20 parameters.
  * 
- * As a special case, when the key is just the empty string, all the parameters will be concatenated (after processing, if any are localised strings). If there is only one parameter, it will be used as is.
+ * There are two special flags for the localised string, indicated by the key being a particular string. First, if the key is the empty string (`""`), then all parameters will be concatenated (after processing, if any are localised strings themselves). Second, if the key is a question mark (`"?"`), then the first valid parameter will be used. A parameter can be invalid if its name doesn't match any string template. If no parameters are valid, the last one is returned. This is useful to implement a fallback for missing locale templates.
  * 
  * Furthermore, when an API function expects a localised string, it will also accept a regular string (i.e. not a table) which will not be translated, as well as a number, boolean or `nil`, which will be converted to their textual representation.
  * @example
@@ -1371,6 +1358,13 @@ interface ItemStackLocation {
  * game.print({"", {"item-name.iron-plate"}, ": ", 60})
  * ```
  *
+ * @example
+ * As an example of a localised string with fallback, consider this: 
+ * ```
+ * {"?", {"", {"entity-description.furnace"}, "\n"}, {"item-description.furnace"}, "optional fallback"}
+ * ```
+ *  If `entity-description.furnace` exists, it is concatenated with `"\n"` and returned. Otherwise, if `item-description.furnace` exists, it is returned as-is. Otherwise, `"optional fallback"` is returned. If this value wasn't specified, the translation result would be `"Unknown key: 'item-description.furnace'"`.
+ *
  */
 type LocalisedString = string | number | boolean | object | null | Array<string | LocalisedString>
 
@@ -1828,11 +1822,6 @@ interface ModChangeData {
     old_version: string
 }
 
-/**
- * @remarks
- * Runtime settings can be changed through console commands and by the mod that owns the settings by writing a new table to the ModSetting.
- *
- */
 interface ModSetting {
     
     /**
@@ -2885,7 +2874,7 @@ interface WireConnectionDefinition {
     target_wire_id?: defines.wire_connection_id,
     
     /**
-     * Wire color, either {@link defines.wire_type.red | defines.wire_type.red} or {@link defines.wire_type.green | defines.wire_type.green}.
+     * The type of wire used.
      */
     wire: defines.wire_type
 }

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 1.1.77
+// Factorio version 1.1.80
 // API version 3
 
 declare namespace defines {
@@ -539,6 +539,8 @@ declare namespace defines {
         on_gui_closed,
         on_gui_confirmed,
         on_gui_elem_changed,
+        on_gui_hover,
+        on_gui_leave,
         on_gui_location_changed,
         on_gui_opened,
         on_gui_selected_tab_changed,
@@ -794,6 +796,8 @@ declare namespace defines {
         gui_click,
         gui_confirmed,
         gui_elem_changed,
+        gui_hover,
+        gui_leave,
         gui_location_changed,
         gui_selected_tab_changed,
         gui_selection_state_changed,

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 1.1.77
+// Factorio version 1.1.80
 // API version 3
 
 /**
@@ -686,6 +686,32 @@ interface on_gui_elem_changed extends event  {
      */
     player_index: number
 }
+/**
+ * Called when {@link LuaGuiElement | LuaGuiElement} is hovered by the mouse.
+ */
+interface on_gui_hover extends event  {
+    /**
+     * The element that is being hovered over.
+     */
+    element: LuaGuiElement
+    /**
+     * The player whose cursor is hovering.
+     */
+    player_index: number
+}
+/**
+ * Called when the player's cursor leaves a {@link LuaGuiElement | LuaGuiElement} that was previously hovered.
+ */
+interface on_gui_leave extends event  {
+    /**
+     * The element that was being hovered.
+     */
+    element: LuaGuiElement
+    /**
+     * The player whose cursor was hovering.
+     */
+    player_index: number
+}
 /**
  * Called when {@link LuaGuiElement | LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
  */
@@ -1210,7 +1236,7 @@ interface on_player_created extends event  {
     player_index: number
 }
 /**
- * Called after a players cursorstack changed in some way.
+ * Called after a player's {@link cursor stack | LuaControl::cursor_stack} changed in some way.
  */
 interface on_player_cursor_stack_changed extends event  {
     player_index: number
@@ -1487,11 +1513,11 @@ interface on_player_promoted extends event  {
     player_index: number
 }
 /**
- * Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
+ * Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | on_player_left_game} the game, and instead behaves like the player never existed in the save file.
  */
 interface on_player_removed extends event  {
     /**
-     * The player index that was removed
+     * The index of the removed player.
      */
     player_index: number
 }
@@ -1910,11 +1936,11 @@ interface on_pre_player_mined_item extends event  {
     player_index: number
 }
 /**
- * Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
+ * Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | on_player_left_game} the game, and instead behaves like the player never existed in the save file.
  */
 interface on_pre_player_removed extends event  {
     /**
-     * The player index that will be removed
+     * The index of the removed player.
      */
     player_index: number
 }
@@ -2332,7 +2358,7 @@ interface on_surface_deleted extends event  {
     surface_index: number
 }
 /**
- * Called after a surface is imported.
+ * Called after a surface is imported via the map editor.
  */
 interface on_surface_imported extends event  {
     /**

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 1.1.77
+// Factorio version 1.1.80
 // API version 3
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "0.0.33",
+  "version": "0.0.35",
   "description": "Typescript declarations for the factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",