factorio-types 1.2.35 → 1.2.37

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.50
+// Factorio version 2.0.52
 // API version 6
 
 declare namespace runtime {
@@ -6018,11 +6018,9 @@ interface LuaEntity extends LuaControl {
     get_line_item_position(this: void, index: uint, position: float): MapPosition;
     /**
      * Gets all the `LuaLogisticPoint`s that this entity owns. Optionally returns only the point specified by the index parameter.
-     *
-     * When `index` is not given, this will be a single `LuaLogisticPoint` for most entities. For some (such as the player character), it can be zero or more.
-     * @param index If provided, only returns the `LuaLogisticPoint` specified by this index.
+     * @param index If provided, this method only returns the `LuaLogisticPoint` specified by this index, or `nil` if it doesn't exist.
      */
-    get_logistic_point(this: void, index?: defines.logistic_member_index): (LuaLogisticPoint | Record<defines.logistic_member_index, LuaLogisticPoint>) | null;
+    get_logistic_point(this: void, index?: defines.logistic_member_index): (LuaLogisticPoint | LuaLogisticPoint[]) | null;
     /**
      * Gives logistic sections of this entity if it uses logistic sections.
      */
@@ -6656,7 +6654,7 @@ interface LuaEntity extends LuaControl {
      */
     combat_robot_owner?: LuaEntity;
     /**
-     * The description on this combinator
+     * The description on this combinator.
      */
     combinator_description: string;
     /**
@@ -12609,6 +12607,7 @@ interface LuaItemPrototype extends LuaPrototypeBase {
      * Effects of this module.
      */
     readonly module_effects?: ModuleEffects;
+    readonly moved_to_hub_when_building: boolean;
     /**
      * 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.
      */
@@ -16252,6 +16251,10 @@ interface LuaSchedule {
      * @param index The record to change.
      */
     drag_wait_condition(this: void, index: ScheduleRecordPosition, from: uint, to: uint): void;
+    /**
+     * Gets if the given interrupt can be triggered inside other interrupts.
+     */
+    get_inside_interrupt(this: void, interrupt_index: uint): boolean;
     get_interrupt(this: void, index: uint): ScheduleInterrupt | null;
     get_interrupts(this: void): ScheduleInterrupt[];
     get_record(this: void, index: ScheduleRecordPosition): ScheduleRecord | null;
@@ -16301,6 +16304,10 @@ interface LuaSchedule {
      * Sets if unloading is allowed at the given schedule index.
      */
     set_allow_unloading(this: void, index: ScheduleRecordPosition, allow: boolean): void;
+    /**
+     * Sets if the given interrupt can be triggered inside other interrupts.
+     */
+    set_inside_interrupt(this: void, interrupt_index: uint, value: boolean): void;
     set_interrupts(this: void, interrupts: ScheduleInterrupt[]): void;
     /**
      * @param interrupt_index If provided, the records will be set on this interrupt.
@@ -17806,6 +17813,28 @@ interface LuaSurface {
      * @param undo_index The index of the undo item to add this action to. An index of `0` creates a new undo item for it. Defaults to putting it into the appropriate undo item automatically if not specified.
      */
     set_tiles(this: void, tiles: Tile[], correct_tiles?: boolean, remove_colliding_entities?: boolean | 'abort_on_collision', remove_colliding_decoratives?: boolean, raise_event?: boolean, player?: PlayerIdentification, undo_index?: uint): void;
+    /**
+     * Spill inventory on the ground centered at a given location.
+     * @param table.position Center of the spillage
+     * @param table.inventory Inventory to spill
+     * @param table.enable_looted When true, each created item will be flagged with the {@link LuaEntity::to_be_looted | runtime:LuaEntity::to_be_looted} flag. Defaults to `false`.
+     * @param table.force When provided (and not `nil`) the items will be marked for deconstruction by this force.
+     * @param table.allow_belts Whether items can be spilled onto belts. Defaults to `true`.
+     * @param table.max_radius Max radius from the specified `position` to spill items.
+     * @param table.use_start_position_on_failure Allow spilling items at `position` if no non-colliding position is found. Note: Setting to false might cause some items not to be spilled. Defaults to `true`.
+     * @param table.drop_full_stack If item on ground should be made out of an entire provided stack. Defaults to `false`.
+     * @returns The created item-on-ground entities.
+     */
+    spill_inventory(this: void, table: {
+        position: MapPosition;
+        inventory: LuaInventory;
+        enable_looted?: boolean;
+        force?: ForceID;
+        allow_belts?: boolean;
+        max_radius?: double;
+        use_start_position_on_failure?: boolean;
+        drop_full_stack?: boolean;
+    }): LuaEntity[];
     /**
      * Spill items on the ground centered at a given location.
      * @param table.position Center of the spillage

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.50
+// Factorio version 2.0.52
 // 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.50
+// Factorio version 2.0.52
 // 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.50
+// Factorio version 2.0.52
 // API version 6
 
 declare namespace defines {

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.50
+// Factorio version 2.0.52
 // API version 6
 
 declare namespace runtime {
@@ -180,12 +180,21 @@ interface on_build_base_arrived {
  * Called when player builds something.
  */
 interface on_built_entity {
+    /**
+     * A temporary inventory containing all items that the game used to build the entity. This inventory is temporary and thus invalidated after the event.
+     */
     consumed_items: LuaInventory;
+    /**
+     * The entity that was built.
+     */
     entity: LuaEntity;
     /**
      * Identifier of the event
      */
     name: defines.events;
+    /**
+     * The player who did the building.
+     */
     player_index: uint;
     /**
      * The tags associated with this entity if any.
@@ -3832,6 +3841,7 @@ interface on_script_trigger_effect {
      * Identifier of the event
      */
     name: defines.events;
+    quality?: string;
     source_entity?: LuaEntity;
     source_position?: MapPosition;
     /**

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.50
+// Factorio version 2.0.52
 // 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.50
+// Factorio version 2.0.52
 // API version 6
 
 declare namespace prototype {
@@ -2096,14 +2096,12 @@ interface CustomInputPrototype extends Prototype {
      */
     controller_alternative_key_sequence?: string;
     /**
-     * The controller (game pad) keybinding for this control. Use "" (empty string) for unassigned.
+     * The controller (game pad) keybinding for this control. Use `""` (empty string) for unassigned.
      *
-     * " + " is used to separate modifier buttons from normal buttons: <code>"controller-righttrigger + controller-a"</code>.
+     * As modifier buttons, these names are used: `"controller-righttrigger"`, `"controller-lefttrigger"`.
      *
-     * For modifier buttons, the following names are used: "controller-righttrigger", "controller-lefttrigger".
-     *
-     * A key binding can contain an unlimited amount of modifier buttons (listed above) but only one normal button (listed below).
-     * These names are available for the normal controller buttons
+     * `" + "` is used to separate modifier buttons from normal buttons, like so: `"controller-righttrigger + controller-a"`. A key binding can contain any amount of individual modifier buttons, but only a single normal button (listed below).
+     * Available names for the normal controller buttons
      *
      * - controller-a
      * - controller-b
@@ -2147,16 +2145,27 @@ interface CustomInputPrototype extends Prototype {
      */
     item_to_spawn?: ItemID;
     /**
-     * The default key sequence for this custom input. Use "" (empty string) for unassigned.
-     *
-     * Use "mouse-button-2" etc for mouse buttons, mouse-button-3 for middle mouse button. Use "mouse-wheel-up", "mouse-wheel-down", "mouse-wheel-left", "mouse-wheel-right" for mouse wheel.
+     * The default key sequence for this custom input. Use `""` (empty string) for unassigned.
      *
-     * " + " is used to separate modifier keys from normal keys: <code>"ALT + G"</code>.
+     * As modifier keys, these names are used: `"CONTROL"`, `"SHIFT"`, `"COMMAND"`, `"ALT"`. Note that `"COMMAND"` is loaded as `"CONTROL"` on Windows and Linux.
      *
-     * For modifier keys, the following names are used: "CONTROL", "SHIFT", "ALT", "COMMAND".
+     * `" + "` is used to separate modifier keys from normal keys, like so: `"ALT + G"`. A key binding can contain any amount of individual modifier keys, but only a single normal mouse button or keyboard key (listed below).
+     * Available names for the normal mouse button
      *
-     * A key binding can contain an unlimited amount of modifier keys (listed above) but only one normal key (listed below).
-     * These names are available for the normal keyboard keys
+     * - `mouse-button-1` (left)
+     * - `mouse-button-2` (right)
+     * - `mouse-button-3` (middle)
+     * - `mouse-button-4`
+     * - `mouse-button-5`
+     * - `mouse-button-6`
+     * - `mouse-button-7`
+     * - `mouse-button-8`
+     * - `mouse-button-9`
+     * - `mouse-wheel-up`
+     * - `mouse-wheel-down`
+     * - `mouse-wheel-left`
+     * - `mouse-wheel-right`
+     * Available names for the normal keyboard keys
      *
      * - A
      * - B
@@ -4667,6 +4676,10 @@ interface ItemPrototype extends Prototype {
     icons?: IconData[];
     ingredient_to_weight_coefficient?: double;
     inventory_move_sound?: Sound;
+    /**
+     * Whether this item should be moved to the hub when space platform performs building, upgrade or deconstruction and is left with this item. The following items are considered valuable and moved to hub by default: {@link Modules | prototype:ModulePrototype}, {@link items that build entities | prototype:ItemPrototype::place_result}, {@link items that build tiles | prototype:ItemPrototype::place_as_tile} and items {@link not obtainable from asteroid chunks | prototype:AsteroidChunkPrototype::minable} that have {@link subgroup | prototype:PrototypeBase::subgroup} from a {@link group | prototype:ItemSubGroup::group} other than `"intermediate-products"`.
+     */
+    moved_to_hub_when_building?: boolean;
     open_sound?: Sound;
     pick_sound?: Sound;
     /**
@@ -4697,7 +4710,7 @@ interface ItemPrototype extends Prototype {
      *
      * When "manual" is set, it can only be launched by pressing the launch button in the rocket silo.
      *
-     * When "automated" is set, it will force the existence of "launch to orbit automatically" checkBox in the rocket silo which will then force the silo to automatically send the item to orbit when present.
+     * When "automated" is set, it will force the existence of "launch to orbit automatically" checkbox in the rocket silo which will then force the silo to automatically send the item to orbit when present.
      */
     send_to_orbit_mode?: SendToOrbitMode;
     /**
@@ -4953,7 +4966,7 @@ interface LabPrototype extends EntityWithOwnerPrototype {
     on_animation?: Animation;
     researching_speed?: double;
     /**
-     * May not be 0. May not be larger than 100.
+     * May not be `0` or larger than `100`.
      */
     science_pack_drain_rate_percent?: uint8;
     trash_inventory_size?: ItemStackIndex;
@@ -5548,6 +5561,9 @@ interface MiningDrillPrototype extends EntityWithOwnerPrototype {
      * Note: Categories containing resources which produce items, fluids, or items+fluids may be combined on the same entity, but may not work as expected. Examples: Miner does not rotate fluid-resulting resources until depletion. Fluid isn't output (fluid resource change and fluidbox matches previous fluid). Miner with no `vector_to_place_result` can't output an item result and halts.
      */
     resource_categories: ResourceCategoryID[];
+    /**
+     * May not be `0` or larger than `100`.
+     */
     resource_drain_rate_percent?: uint8;
     /**
      * The distance from the centre of the mining drill to search for resources in.
@@ -8399,6 +8415,10 @@ interface SpiderVehiclePrototype extends VehiclePrototype {
  * The {@link spidertron remote | https://wiki.factorio.com/Spidertron_remote}. This remote can only be used for entities of type {@link SpiderVehiclePrototype | prototype:SpiderVehiclePrototype}.
  */
 interface SpidertronRemotePrototype extends SelectionToolPrototype {
+    /**
+     * Color mask for the icon. This is used to show the color of the spidertron remote LEDS in the GUI.
+     */
+    icon_color_indicator_mask?: FileName;
     /**
      * Count of items of the same name that can be stored in one inventory slot. Must be 1 when the `"not-stackable"` flag is set.
      * @example ```
@@ -9766,6 +9786,7 @@ interface UtilityConstants extends PrototypeBase {
     clear_cursor_volume_modifier: float;
     clipboard_history_size: uint32;
     color_filters?: ColorFilterData[];
+    construction_robots_use_busy_robots_queue: boolean;
     count_button_size: int32;
     daytime_color_lookup: DaytimeColorLookupTable;
     deconstruct_mark_tint: Color;
@@ -9890,6 +9911,7 @@ interface UtilityConstants extends PrototypeBase {
     lightning_attractor_protection_range_color: Color;
     logistic_gui_selected_network_highlight_tint: Color;
     logistic_gui_unselected_network_highlight_tint: Color;
+    logistic_robots_use_busy_robots_queue: boolean;
     low_energy_robot_estimate_multiplier: double;
     main_menu_background_image_location: FileName;
     main_menu_background_vignette_intensity: float;

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.50
+// Factorio version 2.0.52
 // API version 6
 
 declare namespace prototype {
@@ -3247,6 +3247,7 @@ interface CreateDecorativesTriggerEffectItem extends TriggerEffectItem {
     type: 'create-decorative';
 }
 interface CreateEntityTriggerEffectItemBase extends TriggerEffectItem {
+    abort_if_over_space?: boolean;
     /**
      * If true, creates the entity as a member of the enemy force. If the surface.no_enemies_mode is true, the entity will not be created.
      */
@@ -4652,10 +4653,7 @@ interface FluidEnergySource extends BaseEnergySource {
     smoke?: SmokeSource[];
     type: 'fluid';
 }
-type FluidFlowDirection = 'input-output' | 'input' | /**
- * ,
- */
-'output';
+type FluidFlowDirection = 'input-output' | 'input' | 'output';
 /**
  * The name of a {@link FluidPrototype | prototype:FluidPrototype}.
  * @example ```
@@ -8691,6 +8689,8 @@ interface SelectionModeData {
 }
 /**
  * An array containing the following values.
+ *
+ * Some flags only exclude objects from the selection, meaning they need to be combined with another flag to select anything.
  */
 type SelectionModeFlags = (/**
  * Selects entities and tiles as if selecting them for a blueprint.
@@ -8723,16 +8723,16 @@ type SelectionModeFlags = (/**
  * Selects all tiles.
  */
 'any-tile' | /**
- * Selects entities with the same force as the selecting player.
+ * Excludes entities that have a different force than the selecting player from the selection.
  */
 'same-force' | /**
- * Selects entities with a different force as the selecting player.
+ * Excludes entities that have the same force as the selecting player from the selection.
  */
 'not-same-force' | /**
- * Selects entities from a friendly force.
+ * Excludes entities that are not from a friendly force from the selection.
  */
 'friend' | /**
- * Selects entities from an enemy force.
+ * Excludes entities that are not from an enemy force from the selection.
  */
 'enemy' | /**
  * Selects entities as if selecting them for upgrading.
@@ -8753,9 +8753,12 @@ type SelectionModeFlags = (/**
  * Selects entities that are an {@link EntityWithOwnerPrototype | prototype:EntityWithOwnerPrototype}.
  */
 'entity-with-owner' | /**
- * Selects entities that are not a {@link RollingStockPrototype | prototype:RollingStockPrototype}.
+ * Excludes {@link RollingStockPrototype | prototype:RollingStockPrototype}s from the selection.
  */
-'avoid-rolling-stock' | 'avoid-vehicle' | 'controllable' | 'controllable-add' | 'controllable-remove' | /**
+'avoid-rolling-stock' | /**
+ * Excludes {@link VehiclePrototype | prototype:VehiclePrototype}s from the selection.
+ */
+'avoid-vehicle' | 'controllable' | 'controllable-add' | 'controllable-remove' | /**
  * Selects entities that are an {@link EntityGhostPrototype | prototype:EntityGhostPrototype}.
  */
 'entity-ghost' | /**
@@ -8792,16 +8795,16 @@ type SelectionModeFlags = (/**
  * Selects all tiles.
  */
 'any-tile' | /**
- * Selects entities with the same force as the selecting player.
+ * Excludes entities that have a different force than the selecting player from the selection.
  */
 'same-force' | /**
- * Selects entities with a different force as the selecting player.
+ * Excludes entities that have the same force as the selecting player from the selection.
  */
 'not-same-force' | /**
- * Selects entities from a friendly force.
+ * Excludes entities that are not from a friendly force from the selection.
  */
 'friend' | /**
- * Selects entities from an enemy force.
+ * Excludes entities that are not from an enemy force from the selection.
  */
 'enemy' | /**
  * Selects entities as if selecting them for upgrading.
@@ -8822,9 +8825,12 @@ type SelectionModeFlags = (/**
  * Selects entities that are an {@link EntityWithOwnerPrototype | prototype:EntityWithOwnerPrototype}.
  */
 'entity-with-owner' | /**
- * Selects entities that are not a {@link RollingStockPrototype | prototype:RollingStockPrototype}.
+ * Excludes {@link RollingStockPrototype | prototype:RollingStockPrototype}s from the selection.
+ */
+'avoid-rolling-stock' | /**
+ * Excludes {@link VehiclePrototype | prototype:VehiclePrototype}s from the selection.
  */
-'avoid-rolling-stock' | 'avoid-vehicle' | 'controllable' | 'controllable-add' | 'controllable-remove' | /**
+'avoid-vehicle' | 'controllable' | 'controllable-add' | 'controllable-remove' | /**
  * Selects entities that are an {@link EntityGhostPrototype | prototype:EntityGhostPrototype}.
  */
 'entity-ghost' | /**
@@ -10057,7 +10063,7 @@ interface StatelessVisualisation {
     /**
      * One of `nested_visualisations`, `animation` and `light` needs to be defined.
      */
-    nested_visualisations?: StatelessVisualisation | StatelessVisualisation[];
+    nested_visualisations?: StatelessVisualisations;
     offset_x?: RangedValue;
     offset_y?: RangedValue;
     offset_z?: RangedValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.35",
+  "version": "1.2.37",
   "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.50",
+  "factorioVersion": "2.0.52",
   "dependencies": {
     "lua-types": "^2.13.1"
   },