Factorio API version 2.0.54

Author: sguest

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.52
+// Factorio version 2.0.54
 // API version 6
 
 declare namespace runtime {
@@ -6416,7 +6416,7 @@ interface LuaEntity extends LuaControl {
      */
     set_inventory_size_override(this: void, inventory_index: defines.inventory, size_override: uint16 | nil, overflow?: LuaInventory): void;
     /**
-     * Sets the passenger of this car or spidertron.
+     * Sets the passenger of this car, spidertron, or cargo pod.
      *
      * This differs from {@link LuaEntity::get_driver | runtime:LuaEntity::get_driver} in that the passenger can't drive the car.
      * @param passenger The new passenger. Writing `nil` ejects the current passenger, if any.
@@ -8942,6 +8942,9 @@ interface LuaEquipmentPrototype extends LuaPrototypeBase {
          */
         points?: EquipmentPoint[];
     };
+    readonly solar_panel_performance_at_day: double;
+    readonly solar_panel_performance_at_night: double;
+    readonly solar_panel_solar_coefficient_property: LuaSurfacePropertyPrototype;
     /**
      * The result item when taking this equipment out of an equipment grid, if any.
      */
@@ -12189,12 +12192,12 @@ interface LuaItemCommon {
      */
     get_inventory(this: void, inventory: defines.inventory): LuaInventory | null;
     /**
-     * Gets the filter at the given index for this upgrade item.
+     * Gets the filter at the given index for this upgrade item. Note that sources (`"from"` type) that are undefined will read as `{type = "item"}`, while destinations (`"to"` type) that are undefined will read as `nil`.
      *
      * In contrast to {@link LuaItemCommon::set_mapper | runtime:LuaItemCommon::set_mapper}, indices past the upgrade item's current size are considered to be out of bounds.
      * @param index The index of the mapper to read.
      */
-    get_mapper(this: void, index: uint, type: 'from' | 'to'): UpgradeMapperSource | UpgradeMapperDestination;
+    get_mapper(this: void, index: uint, type: 'from' | 'to'): (UpgradeMapperSource | UpgradeMapperDestination) | null;
     /**
      * Gets the tag with the given name or returns `nil` if it doesn't exist.
      */
@@ -13282,8 +13285,9 @@ interface LuaLogisticSection {
      * This can only be called when the section {@link is manual | runtime:LuaLogisticSection::is_manual}.
      * @param slot_index Index of a slot to set.
      * @param filter The details of the filter to set.
+     * @returns The existing index for the given filter or nil if the filter was successfully set.
      */
-    set_slot(this: void, slot_index: LogisticFilterIndex, filter: LogisticFilter): void;
+    set_slot(this: void, slot_index: LogisticFilterIndex, filter: LogisticFilter): LogisticFilterIndex | null;
     /**
      * Whether this section is active. This can only be written to when the section {@link is manual | runtime:LuaLogisticSection::is_manual}.
      */
@@ -15399,7 +15403,7 @@ interface LuaRecord {
      */
     get_entity_filter(this: void, index: uint): ItemFilter | null;
     /**
-     * Gets the filter at the given index for this upgrade item.
+     * Gets the filter at the given index for this upgrade item. Note that sources (`"from"` type) that are undefined will read as `{type = "item"}`, while destinations (`"to"` type) that are undefined will read as `nil`.
      *
      * In contrast to {@link LuaRecord::set_mapper | runtime:LuaRecord::set_mapper}, indices past the upgrade item's current size are considered to be out of bounds.
      * @param index The index of the mapper to read.
@@ -18273,7 +18277,7 @@ interface LuaSurfaceCreateEntityParamsHighlightBox extends BaseLuaSurfaceCreateE
  */
 interface LuaSurfaceCreateEntityParamsInserter extends BaseLuaSurfaceCreateEntityParams {
     'conditions': InserterCircuitConditions;
-    'filters': InventoryFilter[];
+    'filters'?: InserterItemFilter[];
 }
 /**
  *

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.52
+// Factorio version 2.0.54
 // API version 6
 
 declare namespace runtime {
@@ -181,9 +181,6 @@ interface AsteroidChunkPrototypeFilter {
      */
     invert?: boolean;
 }
-/**
- * Used by {@link MapSettings | runtime:MapSettings} and {@link MapAndDifficultySettings | runtime:MapAndDifficultySettings}.
- */
 interface AsteroidMapSettings {
     spawning_rate: double;
     max_ray_portals_expanded_per_tick: uint;
@@ -2606,6 +2603,24 @@ interface InserterCircuitConditions {
     circuit?: CircuitCondition;
     logistics?: CircuitCondition;
 }
+interface InserterItemFilter {
+    /**
+     * Position of the corresponding filter slot.
+     */
+    index: uint;
+    /**
+     * Item prototype name of the item to filter.
+     */
+    name: string;
+    /**
+     * Quality prototype name of the item to filter.
+     */
+    quality?: string;
+    /**
+     * Quality comparator to use for the quality filter.
+     */
+    comparator?: string;
+}
 interface InventoryFilter {
     /**
      * Position of the corresponding filter slot.
@@ -8162,27 +8177,28 @@ interface UnitSpawnDefinition {
     spawn_points: SpawnPointDefinition[];
 }
 interface UpgradeMapperDestination {
+    type: 'item' | 'entity';
     /**
-     * `"item"`, or `"entity"`.
-     */
-    type: string;
-    /**
-     * Name of the item, or entity.
+     * Name of the item or entity.
      */
     name?: string;
     /**
-     * Name of the quality.
+     * Name of the quality prototype.
      */
     quality?: string;
     /**
-     * when type is `"item"` and the mapper is configured to install modules the limit per machine. If `0` then no limit.
+     * When upgrading modules, this defines the maximum number of this module to be installed in the destination entity. `0` or `nil` means no limit.
      */
-    count?: uint;
+    module_limit?: uint16;
+    /**
+     * When upgrading entities, this defines explicit modules to be installed in the destination entity. Lists empty slots as `{}`.
+     */
+    module_slots?: ItemIDAndQualityIDPair[];
 }
 interface UpgradeMapperSource {
     type: 'item' | 'entity';
     /**
-     * Name of the item, or entity.
+     * Name of the item or entity.
      */
     name?: string;
     /**
@@ -8193,6 +8209,10 @@ interface UpgradeMapperSource {
      * The quality comparison type.
      */
     comparator?: ComparatorString;
+    /**
+     * When upgrading modules, this defines the specific entities to apply the upgrade to. `nil` applies it to all entities.
+     */
+    module_filter?: EntityIDFilter;
 }
 /**
  * Defines the mode of operation for a {@link ValvePrototype | prototype:ValvePrototype}.

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.52
+// Factorio version 2.0.54
 // API version 6
 
 declare namespace prototype {

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.52
+// Factorio version 2.0.54
 // API version 6
 
 declare namespace defines {
@@ -442,7 +442,7 @@ enum distraction {
 }
 enum entity_status {
     /**
-     * Only used if set through {@link LuaEntity::status | runtime:LuaEntity::status} or {@link ContainerPrototype::default_status | prototype:ContainerPrototype::default_status}.
+     * Only used if set through {@link ContainerPrototype::default_status | prototype:ContainerPrototype::default_status}.
      */
     broken = 3,
     /**
@@ -1235,14 +1235,23 @@ enum inventory {
     artillery_turret_ammo = 46,
     artillery_wagon_ammo = 47,
     /**
-     * Used when items are ejected or items held by inserters cannot be inserted due to changing the recipe with the circuit network.
+     * Used for ejected items, or items held by inserters that can't be inserted due the recipe being changed with the circuit network.
      */
     assembling_machine_dump = 26,
+    /**
+     * Deprecated, replaced by `"crafter_input"`.
+     */
     assembling_machine_input = 23,
+    /**
+     * Deprecated, replaced by `"crafter_modules"`.
+     */
     assembling_machine_modules = 25,
+    /**
+     * Deprecated, replaced by `"crafter_output"`.
+     */
     assembling_machine_output = 24,
     /**
-     * Used for spoil result items that do not fit into the recipe slots and for items that are ejected when changing the recipe via remote view.
+     * Deprecated, replaced by `"crafter_trash"`.
      */
     assembling_machine_trash = 27,
     asteroid_collector_output = 63,
@@ -1266,17 +1275,29 @@ enum inventory {
     crafter_input = 59,
     crafter_modules = 61,
     crafter_output = 60,
+    /**
+     * Used for spoil result items that do not fit into the recipe slots, and for items that are ejected when changing the recipe via remote view.
+     */
     crafter_trash = 62,
     editor_ammo = 17,
     editor_armor = 18,
     editor_guns = 16,
     editor_main = 15,
     fuel = 0,
+    /**
+     * Deprecated, replaced by `"crafter_modules"`.
+     */
     furnace_modules = 6,
+    /**
+     * Deprecated, replaced by `"crafter_output"`.
+     */
     furnace_result = 5,
+    /**
+     * Deprecated, replaced by `"crafter_input"`.
+     */
     furnace_source = 4,
     /**
-     * Used for spoil result items that do not fit into the recipe slots.
+     * Deprecated, replaced by `"crafter_trash"`.
      */
     furnace_trash = 7,
     god_main = 14,
@@ -1294,8 +1315,17 @@ enum inventory {
     roboport_robot = 19,
     robot_cargo = 21,
     robot_repair = 22,
+    /**
+     * Deprecated, replaced by `"crafter_input"`.
+     */
     rocket_silo_input = 35,
+    /**
+     * Deprecated, replaced by `"crafter_modules"`.
+     */
     rocket_silo_modules = 37,
+    /**
+     * Deprecated, replaced by `"crafter_output"`.
+     */
     rocket_silo_output = 36,
     rocket_silo_rocket = 33,
     rocket_silo_trash = 34,
@@ -2282,8 +2312,17 @@ enum wire_connector_id {
     power_switch_right_copper = 8
 }
 enum wire_origin {
+    /**
+     * These wires can be modified by players, scripts, and the game. They are visible to the player if the entity's `draw_circuit_wires` prototype property is set to `true` and both ends of it are on the same surface.
+     */
     player = 0,
+    /**
+     * These wires can only be modified by the game. They are not visible to the player, irrespective of the `draw_circuit_wires` prototype property.
+     */
     radars = 2,
+    /**
+     * These wires can be modified by scripts and the game. They are not visible to the player, irrespective of the `draw_circuit_wires` prototype property.
+     */
     script = 1
 }
 enum wire_type {

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.52
+// Factorio version 2.0.54
 // API version 6
 
 declare namespace runtime {

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.52
+// Factorio version 2.0.54
 // API version 6
 
 /**