factorio-types 1.2.69 → 1.2.71

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.20
5
+ // Factorio version 2.1.22
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
@@ -83,6 +83,8 @@ interface AccumulatorPrototype extends EntityWithOwnerPrototype {
83
83
  draw_copper_wires?: boolean;
84
84
  /**
85
85
  * The capacity of the energy source buffer specifies the capacity of the accumulator.
86
+ *
87
+ * Any {@link usage_priority | prototype:ElectricEnergySource::usage_priority} set here will be ignored, accumulators always have the "managed-accumulator" usage priority.
86
88
  */
87
89
  energy_source: ElectricEnergySource;
88
90
  }
@@ -953,6 +955,11 @@ interface AssemblingMachinePrototype extends CraftingMachinePrototype {
953
955
  * The preset recipe of this machine. This machine does not show a recipe selection if this is set. The base game uses this for the {@link rocket silo | https://wiki.factorio.com/Rocket_silo}.
954
956
  */
955
957
  fixed_recipe?: RecipeID;
958
+ /**
959
+ * Whether the {@link fluid boxes | prototype:CraftingMachinePrototype::fluid_boxes} are disabled when this assembling machine has no recipe set.
960
+ *
961
+ * If a recipe is set, this property does not affect fluidbox behavior. Instead, whether fluidboxes are enabled depends on whether the recipe needs them, e.g. if a recipe without fluid ingredients is set, the input fluidboxes will be disabled.
962
+ */
956
963
  fluid_boxes_off_when_no_fluid_recipe?: boolean;
957
964
  /**
958
965
  * The locale key of the title of the recipe selection GUI that is shown when the player opens the assembling machine. May not be longer than 200 characters.
@@ -1231,6 +1238,10 @@ interface BlueprintItemPrototype extends SelectionToolPrototype {
1231
1238
  * This property is hardcoded to `false`.
1232
1239
  */
1233
1240
  always_include_tiles?: boolean;
1241
+ /**
1242
+ * Tints of the building preview when this blueprint is held in the cursor. Every property is optional here, any that are not given use the color from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
1243
+ */
1244
+ build_preview_tints?: BuildPreviewTints;
1234
1245
  /**
1235
1246
  * Whether the item will draw its label when held in the cursor in place of the item count.
1236
1247
  */
@@ -1287,6 +1298,14 @@ interface BoilerPrototype extends EntityWithOwnerPrototype {
1287
1298
  * If `mode` is `"heat-fluid-inside"`, the fluid is heated up directly in this fluidbox.
1288
1299
  */
1289
1300
  fluid_box: FluidBox;
1301
+ /**
1302
+ * If specified, an input fluid above this temperature will cause the boiler to stop working.
1303
+ */
1304
+ maximum_input_temperature?: float;
1305
+ /**
1306
+ * If specified, an input fluid below this temperature will cause the boiler to stop working.
1307
+ */
1308
+ minimum_input_temperature?: float;
1290
1309
  /**
1291
1310
  * In the `"output-to-separate-pipe"` mode, fluid is transferred from the `fluid_box` to the `output_fluid_box` when enough energy is available to {@link heat | prototype:FluidPrototype::heat_capacity} the input fluid to the `target_temperature`. Setting a filter on the `output_fluid_box` means that instead of the heated input fluid getting moved to the output, it is converted to the filtered fluid in a ratio based on the heat capacity of the fluids: `output_fluid_amount = input_fluid_amount * (input_fluid_heat_capacity / output_fluid_heat_capacity)`
1292
1311
  *
@@ -1303,7 +1322,7 @@ interface BoilerPrototype extends EntityWithOwnerPrototype {
1303
1322
  output_fluid_box: FluidBox;
1304
1323
  pictures?: BoilerPictureSet;
1305
1324
  /**
1306
- * Only loaded, and mandatory if `mode` is `"output-to-separate-pipe"`. This is the temperature that the input fluid must reach to be moved to the output fluid box.
1325
+ * Only loaded, and mandatory if `mode` is `"output-to-separate-pipe"`. The boiler heats the input fluid to exactly this temperature and moves the fluid to the output fluid box. An input fluid above this temperature will cause the boiler to stop working.
1307
1326
  */
1308
1327
  target_temperature?: float;
1309
1328
  }
@@ -1519,6 +1538,7 @@ interface CargoLandingPadPrototype extends EntityWithOwnerPrototype {
1519
1538
  * The maximum circuit wire distance for this entity.
1520
1539
  */
1521
1540
  circuit_wire_max_distance?: double;
1541
+ default_empty_slots_signal?: SignalIDConnector;
1522
1542
  draw_circuit_wires?: boolean;
1523
1543
  draw_copper_wires?: boolean;
1524
1544
  graphics_set?: CargoBayConnectableGraphicsSet;
@@ -1980,6 +2000,7 @@ interface ContainerPrototype extends EntityWithOwnerPrototype {
1980
2000
  * The maximum circuit wire distance for this container.
1981
2001
  */
1982
2002
  circuit_wire_max_distance?: double;
2003
+ default_empty_slots_signal?: SignalIDConnector;
1983
2004
  default_status?: EntityStatus;
1984
2005
  /**
1985
2006
  * Amount of directions this container should have. Allowed values are 1, 2 and 4.
@@ -2125,6 +2146,10 @@ interface CraftingMachinePrototype extends EntityWithOwnerPrototype {
2125
2146
  * Sets the {@link module categories | prototype:ModuleCategory} that are allowed to be inserted into this machine.
2126
2147
  */
2127
2148
  allowed_module_categories?: ModuleCategoryID[];
2149
+ /**
2150
+ * If true the starting frame will be randomized upon placement.
2151
+ */
2152
+ animation_random_start_frame?: boolean;
2128
2153
  /**
2129
2154
  * A list of {@link recipe categories | prototype:RecipeCategory} this crafting machine can use.
2130
2155
  * @example ```
@@ -4076,7 +4101,7 @@ interface FluidPrototype extends Prototype {
4076
4101
  */
4077
4102
  default_temperature: float;
4078
4103
  /**
4079
- * Whether the fluid should glow in pipe and storage tank windows.
4104
+ * Whether the fluid should glow in pipe and storage tank windows. The glow is only drawn when the {@link expansion_shaders | prototype:FeatureFlags::expansion_shaders} feature flag is enabled.
4080
4105
  */
4081
4106
  draw_as_glow?: boolean;
4082
4107
  /**
@@ -4253,10 +4278,18 @@ interface FluidTurretPrototype extends TurretPrototype {
4253
4278
  interface FluidWagonPrototype extends RollingStockPrototype {
4254
4279
  /**
4255
4280
  * Horizontal (xy) offset of the central valve from the wagon position when it is oriented east/west.
4281
+ *
4282
+ * For all directions, the elliptical interpolation for the offset is performed based on both `base_valve_xy_offset_when_horizontal` and `base_valve_xy_offset_when_vertical` and the tangential and normal are calculated separately.
4283
+ *
4284
+ * The tangential component of the offset is interpolated from values `base_valve_xy_offset_when_horizontal.x` and `base_valve_xy_offset_when_vertical.y`. The normal component of the offset is interpolated from values `base_valve_xy_offset_when_vertical.x` and `base_valve_xy_offset_when_horizontal.y`.
4285
+ *
4286
+ * Interpolating the components with one value non-zero and the other zero would produce undesirable behaviour and is therefore not allowed.
4256
4287
  */
4257
4288
  base_valve_xy_offset_when_horizontal?: Vector;
4258
4289
  /**
4259
4290
  * Horizontal (xy) offset of the central valve from the wagon position when it is oriented north/south.
4291
+ *
4292
+ * See `base_valve_xy_offset_when_horizontal` for how this value is used in the offset calculation.
4260
4293
  */
4261
4294
  base_valve_xy_offset_when_vertical?: Vector;
4262
4295
  /**
@@ -4283,10 +4316,18 @@ interface FluidWagonPrototype extends RollingStockPrototype {
4283
4316
  tank_spacing?: float;
4284
4317
  /**
4285
4318
  * Projected offset between valves when the wagon is oriented east/west.
4319
+ *
4320
+ * For all directions, the elliptical interpolation for the offset is performed based on both `valve_to_valve_offset_when_horizontal` and `valve_to_valve_offset_when_vertical` and the tangential and normal are calculated separately.
4321
+ *
4322
+ * The tangential component of the offset is interpolated from values `valve_to_valve_offset_when_horizontal.x` and `valve_to_valve_offset_when_vertical.y`. The normal component of the offset is interpolated from values `valve_to_valve_offset_when_vertical.x` and `valve_to_valve_offset_when_horizontal.y`.
4323
+ *
4324
+ * Interpolating the components with one value non-zero and the other zero would produce undesirable behaviour and is therefore not allowed.
4286
4325
  */
4287
4326
  valve_to_valve_offset_when_horizontal?: Vector;
4288
4327
  /**
4289
4328
  * Projected offset between valves when the wagon is oriented north/south.
4329
+ *
4330
+ * See `valve_to_valve_offset_when_horizontal` for how this value is used in the offset calculation.
4290
4331
  */
4291
4332
  valve_to_valve_offset_when_vertical?: Vector;
4292
4333
  }
@@ -4481,6 +4522,14 @@ interface FusionGeneratorPrototype extends EntityWithOwnerPrototype {
4481
4522
  * Must be positive.
4482
4523
  */
4483
4524
  max_fluid_usage: FluidAmount;
4525
+ /**
4526
+ * If specified, an input fluid above this temperature will cause the fusion generator to stop working.
4527
+ */
4528
+ maximum_input_temperature?: float;
4529
+ /**
4530
+ * If specified, an input fluid below this temperature will cause the fusion generator to stop working.
4531
+ */
4532
+ minimum_input_temperature?: float;
4484
4533
  /**
4485
4534
  * {@link filter | prototype:FluidBox::filter} is mandatory.
4486
4535
  */
@@ -4515,6 +4564,14 @@ interface FusionReactorPrototype extends EntityWithOwnerPrototype {
4515
4564
  * Must be positive.
4516
4565
  */
4517
4566
  max_fluid_usage: FluidAmount;
4567
+ /**
4568
+ * If specified, an input fluid above this temperature will cause the fusion reactor to stop working.
4569
+ */
4570
+ maximum_input_temperature?: float;
4571
+ /**
4572
+ * If specified, an input fluid below this temperature will cause the fusion reactor to stop working.
4573
+ */
4574
+ minimum_input_temperature?: float;
4518
4575
  neighbour_bonus?: float;
4519
4576
  /**
4520
4577
  * Defines connection points to neighbours used to compute neighbour bonus.
@@ -4628,12 +4685,20 @@ interface GeneratorPrototype extends EntityWithOwnerPrototype {
4628
4685
  * `fluid_box` must have a filter if this is not defined.
4629
4686
  */
4630
4687
  max_power_output?: Energy;
4688
+ /**
4689
+ * If specified, an input fluid above this temperature will cause the generator to stop working.
4690
+ */
4691
+ maximum_input_temperature?: float;
4631
4692
  /**
4632
4693
  * The maximum temperature to which the efficiency can increase. At this temperature the generator will run at 100% efficiency. Note: Higher temperature fluid can still be consumed.
4633
4694
  *
4634
4695
  * Used to calculate the `max_power_output` if it is not defined and `burns_fluid` is false. Then, the max power output is `(min(fluid_max_temp, maximum_temperature) - fluid_default_temp) × fluid_usage_per_tick × fluid_heat_capacity × effectivity`, the fluid is the filter specified on the `fluid_box`.
4635
4696
  */
4636
4697
  maximum_temperature: float;
4698
+ /**
4699
+ * If specified, an input fluid below this temperature will cause the generator to stop working.
4700
+ */
4701
+ minimum_input_temperature?: float;
4637
4702
  output_fluid_box?: FluidBox;
4638
4703
  /**
4639
4704
  * Affects animation speed and working sound.
@@ -5596,6 +5661,8 @@ interface LampPrototype extends EntityWithOwnerPrototype {
5596
5661
  draw_copper_wires?: boolean;
5597
5662
  /**
5598
5663
  * The emissions set on the energy source are ignored so lamps cannot produce pollution.
5664
+ *
5665
+ * If this is an electric energy source, any {@link usage_priority | prototype:ElectricEnergySource::usage_priority} set here will be ignored, lamps always have the "lamp" usage priority.
5599
5666
  */
5600
5667
  energy_source: ElectricEnergySource | VoidEnergySource;
5601
5668
  /**
@@ -5773,6 +5840,7 @@ interface LinkedContainerPrototype extends EntityWithOwnerPrototype {
5773
5840
  * The maximum circuit wire distance for this linked container.
5774
5841
  */
5775
5842
  circuit_wire_max_distance?: double;
5843
+ default_empty_slots_signal?: SignalIDConnector;
5776
5844
  draw_circuit_wires?: boolean;
5777
5845
  draw_copper_wires?: boolean;
5778
5846
  /**
@@ -6087,10 +6155,18 @@ interface MiningDrillPrototype extends EntityWithOwnerPrototype {
6087
6155
  graphics_set?: MiningDrillGraphicsSet;
6088
6156
  graphics_set_flipped?: MiningDrillGraphicsSet;
6089
6157
  input_fluid_box?: FluidBox;
6158
+ /**
6159
+ * Only loaded if `input_fluid_box` is defined. If specified, an input fluid above this temperature will cause the mining drill to stop working.
6160
+ */
6161
+ maximum_input_temperature?: float;
6090
6162
  /**
6091
6163
  * When a save file from version 2.0.x or older is loaded and this property is `true`, entities facing east or west direction are migrated to flipped state.
6092
6164
  */
6093
6165
  migrate_horizontal_mirroring?: boolean;
6166
+ /**
6167
+ * Only loaded if `input_fluid_box` is defined. If specified, an input fluid below this temperature will cause the mining drill to stop working.
6168
+ */
6169
+ minimum_input_temperature?: float;
6094
6170
  /**
6095
6171
  * The speed of this drill.
6096
6172
  */
@@ -6411,11 +6487,15 @@ interface NightVisionEquipmentPrototype extends EquipmentPrototype {
6411
6487
  activate_sound?: Sound;
6412
6488
  color_lookup: DaytimeColorLookupTable;
6413
6489
  /**
6414
- * Must be >= 0 and <= 1.
6490
+ * Must be >= 0 and <= 1. By default, this equipment turns on when `surface_darkness >= darkness_to_turn_on`.
6415
6491
  */
6416
6492
  darkness_to_turn_on?: float;
6417
6493
  deactivate_sound?: Sound;
6418
6494
  energy_input: Energy;
6495
+ /**
6496
+ * If `true`, this equipment turns on when `surface_darkness <= darkness_to_turn_on`.
6497
+ */
6498
+ sunglasses?: boolean;
6419
6499
  }
6420
6500
  /**
6421
6501
  * An {@link offshore pump | https://wiki.factorio.com/Offshore_pump}.
@@ -6924,18 +7004,26 @@ interface PrototypeBase {
6924
7004
  * A container that must be set to point at other entity and inventory index so it can forward all inventory interactions to the other entity.
6925
7005
  */
6926
7006
  interface ProxyContainerPrototype extends EntityWithOwnerPrototype {
6927
- circuit_connector?: CircuitConnectorDefinition;
7007
+ /**
7008
+ * If given, there must be exactly `direction_count` elements in the table.
7009
+ */
7010
+ circuit_connector?: CircuitConnectorDefinition[];
6928
7011
  /**
6929
7012
  * The maximum circuit wire distance for this entity.
6930
7013
  */
6931
7014
  circuit_wire_max_distance?: double;
7015
+ default_empty_slots_signal?: SignalIDConnector;
7016
+ /**
7017
+ * Amount of directions this container should have. Allowed values are 1, 2 and 4.
7018
+ */
7019
+ direction_count?: uint8;
6932
7020
  draw_circuit_wires?: boolean;
6933
7021
  draw_copper_wires?: boolean;
6934
7022
  /**
6935
7023
  * If the content of the inventory should be rendered in alt mode.
6936
7024
  */
6937
7025
  draw_inventory_content?: boolean;
6938
- picture?: Sprite;
7026
+ picture?: Sprite4Way;
6939
7027
  }
6940
7028
  /**
6941
7029
  * The pump is used to transfer fluids between tanks, fluid wagons and pipes.
@@ -7633,9 +7721,9 @@ interface RecipePrototype extends Prototype {
7633
7721
  */
7634
7722
  always_show_made_in?: boolean;
7635
7723
  /**
7636
- * Whether the recipe should be included in the recycling recipes automatically generated by the quality mod.
7724
+ * Whether the recipe should be included in the recycling recipes automatically generated by the recycler mod.
7637
7725
  *
7638
- * This property is not read by the game engine itself, but the quality mod's recycling.lua file. This means it is discarded by the game engine after loading finishes.
7726
+ * This property is not read by the game engine itself, but the recycler mod's recycling.lua file. This means it is discarded by the game engine after loading finishes.
7639
7727
  */
7640
7728
  auto_recycle?: boolean;
7641
7729
  /**
@@ -7765,6 +7853,12 @@ interface RecipePrototype extends Prototype {
7765
7853
  ```
7766
7854
  */
7767
7855
  raise_on_crafted?: boolean;
7856
+ /**
7857
+ * If set, this recipe's recycling recipe is generated by the recycler mod based on the ingredients of the given recipe, instead of this recipe's own ingredients.
7858
+ *
7859
+ * This property is not read by the game engine itself, but the recycler mod's recycling.lua file. This means it is discarded by the game engine after loading finishes.
7860
+ */
7861
+ recycle_to_ingredients_of?: RecipeID;
7768
7862
  requester_paste_multiplier?: uint32;
7769
7863
  /**
7770
7864
  * Whether enabling this recipe requires the ingredients be unlocked before the products are marked as unlocked.
@@ -7798,6 +7892,8 @@ interface RecipePrototype extends Prototype {
7798
7892
  results?: ProductPrototype[];
7799
7893
  /**
7800
7894
  * When set to `true`, item ingredients will be sorted based on {@link ItemGroup::order_in_recipe | prototype:ItemGroup::order_in_recipe}.
7895
+ *
7896
+ * Otherwise, the item ingredients appear in the order that they are defined in the prototype.
7801
7897
  */
7802
7898
  sort_item_ingredients?: boolean;
7803
7899
  surface_conditions?: SurfaceCondition[];
@@ -8341,6 +8437,7 @@ interface RocketSiloPrototype extends AssemblingMachinePrototype {
8341
8437
  * Applied when switching into the {@link arms_advance | runtime:defines.rocket_silo_status.arms_advance} state.
8342
8438
  */
8343
8439
  clamps_on_trigger?: TriggerEffect;
8440
+ default_launched_signal?: SignalIDConnector;
8344
8441
  door_back_frozen?: Sprite;
8345
8442
  door_back_open_offset: Vector;
8346
8443
  door_back_sprite?: Sprite;
@@ -8742,6 +8839,10 @@ interface SelectionToolPrototype extends ItemWithLabelPrototype {
8742
8839
  mouse_cursor?: MouseCursorID;
8743
8840
  reverse_select?: SelectionModeData;
8744
8841
  select: SelectionModeData;
8842
+ /**
8843
+ * If true, the selection tool will send pre-selection events to mods {@link defines.events.on_player_start_select_area | runtime:defines.events.on_player_start_select_area}, {@link defines.events.on_player_change_select_area | runtime:defines.events.on_player_change_select_area}, and {@link defines.events.on_player_cancel_select_area | runtime:defines.events.on_player_cancel_select_area}. Off by default because it will incur a performance penalty in multiplayer. It should only be enabled if a mod specifically needs it.
8844
+ */
8845
+ send_pre_selection_events?: boolean;
8745
8846
  skip_fog_of_war?: boolean;
8746
8847
  super_forced_select?: SelectionModeData;
8747
8848
  }
@@ -9201,11 +9302,11 @@ interface SpaceLocationPrototype extends Prototype {
9201
9302
  asteroid_spawn_influence?: double;
9202
9303
  auto_save_on_first_trip?: boolean;
9203
9304
  /**
9204
- * Distance from the sun in map coordinates.
9305
+ * Distance from the origin in map coordinates.
9205
9306
  */
9206
9307
  distance: double;
9207
9308
  /**
9208
- * If `false`, the orbital ring around the sun will not be drawn for this location.
9309
+ * If `false`, the orbital ring around the origin will not be drawn for this location.
9209
9310
  */
9210
9311
  draw_orbit?: boolean;
9211
9312
  /**
@@ -9245,9 +9346,12 @@ interface SpaceLocationPrototype extends Prototype {
9245
9346
  */
9246
9347
  magnitude?: double;
9247
9348
  /**
9248
- * Angle in relation to the sun.
9349
+ * Angle in relation to the origin.
9249
9350
  */
9250
9351
  orientation: RealOrientation;
9352
+ /**
9353
+ * The location that this space location orbits in the space map.
9354
+ */
9251
9355
  origin?: MapPosition;
9252
9356
  /**
9253
9357
  * The orientation where parked space platforms will be drawn.
@@ -9275,7 +9379,7 @@ interface SpaceLocationPrototype extends Prototype {
9275
9379
  */
9276
9380
  starmap_icon?: FileName;
9277
9381
  /**
9278
- * Orientation of the starmap icon, defaults to pointing towards the sun.
9382
+ * Orientation of the starmap icon, defaults to pointing towards the origin.
9279
9383
  */
9280
9384
  starmap_icon_orientation?: RealOrientation;
9281
9385
  /**
@@ -9301,6 +9405,7 @@ interface SpacePlatformHubPrototype extends EntityWithOwnerPrototype {
9301
9405
  */
9302
9406
  circuit_wire_max_distance?: double;
9303
9407
  default_damage_taken_signal?: SignalIDConnector;
9408
+ default_empty_slots_signal?: SignalIDConnector;
9304
9409
  default_speed_signal?: SignalIDConnector;
9305
9410
  draw_circuit_wires?: boolean;
9306
9411
  draw_copper_wires?: boolean;
@@ -10100,7 +10205,23 @@ interface ThrusterPrototype extends EntityWithOwnerPrototype {
10100
10205
  * `max_performance.fluid_volume` must not be smaller than `min_performance.fluid_volume`.
10101
10206
  */
10102
10207
  max_performance: ThrusterPerformancePoint;
10208
+ /**
10209
+ * If specified, fuel fluid above this temperature will cause the thruster to stop working.
10210
+ */
10211
+ maximum_fuel_temperature?: float;
10212
+ /**
10213
+ * If specified, oxidizer fluid above this temperature will cause the thruster to stop working.
10214
+ */
10215
+ maximum_oxidizer_temperature?: float;
10103
10216
  min_performance: ThrusterPerformancePoint;
10217
+ /**
10218
+ * If specified, fuel fluid below this temperature will cause the thruster to stop working.
10219
+ */
10220
+ minimum_fuel_temperature?: float;
10221
+ /**
10222
+ * If specified, oxidizer fluid below this temperature will cause the thruster to stop working.
10223
+ */
10224
+ minimum_oxidizer_temperature?: float;
10104
10225
  /**
10105
10226
  * If a {@link filter | prototype:FluidBox::filter} is set for this fluidbox it determines what the thruster considers the second fuel.
10106
10227
  */
@@ -10327,7 +10448,9 @@ interface TipsAndTricksItem extends PrototypeBase {
10327
10448
  player_input_method_filter?: PlayerInputMethodFilter;
10328
10449
  simulation?: SimulationDefinition;
10329
10450
  /**
10330
- * Condition for never showing the tip notification to the player.
10451
+ * Condition for never showing the tip notification to the player. If the condition is fulfilled, the tip is considered completed and shown in the tips list.
10452
+ *
10453
+ * If the tip notification is already shown, then fulfilling the skip trigger removes the tip notification icon again.
10331
10454
  */
10332
10455
  skip_trigger?: TipTrigger;
10333
10456
  starting_status?: TipStatus;
@@ -10336,7 +10459,7 @@ interface TipsAndTricksItem extends PrototypeBase {
10336
10459
  */
10337
10460
  tag?: string;
10338
10461
  /**
10339
- * Condition for when the tip notification should be shown to the player.
10462
+ * Condition for when the tip notification should be shown to the player. If the condition is fulfilled, the status of the tip is set to "suggested" or "dependencies-not-met".
10340
10463
  */
10341
10464
  trigger?: TipTrigger;
10342
10465
  /**
@@ -10965,12 +11088,9 @@ interface UtilityConstants extends PrototypeBase {
10965
11088
  * The base game uses more entries here that are applied via the `ammo-category.lua` file.
10966
11089
  */
10967
11090
  bonus_gui_ordering: BonusUtilityConstants;
10968
- building_buildable_tint: Color;
10969
- building_buildable_too_far_tint: Color;
11091
+ build_preview_tints: BuildPreviewTints;
10970
11092
  building_collision_mask: CollisionMaskConnector;
10971
- building_ignorable_tint: Color;
10972
11093
  building_no_tint: Color;
10973
- building_not_buildable_tint: Color;
10974
11094
  capsule_range_visualization_color: Color;
10975
11095
  /**
10976
11096
  * Layer within `ground-natural` {@link tile render layer | prototype:TileRenderLayer} group, before which terrain lightmap alpha channel is copied into water mask. Decals, which need to be masked by water should have their {@link DecorativePrototype::tile_layer | prototype:DecorativePrototype::tile_layer} set to only slightly larger value than `capture_water_mask_at_layer`, to avoid risk of undefined behavior caused by rendering tiles into layers between `capture_water_mask_at_layer` and decal's `tile_layer`.
@@ -12153,6 +12273,8 @@ interface UtilitySprites extends PrototypeBase {
12153
12273
  side_menu_factoriopedia_icon: Sprite;
12154
12274
  side_menu_logistic_networks_icon: Sprite;
12155
12275
  side_menu_map_icon: Sprite;
12276
+ side_menu_master_mute_muted_icon: Sprite;
12277
+ side_menu_master_mute_unmuted_icon: Sprite;
12156
12278
  side_menu_menu_icon: Sprite;
12157
12279
  side_menu_players_icon: Sprite;
12158
12280
  side_menu_production_icon: Sprite;
package/dist/types.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.20
5
+ // Factorio version 2.1.22
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
@@ -2199,6 +2199,65 @@ interface BuildEntityTipTrigger extends CountBasedTipTrigger {
2199
2199
  type: 'build-entity';
2200
2200
  }
2201
2201
  type BuildMode = 'normal' | 'forced' | 'superforced';
2202
+ interface BuildPreviewTintSet {
2203
+ /**
2204
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2205
+ *
2206
+ * Defaults to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints} when used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}.
2207
+ */
2208
+ buildable?: Color;
2209
+ /**
2210
+ * Used when the player is too far away to build manually.
2211
+ *
2212
+ * Defaults to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints} when used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}.
2213
+ */
2214
+ buildable_too_far?: Color;
2215
+ /**
2216
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2217
+ *
2218
+ * Defaults to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints} when used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}.
2219
+ */
2220
+ ignorable?: Color;
2221
+ /**
2222
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2223
+ *
2224
+ * Defaults to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints} when used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}.
2225
+ */
2226
+ not_buildable?: Color;
2227
+ }
2228
+ /**
2229
+ * Tints of the cursor building preview, based on whether the preview can be built.
2230
+ */
2231
+ interface BuildPreviewTints {
2232
+ /**
2233
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2234
+ *
2235
+ * When used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}, the properties that are not given default to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2236
+ */
2237
+ entity?: BuildPreviewTintSet;
2238
+ /**
2239
+ * Colors of blueprint entities when previewed in the map view.
2240
+ *
2241
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2242
+ *
2243
+ * When used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}, the properties that are not given default to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2244
+ */
2245
+ entity_chart?: BuildPreviewTintSet;
2246
+ /**
2247
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2248
+ *
2249
+ * When used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}, the properties that are not given default to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2250
+ */
2251
+ tile?: BuildPreviewTintSet;
2252
+ /**
2253
+ * Colors of blueprint tiles when previewed in the map view.
2254
+ *
2255
+ * Mandatory in {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2256
+ *
2257
+ * When used in {@link BlueprintItemPrototype::build_preview_tints | prototype:BlueprintItemPrototype::build_preview_tints}, the properties that are not given default to the value from {@link UtilityConstants::build_preview_tints | prototype:UtilityConstants::build_preview_tints}.
2258
+ */
2259
+ tile_chart?: BuildPreviewTintSet;
2260
+ }
2202
2261
  interface BulkInserterCapacityBonusModifier extends SimpleModifier {
2203
2262
  /**
2204
2263
  * If set to `false`, use the icon from {@link UtilitySprites | prototype:UtilitySprites} for this technology effect icon.
@@ -3968,6 +4027,12 @@ interface Effect {
3968
4027
  */
3969
4028
  speed?: EffectValue;
3970
4029
  }
4030
+ interface EffectArrayTexture {
4031
+ /**
4032
+ * The path to the sprite file to use.
4033
+ */
4034
+ filename: FileName;
4035
+ }
3971
4036
  interface EffectReceiver {
3972
4037
  base_effect?: Effect;
3973
4038
  /**
@@ -4640,7 +4705,7 @@ interface EntityRendererSearchBoxLimits {
4640
4705
  */
4641
4706
  top: uint8;
4642
4707
  }
4643
- type EntityStatus = 'working' | 'normal' | 'ghost' | 'not-plugged-in-electric-network' | 'networks-connected' | 'networks-disconnected' | 'no-ammo' | 'waiting-for-target-to-be-built' | 'waiting-for-train' | 'no-power' | 'low-temperature' | 'charging' | 'discharging' | 'fully-charged' | 'no-fuel' | 'no-food' | 'out-of-logistic-network' | 'no-recipe' | 'no-ingredients' | 'no-input-fluid' | 'no-research-in-progress' | 'no-minable-resources' | 'low-input-fluid' | 'low-power' | 'not-connected-to-rail' | 'cant-divide-segments' | 'recharging-after-power-outage' | 'no-modules-to-transmit' | 'disabled-by-control-behavior' | 'opened-by-circuit-network' | 'closed-by-circuit-network' | 'disabled-by-script' | 'disabled' | 'turned-off-during-daytime' | 'fluid-ingredient-shortage' | 'item-ingredient-shortage' | 'full-output' | 'not-enough-space-in-output' | 'full-burnt-result-output' | 'marked-for-deconstruction' | 'missing-required-fluid' | 'missing-science-packs' | 'waiting-for-source-items' | 'waiting-for-space-in-destination' | 'preparing-rocket-for-launch' | 'waiting-to-launch-rocket' | 'waiting-for-space-in-platform-hub' | 'launching-rocket' | 'thrust-not-required' | 'not-enough-thrust' | 'on-the-way' | 'waiting-in-orbit' | 'waiting-for-rocket-to-arrive' | 'waiting-to-clear-drop-slots' | 'no-path' | 'broken' | 'none' | 'frozen' | 'paused' | 'not-connected-to-hub-or-pad' | 'too-far-from-pad-to-unload' | 'computing-navigation' | 'no-filter' | 'waiting-at-stop' | 'waiting-for-upgrade' | 'destination-stop-full' | 'pipeline-overextended' | 'no-spot-seedable-by-inputs' | 'waiting-for-plants-to-grow' | 'recipe-not-researched' | 'armed';
4708
+ type EntityStatus = 'working' | 'normal' | 'ghost' | 'not-plugged-in-electric-network' | 'networks-connected' | 'networks-disconnected' | 'no-ammo' | 'waiting-for-target-to-be-built' | 'waiting-for-train' | 'no-power' | 'low-temperature' | 'charging' | 'discharging' | 'fully-charged' | 'no-fuel' | 'no-food' | 'out-of-logistic-network' | 'no-recipe' | 'input-fluid-too-cold' | 'input-fluid-too-hot' | 'no-ingredients' | 'no-input-fluid' | 'no-research-in-progress' | 'no-minable-resources' | 'low-input-fluid' | 'low-power' | 'not-connected-to-rail' | 'cant-divide-segments' | 'recharging-after-power-outage' | 'no-modules-to-transmit' | 'disabled-by-control-behavior' | 'opened-by-circuit-network' | 'closed-by-circuit-network' | 'disabled-by-script' | 'disabled' | 'turned-off-during-daytime' | 'fluid-ingredient-shortage' | 'item-ingredient-shortage' | 'full-output' | 'not-enough-space-in-output' | 'full-burnt-result-output' | 'marked-for-deconstruction' | 'missing-required-fluid' | 'missing-science-packs' | 'waiting-for-source-items' | 'waiting-for-space-in-destination' | 'preparing-rocket-for-launch' | 'waiting-to-launch-rocket' | 'waiting-for-space-in-platform-hub' | 'launching-rocket' | 'thrust-not-required' | 'not-enough-thrust' | 'on-the-way' | 'waiting-in-orbit' | 'waiting-for-rocket-to-arrive' | 'waiting-to-clear-drop-slots' | 'no-path' | 'broken' | 'none' | 'frozen' | 'paused' | 'not-connected-to-hub-or-pad' | 'too-far-from-pad-to-unload' | 'computing-navigation' | 'no-filter' | 'waiting-at-stop' | 'waiting-for-upgrade' | 'destination-stop-full' | 'pipeline-overextended' | 'no-spot-seedable-by-inputs' | 'waiting-for-plants-to-grow' | 'recipe-not-researched' | 'armed';
4644
4709
  /**
4645
4710
  * Triggered when a player fast-transfers something to or from an entity, similar to the {@link on_player_fast_transferred | runtime:on_player_fast_transferred} event.
4646
4711
  */
@@ -4833,20 +4898,6 @@ interface FluidBox {
4833
4898
  * The max extent that a pipeline with this fluidbox can span. A given pipeline's extent is calculated as the min extent of all the fluidboxes that comprise it.
4834
4899
  */
4835
4900
  max_pipeline_extent?: uint32;
4836
- /**
4837
- * The maximum temperature allowed into the fluidbox. Only applied if a `filter` is specified.
4838
- * @example ```
4839
- maximum_temperature = 1000.0
4840
- ```
4841
- */
4842
- maximum_temperature?: float;
4843
- /**
4844
- * The minimum temperature allowed into the fluidbox. Only applied if a `filter` is specified.
4845
- * @example ```
4846
- minimum_temperature = 100.0
4847
- ```
4848
- */
4849
- minimum_temperature?: float;
4850
4901
  /**
4851
4902
  * Pipe picture variation used when owner machine is flipped. If no picture is loaded, pipe_picture is used instead.
4852
4903
  */
@@ -4927,11 +4978,19 @@ interface FluidEnergySource extends BaseEnergySource {
4927
4978
  hide_from_stats?: boolean;
4928
4979
  light_flicker?: LightFlickeringDefinition;
4929
4980
  /**
4930
- * `0` means unlimited maximum temperature. If this is non-zero while `scale_fluid_usage` is `false` and `fluid_usage_per_tick` is not specified, the game will use this value to calculate `fluid_usage_per_tick`. To do that, the filter on the `fluid_box` must be set.
4981
+ * If specified, an input fluid above this temperature will cause the fluid energy source to stop working.
4982
+ */
4983
+ maximum_input_temperature?: float;
4984
+ /**
4985
+ * If this is specified while `scale_fluid_usage` is `false` and `fluid_usage_per_tick` is not specified, the game will use this value to calculate `fluid_usage_per_tick`. To do that, the filter on the `fluid_box` must be set.
4931
4986
  *
4932
4987
  * Only loaded if `burns_fluid` is `false`.
4933
4988
  */
4934
4989
  maximum_temperature?: float;
4990
+ /**
4991
+ * If specified, an input fluid below this temperature will cause the fluid energy source to stop working.
4992
+ */
4993
+ minimum_input_temperature?: float;
4935
4994
  output_fluid_box?: FluidBox;
4936
4995
  /**
4937
4996
  * If set to `true`, the energy source will consume as much fluid as required to produce the desired power, otherwise it will consume as much as it is allowed to, wasting any excess.
@@ -7205,7 +7264,7 @@ end
7205
7264
  ```
7206
7265
  * @example ```
7207
7266
  -- uses a features only available past a certain base mod version
7208
- if helpers.compare_version(mods["base"], "2.0.56") >= 0 then
7267
+ if helpers.compare_versions(mods["base"], "2.0.56") >= 0 then
7209
7268
  use_new_features()
7210
7269
  end
7211
7270
  ```
@@ -7963,7 +8022,7 @@ interface PlatformBackdrop {
7963
8022
  */
7964
8023
  hero_clouds_are_emissive?: boolean;
7965
8024
  /**
7966
- * Color of light. Multiplied by 10 in shader.
8025
+ * Color of light.
7967
8026
  */
7968
8027
  light_color?: Color;
7969
8028
  light_direction?: Vector3D;
@@ -8014,7 +8073,7 @@ interface PlatformBackdrop {
8014
8073
  */
8015
8074
  rotation_seconds?: float;
8016
8075
  /**
8017
- * Color of specular light. Multiplied by 10 in shader.
8076
+ * Color of specular light.
8018
8077
  */
8019
8078
  specular_color?: Color;
8020
8079
  specular_intensity?: float;
@@ -13002,7 +13061,7 @@ interface TreeGrowth {
13002
13061
  trunk_warp: Sprite;
13003
13062
  }
13004
13063
  /**
13005
- * Tree has number of "dying" stages, which is deduced from frame count of `shadow` if shadow is defined, otherwise from frame count of `trunk`. Frame count of `leaves` has to be one less than deduced number stages, as last stage is always assumed to be leafless.
13064
+ * Tree has number of "dying" stages, which is deduced from frame count of `shadow` if shadow is defined, otherwise from frame count of `trunk`. Frame count of `leaves` has to be one less than the deduced number of stages, as last the stage is always assumed to be leafless.
13006
13065
  */
13007
13066
  interface TreeVariation {
13008
13067
  branch_generation: CreateParticleTriggerEffectItem;
@@ -14084,6 +14143,12 @@ interface WaterTileEffectParameters {
14084
14143
  * Multiplies the rgb values of `foam_color` before they are passed to the shader.
14085
14144
  */
14086
14145
  foam_color_multiplier: float;
14146
+ /**
14147
+ * The image is split into 512x512 slices which are used as randomly chosen variations.
14148
+ *
14149
+ * Shader variant `"water"` must have 0 textures, `"lava"` and `"wetland-water"` must have 1 texture, and `"oil"` must have 2 textures.
14150
+ */
14151
+ image_textures?: EffectArrayTexture[];
14087
14152
  /**
14088
14153
  * Value 0 makes water appear as water in water mask, but does not occlude lights, and doesn't overwrite lightmap alpha drawn to pixel previously (by background layer of tile transition, or underwater sprite). Light emitted by water-like-tile (for example lava) will blend additively with previously rendered light. Value 1 makes water occlude lights, but won't be recognized as water in water mask used for masking decals by water.
14089
14154
  */
@@ -14092,6 +14157,10 @@ interface WaterTileEffectParameters {
14092
14157
  * If they are set to a tuple, the properties `animation_scale`, `dark_threshold`, `reflection_threshold` and `specular_threshold` are linearly interpolated between each of their two values based on the current zoom level expressed as a ratio between `near_zoom` and `far_zoom`. E.g. if current zoom level is equal to `near_zoom`, the first tuple value is picked.
14093
14158
  */
14094
14159
  near_zoom?: float;
14160
+ /**
14161
+ * Shader variants `"water"` and `"wetland-water"` must have 1 texture, and `"lava"` and `"oil"` must have 2 textures.
14162
+ */
14163
+ noise_textures?: EffectTexture[];
14095
14164
  /**
14096
14165
  * Affects reflection threshold for `"water"` `shader_variation`. Affects distortion scale for `"lava"` `shader_variation`. Affects distortion tiling for `"wetland-water"` `shader_variation`. Affects distortion map scale for `"oil"` `shader_variation`.
14097
14166
  */
@@ -14099,8 +14168,6 @@ interface WaterTileEffectParameters {
14099
14168
  float,
14100
14169
  float
14101
14170
  ];
14102
- secondary_texture_variations_columns?: uint8;
14103
- secondary_texture_variations_rows?: uint8;
14104
14171
  shader_variation?: EffectVariation;
14105
14172
  /**
14106
14173
  * Affects specular lightness for `"water"` `shader_variation`. Affects panning/warping vector for all other `shader_variation`s.
@@ -14115,12 +14182,6 @@ interface WaterTileEffectParameters {
14115
14182
  float,
14116
14183
  float
14117
14184
  ];
14118
- texture_variations_columns?: uint8;
14119
- texture_variations_rows?: uint8;
14120
- /**
14121
- * Texture size must be 512x512. Shader variant `"water"` must have 1 texture, `"lava"` and `"wetland-water"` must have 2 textures and `"oil"` must have 4 textures.
14122
- */
14123
- textures: EffectTexture[];
14124
14185
  /**
14125
14186
  * Affects distortion speed for `"water"` `shader_variation`. Affects panning/warping speed for all other `shader_variation`s.
14126
14187
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "factorio-types",
3
- "version": "1.2.69",
3
+ "version": "1.2.71",
4
4
  "description": "Typescript declarations for the Factorio mod API",
5
5
  "main": "index.d.ts",
6
6
  "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,7 +23,7 @@
23
23
  "src/**/*.d.ts",
24
24
  "dist/**/*.d.ts"
25
25
  ],
26
- "factorioVersion": "2.1.20",
26
+ "factorioVersion": "2.1.22",
27
27
  "dependencies": {
28
28
  "lua-types": "^2.13.1"
29
29
  },