factorio-types 0.0.22 → 0.0.23

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.57
+// Factorio version 1.1.58
 // API version 2
 
 /**
@@ -160,9 +160,9 @@ interface LuaArithmeticCombinatorControlBehavior extends LuaCombinatorControlBeh
     readonly object_name: string
 
     /**
-     * The arithmetic combinator parameters.
+     * This arithmetic combinator's parameters.
      * @remarks
-     * `parameters` may be `nil` in order to clear the parameters.
+     * Writing `nil` clears the combinator's parameters.
      *
      */
     parameters: ArithmeticCombinatorParameters
@@ -819,12 +819,12 @@ interface LuaConstantCombinatorControlBehavior extends LuaControlBehavior {
     readonly object_name: string
 
     /**
-     * The constant combinator parameters
+     * This constant combinator's parameters, or `nil` if the {@link item_slot_count | LuaEntityPrototype::item_slot_count} of the combinator's prototype is `0`.
      * @remarks
-     * Setting to `nil` clears the parameters.
+     * Writing `nil` clears the combinator's parameters.
      *
      */
-    parameters: ConstantCombinatorParameters[]
+    parameters?: ConstantCombinatorParameters[]
 
     /**
      * The number of signals this constant combinator supports
@@ -977,7 +977,7 @@ interface LuaControl {
     get_main_inventory(this: void): void
 
     /**
-     * Gets the parameters of a personal logistic request and auto-trash slot.
+     * Gets the parameters of a personal logistic request and auto-trash slot. Only used on `spider-vehicle`.
      * @param slot_index - The slot to get.
      */
     get_personal_logistic_slot(this: void,
@@ -1073,7 +1073,7 @@ interface LuaControl {
         value: LogisticParameters): void
 
     /**
-     * Sets a vehicle logistic request and auto-trash slot to the given value. Only used on `spider-vehicule`s.
+     * Sets a vehicle logistic request and auto-trash slot to the given value. Only used on `spider-vehicle`.
      * @param slot_index - The slot to set.
      * @param value - The logistic request parameters.
      */
@@ -1673,9 +1673,9 @@ interface LuaDeciderCombinatorControlBehavior extends LuaCombinatorControlBehavi
     readonly object_name: string
 
     /**
-     * The decider combinator parameters
+     * This decider combinator's parameters.
      * @remarks
-     * Setting to `nil` clears the parameters.
+     * Writing `nil` clears the combinator's parameters.
      *
      */
     parameters: DeciderCombinatorParameters
@@ -10033,7 +10033,7 @@ interface LuaItemStack {
 
     /**
      * Set this item stack to another item stack.
-     * @param stack - Item stack to set this one to. Omitting this parameter or passing `nil` will clear this item stack, as if by calling [LuaItemStack::clear](LuaItemStack::clear).
+     * @param stack - Item stack to set it to. Omitting this parameter or passing `nil` will clear this item stack, as if [LuaItemStack::clear](LuaItemStack::clear) was called.
      */
     set_stack(this: void,
         stack?: ItemStackIdentification): void
@@ -14119,12 +14119,12 @@ interface LuaStyle {
     extra_left_padding_when_activated: number
 
     /**
-     * Sets extra_top/right/bottom/left_margin_when_activated to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
+     * Sets `extra_top/right/bottom/left_margin_when_activated` to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
      */
     extra_margin_when_activated: number | number[]
 
     /**
-     * Sets extra_top/right/bottom/left_padding_when_actived to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
+     * Sets `extra_top/right/bottom/left_padding_when_activated` to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
      */
     extra_padding_when_activated: number | number[]
 
@@ -14178,7 +14178,7 @@ interface LuaStyle {
     /**
      * Horizontal space between individual cells.
      * @remarks
-     * Applies to subclasses: LuaTableStyle,LuaFlowStyle,LuaHorizontalFlow
+     * Applies to subclasses: LuaTableStyle,LuaFlowStyle,LuaHorizontalFlowStyle
      *
      */
     horizontal_spacing: number

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.57
+// Factorio version 1.1.58
 // API version 2
 
 /**
@@ -1628,7 +1628,7 @@ interface ItemStackLocation {
  * 
  * 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.
  * 
- * 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 or boolean, which will be converted to their textual representation.
+ * 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
  * In the English translation, this will print `"No ammo"`; in the Czech translation, it will print `"Bez munice"`: 
  * ```
@@ -3342,7 +3342,7 @@ interface BaseAchievementPrototypeFilter {
 
 /**
  * @param filter - The condition to filter on. One of `"allowed-without-fight"`, `"type"`.
- * @param type - The prototype type
+ * @param type - The prototype type, or a list of acceptable types.
  */
 interface AchievementPrototypeFilterType extends BaseAchievementPrototypeFilter {
     /**
@@ -3350,9 +3350,9 @@ interface AchievementPrototypeFilterType extends BaseAchievementPrototypeFilter
      */
     'filter': 'type'
     /**
-     * The prototype type
+     * The prototype type, or a list of acceptable types.
      */
-    'type': string
+    'type': string | string[]
 }
 
 /**
@@ -3843,7 +3843,7 @@ interface EntityPrototypeFilterSelectionPriority extends BaseEntityPrototypeFilt
 
 /**
  * @param filter - The condition to filter on. One of `"flying-robot"`, `"robot-with-logistics-interface"`, `"rail"`, `"ghost"`, `"explosion"`, `"vehicle"`, `"crafting-machine"`, `"rolling-stock"`, `"turret"`, `"transport-belt-connectable"`, `"wall-connectable"`, `"buildable"`, `"placable-in-editor"`, `"clonable"`, `"selectable"`, `"hidden"`, `"entity-with-health"`, `"building"`, `"fast-replaceable"`, `"uses-direction"`, `"minable"`, `"circuit-connectable"`, `"autoplace"`, `"blueprintable"`, `"item-to-place"`, `"name"`, `"type"`, `"collision-mask"`, `"flag"`, `"build-base-evolution-requirement"`, `"selection-priority"`, `"emissions"`, `"crafting-category"`.
- * @param type - The prototype type
+ * @param type - The prototype type, or a list of acceptable types.
  */
 interface EntityPrototypeFilterType extends BaseEntityPrototypeFilter {
     /**
@@ -3851,9 +3851,9 @@ interface EntityPrototypeFilterType extends BaseEntityPrototypeFilter {
      */
     'filter': 'type'
     /**
-     * The prototype type
+     * The prototype type, or a list of acceptable types.
      */
-    'type': string
+    'type': string | string[]
 }
 
 /**
@@ -3883,7 +3883,7 @@ interface BaseEquipmentPrototypeFilter {
 
 /**
  * @param filter - The condition to filter on. One of `"item-to-place"`, `"type"`.
- * @param type - The prototype type
+ * @param type - The prototype type, or a list of acceptable types.
  */
 interface EquipmentPrototypeFilterType extends BaseEquipmentPrototypeFilter {
     /**
@@ -3891,9 +3891,9 @@ interface EquipmentPrototypeFilterType extends BaseEquipmentPrototypeFilter {
      */
     'filter': 'type'
     /**
-     * The prototype type
+     * The prototype type, or a list of acceptable types.
      */
-    'type': string
+    'type': string | string[]
 }
 
 /**
@@ -4415,7 +4415,7 @@ interface ItemPrototypeFilterSubgroup extends BaseItemPrototypeFilter {
 
 /**
  * @param filter - The condition to filter on. One of `"tool"`, `"mergeable"`, `"item-with-inventory"`, `"selection-tool"`, `"item-with-label"`, `"has-rocket-launch-products"`, `"fuel"`, `"place-result"`, `"burnt-result"`, `"place-as-tile"`, `"placed-as-equipment-result"`, `"name"`, `"type"`, `"flag"`, `"subgroup"`, `"fuel-category"`, `"stack-size"`, `"default-request-amount"`, `"wire-count"`, `"fuel-value"`, `"fuel-acceleration-multiplier"`, `"fuel-top-speed-multiplier"`, `"fuel-emissions-multiplier"`.
- * @param type - The prototype type
+ * @param type - The prototype type, or a list of acceptable types.
  */
 interface ItemPrototypeFilterType extends BaseItemPrototypeFilter {
     /**
@@ -4423,9 +4423,9 @@ interface ItemPrototypeFilterType extends BaseItemPrototypeFilter {
      */
     'filter': 'type'
     /**
-     * The prototype type
+     * The prototype type, or a list of acceptable types.
      */
-    'type': string
+    'type': string | string[]
 }
 
 /**
@@ -6224,7 +6224,7 @@ interface ModSettingPrototypeFilterMod extends BaseModSettingPrototypeFilter {
 
 /**
  * @param filter - The condition to filter on. One of `"type"`, `"mod"`, `"setting-type"`.
- * @param type - The setting scope type (startup, runtime-global, or runtime-per-user)
+ * @param type - The setting scope type (`"startup"`, `"runtime-global"`, or `"runtime-per-user"`)
  */
 interface ModSettingPrototypeFilterSettingType extends BaseModSettingPrototypeFilter {
     /**
@@ -6232,14 +6232,14 @@ interface ModSettingPrototypeFilterSettingType extends BaseModSettingPrototypeFi
      */
     'filter': 'setting-type'
     /**
-     * The setting scope type (startup, runtime-global, or runtime-per-user)
+     * The setting scope type (`"startup"`, `"runtime-global"`, or `"runtime-per-user"`)
      */
     'type': string
 }
 
 /**
  * @param filter - The condition to filter on. One of `"type"`, `"mod"`, `"setting-type"`.
- * @param type - The prototype type
+ * @param type - The prototype type, or a list of acceptable types.
  */
 interface ModSettingPrototypeFilterType extends BaseModSettingPrototypeFilter {
     /**
@@ -6247,9 +6247,9 @@ interface ModSettingPrototypeFilterType extends BaseModSettingPrototypeFilter {
      */
     'filter': 'type'
     /**
-     * The prototype type
+     * The prototype type, or a list of acceptable types.
      */
-    'type': string
+    'type': string | string[]
 }
 
 /**

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.57
+// Factorio version 1.1.58
 // API version 2
 
 declare namespace defines {
@@ -598,6 +598,7 @@ declare namespace defines {
         on_player_removed_equipment,
         on_player_repaired_entity,
         on_player_respawned,
+        on_player_reverse_selected_area,
         on_player_rotated_entity,
         on_player_selected_area,
         on_player_set_quick_bar_slot,
@@ -626,6 +627,7 @@ declare namespace defines {
         on_pre_script_inventory_resized,
         on_pre_surface_cleared,
         on_pre_surface_deleted,
+        on_research_cancelled,
         on_research_finished,
         on_research_reversed,
         on_research_started,
@@ -831,6 +833,7 @@ declare namespace defines {
         remove_train_station,
         reset_assembling_machine,
         reset_item,
+        reverse_select_area,
         rotate_entity,
         select_area,
         select_blueprint_entities,

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.57
+// Factorio version 1.1.58
 // API version 2
 
 /**
@@ -1484,6 +1484,35 @@ interface on_player_respawned extends event  {
      */
     player_port?: LuaEntity
 }
+/**
+ * Called after a player reverse-selects an area with a selection-tool item.
+ */
+interface on_player_reverse_selected_area extends event  {
+    /**
+     * The area selected.
+     */
+    area: BoundingBox
+    /**
+     * The entities selected.
+     */
+    entities: LuaEntity[]
+    /**
+     * The item used to select the area.
+     */
+    item: string
+    /**
+     * The player doing the selection.
+     */
+    player_index: number
+    /**
+     * The surface selected.
+     */
+    surface: LuaSurface
+    /**
+     * The tiles selected.
+     */
+    tiles: LuaTile[]
+}
 /**
  * Called when the player rotates an entity. This event is only fired when the entity actually changes its orientation -- pressing the rotate key on an entity that can't be rotated won't fire this event.
  */
@@ -1883,6 +1912,15 @@ interface on_pre_surface_cleared extends event  {
 interface on_pre_surface_deleted extends event  {
     surface_index: number
 }
+/**
+ * Called when research is cancelled.
+ */
+interface on_research_cancelled extends event  {
+    /**
+     * A mapping of technology name to how many times it was cancelled.
+     */
+    research: {[key: string]: number}
+}
 /**
  * Called when a research finishes.
  */

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.57
+// Factorio version 1.1.58
 // API version 2
 
 /**

package/package.json

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