factorio-types 1.2.24 → 1.2.25

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.33
+// Factorio version 2.0.37
 // API version 6
 
 declare namespace runtime {
@@ -16,6 +16,10 @@ end)
 ```
  */
 interface CustomInputEvent {
+    /**
+     * Cursor direction.
+     */
+    cursor_direction?: defines.direction;
     /**
      * The mouse cursor display location when the custom input was activated.
      */
@@ -224,6 +228,24 @@ interface on_cancelled_upgrade {
      */
     tick: uint;
 }
+/**
+ * Called after a cargo pod has delivered its cargo.
+ */
+interface on_cargo_pod_delivered_cargo {
+    cargo_pod: LuaEntity;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The spawned container if any. Created when destination type is {@link surface | runtime:defines.cargo_destination.surface}.
+     */
+    spawned_container?: LuaEntity;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
 /**
  * Called when a cargo pod departs a surface.
  */
@@ -238,7 +260,29 @@ interface on_cargo_pod_finished_ascending {
      */
     name: defines.events;
     /**
-     * The player that is riding the rocket, if any.
+     * The player that is riding the cargo pod, if any.
+     */
+    player_index?: uint;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
+/**
+ * Called when a cargo pods lands on a surface, either at a station or on the ground.
+ */
+interface on_cargo_pod_finished_descending {
+    cargo_pod: LuaEntity;
+    /**
+     * True for pods spawned on a rocket.
+     */
+    launched_by_rocket: boolean;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The player that is riding the cargo pod, if any.
      */
     player_index?: uint;
     /**
@@ -1421,6 +1465,19 @@ interface on_mod_item_opened {
      */
     tick: uint;
 }
+/**
+ * Called when {@link LuaGameScript::is_multiplayer | runtime:LuaGameScript::is_multiplayer} changes to true. May also be raised when it was already true but a game was loaded from a save file and with hosting.
+ */
+interface on_multiplayer_init {
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
 /**
  * Called after an object is destroyed which was registered with {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed} previously.
  *
@@ -2008,6 +2065,10 @@ interface on_player_deconstructed_area {
      * The item quality used to select the area.
      */
     quality: string;
+    /**
+     * The record that was used to select the area.
+     */
+    record?: LuaRecord;
     /**
      * The item stack used to select the area.
      */
@@ -2742,6 +2803,10 @@ interface on_player_setup_blueprint {
      * The item quality used to select the area.
      */
     quality: string;
+    /**
+     * The record that is being reassigned.
+     */
+    record?: LuaRecord;
     /**
      * The item stack used to select the area.
      */
@@ -3840,6 +3905,19 @@ interface on_selected_entity_changed {
      */
     tick: uint;
 }
+/**
+ * Called when {@link LuaGameScript::is_multiplayer | runtime:LuaGameScript::is_multiplayer} changes to false. May also be raised when it was already false but a game was loaded from a save file without hosting.
+ */
+interface on_singleplayer_init {
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
 /**
  * Called when a space platform builds an entity.
  */

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.33
+// Factorio version 2.0.37
 // 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.33
+// Factorio version 2.0.37
 // API version 6
 
 declare namespace prototype {
@@ -813,6 +813,12 @@ interface AssemblingMachinePrototype extends CraftingMachinePrototype {
         CircuitConnectorDefinition,
         CircuitConnectorDefinition
     ];
+    circuit_connector_flipped?: [
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition
+    ];
     /**
      * The maximum circuit wire distance for this entity.
      */
@@ -844,7 +850,8 @@ interface AssemblingMachinePrototype extends CraftingMachinePrototype {
      *
      * This only counts item ingredients, not fluid ingredients! This means if ingredient count is 2, and the recipe has 2 item ingredients and 1 fluid ingredient, it can still be crafted in the machine.
      */
-    ingredient_count?: uint8;
+    ingredient_count?: uint16;
+    max_item_product_count?: uint16;
 }
 interface AsteroidChunkPrototype extends Prototype {
     dying_trigger_effect?: TriggerEffect;
@@ -1023,7 +1030,7 @@ interface BeaconPrototype extends EntityWithOwnerPrototype {
     /**
      * The maximum distance that this beacon can supply its neighbors with its module's effects. Max distance is 64.
      */
-    supply_area_distance: double;
+    supply_area_distance: uint32;
 }
 /**
  * Used as a laser beam.
@@ -3209,7 +3216,7 @@ interface EntityPrototype extends Prototype {
     /**
      * May also be defined inside `graphics_set` instead of directly in the entity prototype. This is useful for entities that use a `graphics_set` property to define their graphics, because then all graphics can be defined in one place.
      *
-     * {@link Currently only renders | https://forums.factorio.com/100703} for {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype}.
+     * {@link Currently only renders | https://forums.factorio.com/100703} for {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype} and {@link CorpsePrototype | prototype:CorpsePrototype}.
      */
     water_reflection?: WaterReflectionDefinition;
     /**
@@ -3322,7 +3329,7 @@ interface EntityWithHealthPrototype extends EntityPrototype {
     {
       {
         type = "fire",
-          percent = 80
+        percent = 80
       },
       {
         type = "explosion",
@@ -3349,6 +3356,10 @@ interface EntityWithOwnerPrototype extends EntityWithHealthPrototype {
      * The default scale is based on the tile distance of the shorter dimension. Where size 3 results into scale 1. The default minimum is 0.5 and maximum 1.0.
      */
     quality_indicator_scale?: double;
+    /**
+     * The shift from the bottom left corner of the selection box.
+     */
+    quality_indicator_shift?: Vector;
 }
 /**
  * This prototype is used for receiving an achievement when the player equips armor.
@@ -3940,10 +3951,30 @@ interface FurnacePrototype extends CraftingMachinePrototype {
      * The locale key is also used with an `_until` suffix for items that cannot be processed until they recipe is unlocked by a technology.
      */
     cant_insert_at_source_message_key?: string;
+    circuit_connector?: [
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition
+    ];
+    circuit_connector_flipped?: [
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition,
+        CircuitConnectorDefinition
+    ];
+    /**
+     * The maximum circuit wire distance for this entity.
+     */
+    circuit_wire_max_distance?: double;
     /**
      * The locale key of the tooltip to be shown in the input slot instead of the automatically generated list of items that fit there
      */
     custom_input_slot_tooltip_key?: string;
+    default_recipe_finished_signal?: SignalIDConnector;
+    default_working_signal?: SignalIDConnector;
+    draw_circuit_wires?: bool;
+    draw_copper_wires?: bool;
     /**
      * The number of output slots.
      */
@@ -4598,6 +4629,8 @@ interface ItemPrototype extends Prototype {
     stack_size: ItemCountType;
     /**
      * The default weight is calculated automatically from recipes and falls back to {@link UtilityConstants::default_item_weight | prototype:UtilityConstants::default_item_weight}.
+     *
+     * More information on how item weight is determined can be found on its {@link auxiliary page | runtime:item-weight}.
      */
     weight?: Weight;
 }
@@ -5125,6 +5158,10 @@ interface Loader1x2Prototype extends LoaderPrototype {
  * Continuously loads and unloads machines, as an alternative to inserters.
  */
 interface LoaderPrototype extends TransportBeltConnectablePrototype {
+    /**
+     * Loader belt stack size can be adjusted at runtime. Requires {@link LoaderPrototype::max_belt_stack_size | prototype:LoaderPrototype::max_belt_stack_size} to be > 1.
+     */
+    adjustable_belt_stack_size?: boolean;
     /**
      * Whether this loader can load and unload stationary inventories such as containers and crafting machines.
      */
@@ -6598,14 +6635,16 @@ interface RecipePrototype extends Prototype {
      * Duplicate ingredients, e.g. two entries with the same name, are *not* allowed. In-game, the item ingredients are ordered by {@link ItemGroup::order_in_recipe | prototype:ItemGroup::order_in_recipe}.
      * @example ```
     -- Recipe with items
-    ingredients = {
+    ingredients =
+    {
       {type = "item", name = "iron-stick", amount = 2},
       {type = "item", name = "iron-plate", amount = 3}
     }
     ```
      * @example ```
     -- Recipe with fluids
-    ingredients = {
+    ingredients =
+    {
       {type="fluid", name="water", amount=50},
       {type="fluid", name="crude-oil", amount=100}
     }
@@ -6639,14 +6678,16 @@ interface RecipePrototype extends Prototype {
      *
      * Can be set to an empty table to create a recipe that produces nothing. Duplicate results, e.g. two entries with the same name, are allowed.
      * @example ```
-    results = {
+    results =
+    {
       {type="fluid", name="heavy-oil", amount=3},
       {type="fluid", name="light-oil", amount=3},
       {type="fluid", name="petroleum-gas", amount=4}
     }
     ```
      * @example ```
-    results = {
+    results =
+    {
       {type = "item", name = "iron-nuggets", amount = 9},
       {type = "item", name = "gold-nuggets", amount = 1}
     }
@@ -7266,7 +7307,6 @@ interface RocketSiloPrototype extends AssemblingMachinePrototype {
      */
     rocket_rising_delay?: uint8;
     rocket_shadow_overlay_sprite?: Sprite;
-    rocket_supply_inventory_size?: ItemStackIndex;
     satellite_animation?: Animation;
     satellite_shadow_animation?: Animation;
     shadow_sprite?: Sprite;
@@ -9659,6 +9699,7 @@ interface UtilityConstants extends PrototypeBase {
     gui_remark_color: Color;
     gui_search_match_background_color: Color;
     gui_search_match_foreground_color: Color;
+    huge_animation_sound_area: float;
     icon_shadow_color: Color;
     icon_shadow_inset: float;
     icon_shadow_radius: 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.33
+// Factorio version 2.0.37
 // API version 6
 
 declare namespace prototype {
@@ -405,7 +405,8 @@ frame_sequence = { 2, 2, 2, 2, 2, 4, 3, 4, 3 }
  * @example ```
 -- Complex example - animation contains different layers with different frame counts:
 local custom_frame_sequence = { 2, 2, 2, 2, 2, 4, 3, 4, 3 }
-layers = {
+layers =
+{
   {
     -- Animation with custom frame sequence
     frame_count = 4,
@@ -1622,6 +1623,10 @@ interface BaseAttackParameters {
      * Played once at the start of the attack if these are {@link ProjectileAttackParameters | prototype:ProjectileAttackParameters}.
      */
     sound?: LayeredSound;
+    /**
+     * Projectile will be creation position and orientation will be collinear with shooter and target (unless offset projectile center is specified). Used for railgun turrets to avoid unexpected friendly fire incidents.
+     */
+    true_collinear_ejection?: bool;
     /**
      * If this is <= 0, it is set to 1. Arc from 0 to 1, so for example 0.25 is 90°. Used by the {@link flamethrower turret | https://wiki.factorio.com/Flamethrower_turret} in the base game. Arcs greater than 0.5 but less than 1 will be clamped to 0.5 as targeting in arcs larger than half circle is {@link not implemented | https://forums.factorio.com/94654}.
      */
@@ -5181,7 +5186,7 @@ interface HorizontalScrollBarStyleSpecification extends ScrollBarStyleSpecificat
  *
  * - When the final icon is displayed with a shadow (e.g. an item on the ground or on a belt when item shadows are turned on), each icon layer will {@link cast a shadow | https://forums.factorio.com/84888} and the shadow is cast on the layer below it.
  *
- * - The final icon will always be resized and centered in GUI so that all its layers fit the target slot, but won't be resized when displayed on machines in alt-mode. For example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings.
+ * - The final icon will always be resized and centered in GUI so that all its layers (except the {@link `floating` | prototype:IconData::floating} ones) fit the target slot, but won't be resized when displayed on machines in alt-mode. For example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings.
  *
  * - Shift values are based on {@link `expected_icon_size / 2` | prototype:IconData::scale}.
  *
@@ -5197,7 +5202,8 @@ interface HorizontalScrollBarStyleSpecification extends ScrollBarStyleSpecificat
 ```
  * @example ```
 -- Layered icon, with size defined per layer
-icons = {
+icons =
+{
   {
     icon = "__base__/graphics/icons/fluid/barreling/barrel-empty.png",
     icon_size = 32
@@ -5223,9 +5229,13 @@ icons = {
  */
 interface IconData {
     /**
-     * Outline is drawn using signed distance field generated on load.One icon image, will have only one SDF generated. But if the image is used in multiple icon with different scales, outline width won't match the desired width in all the scales but the largest one.
+     * Outline is drawn using signed distance field generated on load. One icon image, will have only one SDF generated. But if the image is used in multiple icon with different scales, outline width won't match the desired width in all the scales but the largest one.
      */
     draw_background?: bool;
+    /**
+     * When `true` the layer is not considered for calculating bounds of the icon, so it can go out of bounds of rectangle into which the icon is drawn in GUI.
+     */
+    floating?: bool;
     /**
      * Path to the icon file.
      */
@@ -5290,7 +5300,8 @@ interface IconSequencePositioning {
 }
 /**
  * @example ```
-data.raw["gui-style"]["default"]["stretchy-sprite"] = {
+data.raw["gui-style"]["default"]["stretchy-sprite"] =
+{
   type = "image_style",
   vertically_stretchable = "on",
   horizontally_stretchable = "on",
@@ -5945,11 +5956,16 @@ interface MainSound {
     play_for_working_visualisations?: string[];
     /**
      * Modifies how often the sound is played.
+     *
+     * Silently clamped to the [0.0, 1.0] range.
      * @example ```
     probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds
     ```
      */
     probability?: double;
+    /**
+     * Cannot be empty.
+     */
     sound?: Sound;
     /**
      * Only used if {@link WorkingSound::persistent | prototype:WorkingSound::persistent} is `true`.
@@ -6294,7 +6310,8 @@ interface MaximumFollowingRobotsCountModifier extends SimpleModifier {
 minable = { mining_time = 0.55, result = "wood", count = 4, mining_particle = "wooden-particle" }
 ```
  * @example ```
-minable = {
+minable =
+{
   mining_time = 1,
   results =
   {
@@ -7235,6 +7252,10 @@ interface PlumesSpecification {
     max_y_offset?: float;
     min_probability?: float;
     min_y_offset?: float;
+    /**
+     * If given, the plumes will only render if this area is on screen (relative to the thruster)
+     */
+    render_box?: BoundingBox;
     /**
      * Array may not be empty and may at most have 255 elements.
      *
@@ -7717,11 +7738,19 @@ interface ProgrammableSpeakerInstrument {
     notes: ProgrammableSpeakerNote[];
 }
 interface ProgrammableSpeakerNote {
+    /**
+     * Cannot contain aggregations.
+     *
+     * One of `sound` or `cyclic_sound` must be defined. Both cannot be defined together.
+     */
+    cyclic_sound?: CyclicSound;
     name: string;
     /**
      * Cannot contain aggregation.
+     *
+     * One of `sound` or `cyclic_sound` must be defined. Both cannot be defined together.
      */
-    sound: Sound;
+    sound?: Sound;
 }
 interface ProgressBarStyleSpecification extends BaseStyleSpecification {
     bar?: ElementImageSet;
@@ -7835,40 +7864,45 @@ interface PuddleTileEffectParameters {
  * @example ```
 load_animations =
 {
-west = {
-  [1] = {
-    standup_base = {
-      filename = "__base__/graphics/entity/pump/connector/V-R-135-load-standup-base.png",
-      width = 110,
-      height = 126,
-      scale = 0.5,
-      line_length = 1,
-      frame_count = 20,
-      shift = util.by_pixel(-23.5, -13.5)
+  west =
+  {
+    [1] =
+    {
+      standup_base =
+      {
+        filename = "__base__/graphics/entity/pump/connector/V-R-135-load-standup-base.png",
+        width = 110,
+        height = 126,
+        scale = 0.5,
+        line_length = 1,
+        frame_count = 20,
+        shift = util.by_pixel(-23.5, -13.5)
+      },
+      standup_shadow =
+      {
+        filename = "__base__/graphics/entity/pump/connector/V-R-1-load-standup-base-shadow.png",
+        width = 157,
+        height = 136,
+        scale = 0.5,
+        line_length = 1,
+        frame_count = 20,
+        shift = util.by_pixel(-8.75, 8.5)
+      },
     },
-    standup_shadow = {
-      filename = "__base__/graphics/entity/pump/connector/V-R-1-load-standup-base-shadow.png",
-      width = 157,
-      height = 136,
-      scale = 0.5,
-      line_length = 1,
-      frame_count = 20,
-      shift = util.by_pixel(-8.75, 8.5)
+    [2] =
+    {
+      standup_base = { ... },
+      standup_shadow = { ... },
+      connector_shadow = { ... },
     },
+    [3] = { ... },
+    [4] = { ... },
+    [5] = { ... },
+    [6] = { ... },
   },
-  [2] = {
-    standup_base = { ... },
-    standup_shadow = { ... },
-    connector_shadow = { ... },
-  },
-  [3] = { ... },
-  [4] = { ... },
-  [5] = { ... },
-  [6] = { ... },
-},
-north = { ... },
-east = { ... },
-south = { ... },
+  north = { ... },
+  east = { ... },
+  south = { ... },
 }
 ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.24",
+  "version": "1.2.25",
   "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.33",
+  "factorioVersion": "2.0.37",
   "dependencies": {
     "lua-types": "^2.13.1"
   },