factorio-types 1.2.37 → 1.2.38

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.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[];
 }
 /**
  *

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.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}.

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.52
+// Factorio version 2.0.54
 // 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.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 {

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

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.52
+// Factorio version 2.0.54
 // API version 6
 
 declare namespace prototype {
@@ -5145,6 +5145,10 @@ interface LandMinePrototype extends EntityWithOwnerPrototype {
      */
     trigger_collision_mask?: CollisionMaskConnector;
     trigger_force?: ForceCondition;
+    /**
+     * Time between checks to detonate due to nearby enemies. A larger time will be more performant.
+     */
+    trigger_interval?: uint32;
     trigger_radius: double;
 }
 interface LaneSplitterPrototype extends TransportBeltConnectablePrototype {
@@ -8003,10 +8007,18 @@ interface SmokeWithTriggerPrototype extends SmokePrototype {
  * A {@link portable solar panel | https://wiki.factorio.com/Portable_solar_panel}.
  */
 interface SolarPanelEquipmentPrototype extends EquipmentPrototype {
+    performance_at_day?: double;
+    performance_at_night?: double;
     /**
      * How much power should be provided.
      */
     power: Energy;
+    /**
+     * Surface property must have a positive {@link default value | prototype:SurfacePropertyPrototype::default_value}. When {@link SolarPanelEquipmentPrototype::solar_coefficient_property | prototype:SolarPanelEquipmentPrototype::solar_coefficient_property} is set to point at a different surface property than "solar-power", then {@link LuaSurface::solar_power_multiplier | runtime:LuaSurface::solar_power_multiplier} and {@link SpaceLocationPrototype::solar_power_in_space | prototype:SpaceLocationPrototype::solar_power_in_space} will be ignored as the solar panel power output will be only affected by value of this surface property set on the surface using {@link PlanetPrototype::surface_properties | prototype:PlanetPrototype::surface_properties} or {@link LuaSurface::set_property | runtime:LuaSurface::set_property}.
+     *
+     * Due to equipment grid overall description, when solar_coefficient_property is not solar-power, a different locale will be used to show total energy production of solar panels: `description.solar-panel-power-X` where X is the surface property name.
+     */
+    solar_coefficient_property?: SurfacePropertyID;
 }
 /**
  * A {@link solar panel | https://wiki.factorio.com/Solar_panel}.
@@ -8674,11 +8686,11 @@ interface StickerPrototype extends EntityPrototype {
     /**
      * The `hidden` property of stickers is hardcoded to `true`.
      */
-    hidden?: boolean;
+    hidden: true;
     /**
      * The `hidden_in_factoriopedia` property of stickers is hardcoded to `true`.
      */
-    hidden_in_factoriopedia?: boolean;
+    hidden_in_factoriopedia: true;
     render_layer?: RenderLayer;
     /**
      * Using this property marks the sticker as a "selection sticker", meaning that the selection box will be rendered around the entity when the sticker is on it.
@@ -9761,6 +9773,14 @@ interface UtilityConstants extends PrototypeBase {
     asteroid_position_offset_to_speed_coefficient: double;
     asteroid_spawning_offset: SimpleBoundingBox;
     asteroid_spawning_with_random_orientation_max_speed: double;
+    /**
+     * Will be clamped to the range [2, 100].
+     */
+    blueprint_big_slots_per_row: uint8;
+    /**
+     * Will be clamped to the range [2, 100].
+     */
+    blueprint_small_slots_per_row: uint8;
     /**
      * The base game uses more entries here that are applied via the ammo-category.lua file.
      */
@@ -9788,6 +9808,10 @@ interface UtilityConstants extends PrototypeBase {
     color_filters?: ColorFilterData[];
     construction_robots_use_busy_robots_queue: boolean;
     count_button_size: int32;
+    /**
+     * Will be clamped to the range [1, 100].
+     */
+    crafting_queue_slots_per_row: uint8;
     daytime_color_lookup: DaytimeColorLookupTable;
     deconstruct_mark_tint: Color;
     default_alert_icon_scale: float;
@@ -9879,9 +9903,9 @@ interface UtilityConstants extends PrototypeBase {
      */
     inserter_hand_stack_max_sprites: ItemCountType;
     /**
-     * Must be in range [1, 100].
+     * Will be clamped to the range [1, 100].
      */
-    inventory_width: uint32;
+    inventory_width: uint8;
     item_ammo_magazine_left_bar_color: Color;
     item_default_random_tint_strength: Color;
     /**
@@ -9912,6 +9936,10 @@ interface UtilityConstants extends PrototypeBase {
     logistic_gui_selected_network_highlight_tint: Color;
     logistic_gui_unselected_network_highlight_tint: Color;
     logistic_robots_use_busy_robots_queue: boolean;
+    /**
+     * Will be clamped to the range [2, 100].
+     */
+    logistic_slots_per_row: uint8;
     low_energy_robot_estimate_multiplier: double;
     main_menu_background_image_location: FileName;
     main_menu_background_vignette_intensity: float;
@@ -9937,9 +9965,9 @@ interface UtilityConstants extends PrototypeBase {
     minimum_recipe_overload_multiplier: uint32;
     missing_preview_sprite_location: FileName;
     /**
-     * Must be in range [1, 100].
+     * Will be clamped to the range [1, 100].
      */
-    module_inventory_width: uint32;
+    module_inventory_width: uint8;
     /**
      * Silently clamped to be between 0 and 1.
      */
@@ -9957,11 +9985,11 @@ interface UtilityConstants extends PrototypeBase {
     rocket_lift_weight: Weight;
     script_command_console_chat_color: Color;
     /**
-     * Must be in range [1, 100].
+     * Will be clamped to the range [1, 100].
      */
     select_group_row_count: uint8;
     /**
-     * Must be in range [1, 100].
+     * Will be clamped to the range [1, 100].
      */
     select_slot_row_count: uint8;
     selected_chart_search_highlight: Color;
@@ -9975,6 +10003,10 @@ interface UtilityConstants extends PrototypeBase {
      * Variables: speed, thrust, weight, width, height
      */
     space_platform_acceleration_expression: MathExpression;
+    /**
+     * How many asteroid chunks should be processed per tick, see {@link space_platform_max_relative_speed_deviation_for_asteroid_chunks_update | prototype:UtilityConstants::space_platform_max_relative_speed_deviation_for_asteroid_chunks_update}.
+     */
+    space_platform_asteroid_chunk_trajectory_updates_per_tick: uint32;
     /**
      * Determines how fast space platforms will send items in drop slots to the surface. Each item type has its own cooldown.
      */
@@ -9983,6 +10015,10 @@ interface UtilityConstants extends PrototypeBase {
      * Delay after manual transfer until space platform sends items in drop slots to the surface. Overrides remaining space_platform_dump_cooldown in this instance.
      */
     space_platform_manual_dump_cooldown: uint32;
+    /**
+     * Space platform remembers relative speed range which asteroids use while it moves. When the range is larger than the specified deviation, the platform will start updating cached trajectories of all asteroid chunks over multiple ticks.
+     */
+    space_platform_max_relative_speed_deviation_for_asteroid_chunks_update: float;
     space_platform_max_size: SimpleBoundingBox;
     space_platform_relative_speed_factor: double;
     space_platform_starfield_movement_vector: Vector;
@@ -10008,6 +10044,10 @@ interface UtilityConstants extends PrototypeBase {
     train_temporary_stop_wait_time: uint32;
     train_time_wait_condition_default: uint32;
     train_visualization: TrainVisualizationConstants;
+    /**
+     * Will be clamped to the range [1, 100].
+     */
+    trash_inventory_width: uint8;
     tree_leaf_distortion_distortion_far: Vector;
     tree_leaf_distortion_distortion_near: Vector;
     tree_leaf_distortion_speed_far: Vector;

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.37",
+  "version": "1.2.38",
   "description": "Typescript declarations for the Factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,7 +23,7 @@
     "src/**/*.d.ts",
     "dist/**/*.d.ts"
   ],
-  "factorioVersion": "2.0.52",
+  "factorioVersion": "2.0.54",
   "dependencies": {
     "lua-types": "^2.13.1"
   },