factorio-types 1.2.58 → 1.2.59

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.
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.0.77
5
+ // Factorio version 2.1.7
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
@@ -61,15 +61,35 @@ interface ActivatePasteTipTrigger extends CountBasedTipTrigger {
61
61
  ```
62
62
  */
63
63
  type ActiveTriggerID = string;
64
+ /**
65
+ * Root style: `"activity_bar"`
66
+ */
64
67
  interface ActivityBarStyleSpecification extends BaseStyleSpecification {
68
+ /**
69
+ * Required on the root style.
70
+ */
65
71
  bar?: ElementImageSet;
72
+ /**
73
+ * Required on the root style.
74
+ */
66
75
  bar_background?: ElementImageSet;
76
+ /**
77
+ * Required on the root style.
78
+ */
67
79
  bar_size_ratio?: float;
68
80
  /**
69
81
  * The thickness of the bar, not the horizontal size.
82
+ *
83
+ * Required on the root style.
70
84
  */
71
85
  bar_width?: uint32;
86
+ /**
87
+ * Required on the root style.
88
+ */
72
89
  color?: Color;
90
+ /**
91
+ * Required on the root style.
92
+ */
73
93
  speed?: float;
74
94
  type: 'activity_bar_style';
75
95
  }
@@ -213,7 +233,10 @@ type AmbientSoundType = /**
213
233
  'hero-track' | /**
214
234
  * This track is played interleaved (alternating) with `"main-track"` tracks.
215
235
  */
216
- 'interlude';
236
+ 'interlude' | /**
237
+ * This track is only played by script.
238
+ */
239
+ 'script-track';
217
240
  /**
218
241
  * The name of an {@link AmmoCategory | prototype:AmmoCategory}.
219
242
  * @example ```
@@ -267,6 +290,10 @@ interface AmmoType {
267
290
  * Energy consumption of a single shot, if applicable.
268
291
  */
269
292
  energy_consumption?: Energy;
293
+ /**
294
+ * If true, attacks will always be clamped to max range even if the target is within range. Used for shotguns.
295
+ */
296
+ force_clamp_to_max_range?: boolean;
270
297
  /**
271
298
  * Affects the `range` value of the shooting gun prototype's {@link BaseAttackParameters | prototype:BaseAttackParameters} to give a modified maximum range. The `min_range` value of the gun is unaffected.
272
299
  *
@@ -442,6 +469,10 @@ layers =
442
469
  */
443
470
  type AnimationFrameSequence = uint16[];
444
471
  interface AnimationParameters extends SpriteParameters {
472
+ /**
473
+ * If `true`, the animation frame count may be cut to half depending on detected hardware and other graphics settings.
474
+ */
475
+ allow_reducing_frames?: boolean;
445
476
  /**
446
477
  * Modifier of the animation playing speed, the default of `1` means one animation frame per tick (60 fps). The speed of playing can often vary depending on the usage (output of steam engine for example). Has to be greater than `0`.
447
478
  */
@@ -826,6 +857,9 @@ DontUseEntityInEnergyProductionAchievementPrototype | /**
826
857
  * `'editor-controller'`
827
858
  */
828
859
  EditorControllerPrototype | /**
860
+ * `'electric-energy-interface-equipment'`
861
+ */
862
+ ElectricEnergyInterfaceEquipmentPrototype | /**
829
863
  * `'electric-energy-interface'`
830
864
  */
831
865
  ElectricEnergyInterfacePrototype | /**
@@ -1379,6 +1413,7 @@ type ApplyTileTint = 'primary' | 'secondary';
1379
1413
  interface AreaTriggerItem extends TriggerItem {
1380
1414
  collision_mode?: 'distance-from-collision-box' | 'distance-from-center';
1381
1415
  radius: double;
1416
+ require_origin_is_valid?: boolean;
1382
1417
  show_in_tooltip?: boolean;
1383
1418
  target_enemies?: boolean;
1384
1419
  target_entities?: boolean;
@@ -1629,7 +1664,7 @@ interface BaseAttackParameters {
1629
1664
  */
1630
1665
  fire_penalty?: float;
1631
1666
  /**
1632
- * A higher penalty will discourage turrets from targeting units with higher health. A negative penalty will encourage turrets to target units with higher health.
1667
+ * A higher penalty will discourage turrets from targeting units with higher health ratio. A negative penalty will encourage turrets to target units with higher health ratio.
1633
1668
  */
1634
1669
  health_penalty?: float;
1635
1670
  /**
@@ -1667,6 +1702,10 @@ interface BaseAttackParameters {
1667
1702
  * Played once at the start of the attack if these are {@link ProjectileAttackParameters | prototype:ProjectileAttackParameters}.
1668
1703
  */
1669
1704
  sound?: LayeredSound;
1705
+ /**
1706
+ * A higher penalty will discourage turrets from targeting asteroids that are threatening. A negative penalty will encourage turrets to target threatening asteroids.
1707
+ */
1708
+ threatening_asteroid_penalty?: float;
1670
1709
  /**
1671
1710
  * 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.
1672
1711
  */
@@ -1722,6 +1761,16 @@ interface BaseModifier {
1722
1761
  */
1723
1762
  icons?: IconData[];
1724
1763
  }
1764
+ interface BasePumpWagonConnectionAnimations {
1765
+ input?: BasePumpWagonConnectionAnimations4Way;
1766
+ output?: BasePumpWagonConnectionAnimations4Way;
1767
+ }
1768
+ interface BasePumpWagonConnectionAnimations4Way {
1769
+ east: Animation;
1770
+ north: Animation;
1771
+ south: Animation;
1772
+ west: Animation;
1773
+ }
1725
1774
  /**
1726
1775
  * The abstract base of all {@link StyleSpecifications | prototype:StyleSpecification}.
1727
1776
  * @example ```
@@ -2034,19 +2083,19 @@ interface BoilerPictures {
2034
2083
  patch?: Sprite;
2035
2084
  structure: Animation;
2036
2085
  }
2037
- interface BonusGuiOrdering {
2038
- artillery_range: Order;
2039
- beacon_distribution: Order;
2040
- bulk_inserter: Order;
2041
- character: Order;
2042
- follower_robots: Order;
2043
- inserter: Order;
2044
- mining_productivity: Order;
2045
- research_speed: Order;
2046
- stack_inserter: Order;
2047
- train_braking_force: Order;
2048
- turret_attack: Order;
2049
- worker_robots: Order;
2086
+ interface BonusUtilityConstants {
2087
+ artillery_range: string;
2088
+ beacon_distribution: string;
2089
+ bulk_inserter: string;
2090
+ character: string;
2091
+ follower_robots: string;
2092
+ inserter: string;
2093
+ mining_productivity: string;
2094
+ research_speed: string;
2095
+ stack_inserter: string;
2096
+ train_braking_force: string;
2097
+ turret_attack: string;
2098
+ worker_robots: string;
2050
2099
  }
2051
2100
  interface BoolModifier extends BaseModifier {
2052
2101
  /**
@@ -2156,6 +2205,10 @@ interface BulkInserterCapacityBonusModifier extends SimpleModifier {
2156
2205
  use_icon_overlay_constant?: boolean;
2157
2206
  }
2158
2207
  interface BurnerEnergySource extends BaseEnergySource {
2208
+ /**
2209
+ * If this burner attempts to auto-refill fuel from the owner character, car, spider vehicle, cargo wagon, or artillery wagon.
2210
+ */
2211
+ auto_refuel?: boolean;
2159
2212
  burner_usage?: BurnerUsageID;
2160
2213
  burnt_inventory_size?: ItemStackIndex;
2161
2214
  /**
@@ -2183,25 +2236,57 @@ interface BurnerEnergySource extends BaseEnergySource {
2183
2236
  ```
2184
2237
  */
2185
2238
  type BurnerUsageID = string;
2239
+ /**
2240
+ * Root style: `"button"`
2241
+ */
2186
2242
  interface ButtonStyleSpecificationBase extends StyleWithClickableGraphicalSetSpecification {
2243
+ /**
2244
+ * Required on the root style.
2245
+ */
2187
2246
  clicked_font_color?: Color;
2188
2247
  clicked_vertical_offset?: uint32;
2248
+ /**
2249
+ * Required on the root style.
2250
+ */
2189
2251
  default_font_color?: Color;
2252
+ /**
2253
+ * Required on the root style.
2254
+ */
2190
2255
  disabled_font_color?: Color;
2191
2256
  draw_grayscale_picture?: boolean;
2192
2257
  draw_shadow_under_picture?: boolean;
2193
2258
  /**
2194
2259
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
2260
+ *
2261
+ * Required on the root style.
2195
2262
  */
2196
2263
  font?: string;
2264
+ /**
2265
+ * Required on the root style.
2266
+ */
2197
2267
  hovered_font_color?: Color;
2198
2268
  icon_horizontal_align?: HorizontalAlign;
2199
2269
  invert_colors_of_picture_when_disabled?: boolean;
2200
2270
  invert_colors_of_picture_when_hovered_or_toggled?: boolean;
2271
+ /**
2272
+ * Required on the root style.
2273
+ */
2201
2274
  pie_progress_color?: Color;
2275
+ /**
2276
+ * Required on the root style.
2277
+ */
2202
2278
  selected_clicked_font_color?: Color;
2279
+ /**
2280
+ * Required on the root style.
2281
+ */
2203
2282
  selected_font_color?: Color;
2283
+ /**
2284
+ * Required on the root style.
2285
+ */
2204
2286
  selected_hovered_font_color?: Color;
2287
+ /**
2288
+ * Required on the root style.
2289
+ */
2205
2290
  strikethrough_color?: Color;
2206
2291
  type: string;
2207
2292
  }
@@ -2215,6 +2300,9 @@ interface CameraEffectTriggerEffectItem extends TriggerEffectItem {
2215
2300
  strength?: float;
2216
2301
  type: 'camera-effect';
2217
2302
  }
2303
+ /**
2304
+ * Root style: `"camera"`
2305
+ */
2218
2306
  interface CameraStyleSpecification extends EmptyWidgetStyleSpecificationBase {
2219
2307
  type: 'camera_style';
2220
2308
  }
@@ -2245,33 +2333,32 @@ interface CargoBayConnectableGraphicsSet {
2245
2333
  animation?: Animation;
2246
2334
  animation_render_layer?: RenderLayer;
2247
2335
  connections?: CargoBayConnections;
2248
- picture?: LayeredSprite;
2336
+ picture?: LayeredSprite4Way;
2249
2337
  /**
2250
2338
  * Only loaded if this graphics set is used in a property called `graphics_set`, refer to {@link EntityPrototype::water_reflection | prototype:EntityPrototype::water_reflection}.
2251
2339
  */
2252
2340
  water_reflection?: WaterReflectionDefinition;
2253
2341
  }
2254
- /**
2255
- * Walls should have an even number of variations because they are interleaved.
2256
- */
2257
2342
  interface CargoBayConnections {
2258
- bottom_left_inner_corner?: LayeredSpriteVariations;
2259
- bottom_left_outer_corner?: LayeredSpriteVariations;
2260
- bottom_right_inner_corner?: LayeredSpriteVariations;
2261
- bottom_right_outer_corner?: LayeredSpriteVariations;
2262
- bottom_wall?: LayeredSpriteVariations;
2263
2343
  bridge_crossing?: LayeredSpriteVariations;
2264
2344
  bridge_horizontal_narrow?: LayeredSpriteVariations;
2265
2345
  bridge_horizontal_wide?: LayeredSpriteVariations;
2266
2346
  bridge_vertical_narrow?: LayeredSpriteVariations;
2267
2347
  bridge_vertical_wide?: LayeredSpriteVariations;
2268
- left_wall?: LayeredSpriteVariations;
2269
- right_wall?: LayeredSpriteVariations;
2270
- top_left_inner_corner?: LayeredSpriteVariations;
2271
- top_left_outer_corner?: LayeredSpriteVariations;
2272
- top_right_inner_corner?: LayeredSpriteVariations;
2273
- top_right_outer_corner?: LayeredSpriteVariations;
2274
- top_wall?: LayeredSpriteVariations;
2348
+ /**
2349
+ * An array of LayeredSpriteVariations groups. One tile can have a maximum of two groups. A group is selected based on tile position and a random variation is picked from that group. This allows having interleaved variations and makes sure the same variation isn't picked for surrounding tiles.
2350
+ *
2351
+ * Supports at most 255 items.
2352
+ */
2353
+ tileset?: LayeredSpriteVariations[][];
2354
+ /**
2355
+ * A mapping from a bitmask index to a tileset index. A bitmask index mapped to 0 won't be drawn.
2356
+ *
2357
+ * Tile bitmask uses 8 bits. Bits are assigned from the top-left corner and going clockwise (top-left tile has bit 0 and right tile has bit 7).
2358
+ *
2359
+ * Mandatory if `tileset` is defined.
2360
+ */
2361
+ tileset_mapping?: LuaTable<uint8, uint8 | uint8[]>;
2275
2362
  }
2276
2363
  interface CargoHatchDefinition {
2277
2364
  busy_timeout_ticks?: uint32;
@@ -2525,7 +2612,13 @@ interface ChartUtilityConstants {
2525
2612
  chart_train_stop_text_color: Color;
2526
2613
  circuit_network_member_color: Color;
2527
2614
  copper_wire_color: Color;
2615
+ /**
2616
+ * Defaults to `1.0`.
2617
+ */
2528
2618
  custom_tag_max_scale?: float;
2619
+ /**
2620
+ * Defaults to `1.0`.
2621
+ */
2529
2622
  custom_tag_scale?: float;
2530
2623
  custom_tag_selected_overlay_tint?: Color;
2531
2624
  /**
@@ -2570,16 +2663,39 @@ interface ChartUtilityConstants {
2570
2663
  yellow_signal_color: Color;
2571
2664
  zoom_threshold_to_draw_spider_path: double;
2572
2665
  }
2666
+ /**
2667
+ * Root style: `"checkbox"`
2668
+ */
2573
2669
  interface CheckBoxStyleSpecification extends StyleWithClickableGraphicalSetSpecification {
2670
+ /**
2671
+ * Required on the root style.
2672
+ */
2574
2673
  checkmark?: Sprite;
2674
+ /**
2675
+ * Required on the root style.
2676
+ */
2575
2677
  disabled_checkmark?: Sprite;
2678
+ /**
2679
+ * Required on the root style.
2680
+ */
2576
2681
  disabled_font_color?: Color;
2577
2682
  /**
2578
2683
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
2684
+ *
2685
+ * Required on the root style.
2579
2686
  */
2580
2687
  font?: string;
2688
+ /**
2689
+ * Required on the root style.
2690
+ */
2581
2691
  font_color?: Color;
2692
+ /**
2693
+ * Required on the root style.
2694
+ */
2582
2695
  intermediate_mark?: Sprite;
2696
+ /**
2697
+ * Required on the root style.
2698
+ */
2583
2699
  text_padding?: uint32;
2584
2700
  type: 'checkbox_style';
2585
2701
  }
@@ -3329,15 +3445,20 @@ interface CreateEntityTriggerEffectItemBase extends TriggerEffectItem {
3329
3445
  * Create the entity only when they are within a 200 tile range of any connected player.
3330
3446
  */
3331
3447
  only_when_visible?: boolean;
3448
+ /**
3449
+ * If `true`, colliding ghosts and corpses will not be removed by the creation of some entity types.
3450
+ */
3451
+ preserve_ghosts_and_corpses?: boolean;
3332
3452
  /**
3333
3453
  * The result entity will be protected from automated attacks of enemies.
3334
3454
  */
3335
3455
  protected?: boolean;
3456
+ show_details_in_tooltip?: boolean;
3336
3457
  show_in_tooltip?: boolean;
3337
3458
  /**
3338
3459
  * Entity creation will not occur if any tile matches the collision condition. Defaults to no collisions.
3339
3460
  */
3340
- tile_collision_mask?: CollisionMaskConnector;
3461
+ tile_collision_mask?: TileCollisionMaskConnector;
3341
3462
  /**
3342
3463
  * If `true`, the {@link on_trigger_created_entity | runtime:on_trigger_created_entity} event will be raised.
3343
3464
  */
@@ -3398,6 +3519,21 @@ interface CreateParticleTriggerEffectItemBase extends TriggerEffectItem {
3398
3519
  tint?: Color;
3399
3520
  type: string;
3400
3521
  }
3522
+ interface CreatePollutionTriggerEffectItem extends TriggerEffectItem {
3523
+ /**
3524
+ * This may be negative which will reduce pollution when run.
3525
+ */
3526
+ amount: double;
3527
+ /**
3528
+ * If not defined, and use_entity_from_trigger is false, the pollution does not show in statistics.
3529
+ */
3530
+ entity?: EntityID;
3531
+ type: 'create-pollution';
3532
+ /**
3533
+ * If not set, and entity is not set, the pollution does not show in statistics.
3534
+ */
3535
+ use_entity_from_trigger?: boolean;
3536
+ }
3401
3537
  interface CreateSmokeTriggerEffectItem extends CreateEntityTriggerEffectItemBase {
3402
3538
  initial_height?: float;
3403
3539
  speed?: Vector;
@@ -3593,7 +3729,7 @@ type DamageTypeID = string;
3593
3729
  /**
3594
3730
  * The data table is read by the game to load all prototypes.
3595
3731
  *
3596
- * At the end of the prototype stage, the data table is loaded by the game engine and the format of the prototypes is validated. Any extra properties are ignored. See {@link Data Lifecycle | runtime:data-lifecycle} for more information.
3732
+ * At the end of the prototype stage, the data table is loaded by the game engine and the format of the prototypes is validated. Any extra properties are ignored. See {@link Data Lifecycle | auxiliary:data-lifecycle} for more information.
3597
3733
  *
3598
3734
  * The data table and its properties are defined in Lua, so their source code can be viewed in {@link dataloader.lua | https://github.com/wube/factorio-data/blob/master/core/lualib/dataloader.lua}.
3599
3735
  */
@@ -3753,14 +3889,35 @@ interface DirectionShift {
3753
3889
  * One of the 16 directions, specified with a string.
3754
3890
  */
3755
3891
  type DirectionString = 'north' | 'north_north_east' | 'north_east' | 'east_north_east' | 'east' | 'east_south_east' | 'south_east' | 'south_south_east' | 'south' | 'south_south_west' | 'south_west' | 'west_south_west' | 'west' | 'west_north_west' | 'north_west' | 'north_north_west';
3892
+ /**
3893
+ * Root style: `"double_slider"`
3894
+ */
3756
3895
  interface DoubleSliderStyleSpecification extends SliderStyleSpecificationBase {
3757
3896
  type: 'double_slider_style';
3758
3897
  }
3898
+ /**
3899
+ * Root style: `"dropdown"`
3900
+ */
3759
3901
  interface DropDownStyleSpecification extends BaseStyleSpecification {
3902
+ /**
3903
+ * Required on the root style.
3904
+ */
3760
3905
  button_style?: ButtonStyleSpecification;
3906
+ /**
3907
+ * Required on the root style.
3908
+ */
3761
3909
  icon?: Sprite;
3910
+ /**
3911
+ * Required on the root style.
3912
+ */
3762
3913
  list_box_style?: ListBoxStyleSpecification;
3914
+ /**
3915
+ * Required on the root style.
3916
+ */
3763
3917
  opened_sound?: Sound;
3918
+ /**
3919
+ * Required on the root style.
3920
+ */
3764
3921
  selector_and_title_spacing?: int16;
3765
3922
  type: 'dropdown_style';
3766
3923
  }
@@ -3768,11 +3925,29 @@ interface DropItemTipTrigger extends CountBasedTipTrigger {
3768
3925
  drop_into_entity?: boolean;
3769
3926
  type: 'drop-item';
3770
3927
  }
3928
+ interface EditorUtilityConstants {
3929
+ cliff_editor_remove_cliffs_color: Color;
3930
+ clone_editor_brush_cursor_preview_tint: Color;
3931
+ clone_editor_brush_destination_color: Color;
3932
+ clone_editor_brush_source_color: Color;
3933
+ clone_editor_brush_world_preview_tint: Color;
3934
+ clone_editor_copy_destination_allowed_color: Color;
3935
+ clone_editor_copy_destination_not_allowed_color: Color;
3936
+ clone_editor_copy_source_color: Color;
3937
+ decorative_editor_selection_preview_radius: uint8;
3938
+ decorative_editor_selection_preview_tint: Color;
3939
+ force_editor_select_area_color: Color;
3940
+ script_editor_drag_area_color: Color;
3941
+ script_editor_select_area_color: Color;
3942
+ tile_editor_area_selection_color: Color;
3943
+ tile_editor_selection_preview_radius: uint8;
3944
+ tile_editor_selection_preview_tint: Color;
3945
+ }
3771
3946
  /**
3772
- * When applied to {@link modules | prototype:ModulePrototype}, the resulting effect is a sum of all module effects, multiplied through calculations: `(1 + sum module effects)`, or `(0 + sum)` for productivity. Quality calculations follow their own separate logic.
3947
+ * When applied to {@link modules | prototype:ModulePrototype}, the resulting effect is a sum of all module effects, multiplied through calculations: `(1 + sum module effects)`, or `(0 + sum)` for productivity.
3773
3948
  * @example ```
3774
3949
  -- These are the effects of the vanilla Speed Module 3
3775
- {speed = 0.5, consumption = 0.7, quality = -0.25}
3950
+ {speed = 0.5, consumption = 0.7, quality = -0.025}
3776
3951
  ```
3777
3952
  */
3778
3953
  interface Effect {
@@ -3789,7 +3964,7 @@ interface Effect {
3789
3964
  */
3790
3965
  productivity?: EffectValue;
3791
3966
  /**
3792
- * Adds a bonus chance to increase a product's quality. The minimum possible sum is 0%. The quality effect is is multiplied by {@link QualityPrototype::next_probability | prototype:QualityPrototype::next_probability}. For example, if a module's quality effect is 0.2 and the current quality's next_probability is 0.1, then the chance to get the next quality item is 2%.
3967
+ * Adds a bonus chance to increase a product's quality. The minimum possible sum is 0%.
3793
3968
  */
3794
3969
  quality?: EffectValue;
3795
3970
  /**
@@ -3799,6 +3974,36 @@ interface Effect {
3799
3974
  }
3800
3975
  interface EffectReceiver {
3801
3976
  base_effect?: Effect;
3977
+ /**
3978
+ * Limits total consumption effect value.
3979
+ *
3980
+ * Low limit cannot be less than `-0.9999`. High limit cannot be greater than `1000`.
3981
+ */
3982
+ consumption_limits?: EffectValueRange;
3983
+ /**
3984
+ * Limits total pollution effect value.
3985
+ *
3986
+ * Low limit cannot be less than `-0.9999`. High limit cannot be greater than `1000`.
3987
+ */
3988
+ pollution_limits?: EffectValueRange;
3989
+ /**
3990
+ * Limits total productivity effect value. This limit is applied before any productivity gained from research is added. Afterwards, productivity is clamped again to be non-negative. For crafting machines, it is also clamped to {@link RecipePrototype::maximum_productivity | prototype:RecipePrototype::maximum_productivity}.
3991
+ *
3992
+ * Low limit cannot be less than `-0.9999`. High limit cannot be greater than `1000`.
3993
+ */
3994
+ productivity_limits?: EffectValueRange;
3995
+ /**
3996
+ * Limits total quality effect value.
3997
+ *
3998
+ * Low limit cannot be less than `-1000`. High limit cannot be greater than `1000`.
3999
+ */
4000
+ quality_limits?: EffectValueRange;
4001
+ /**
4002
+ * Limits total speed effect value.
4003
+ *
4004
+ * Low limit cannot be less than `-0.9999`. High limit cannot be greater than `1000`.
4005
+ */
4006
+ speed_limits?: EffectValueRange;
3802
4007
  uses_beacon_effects?: boolean;
3803
4008
  uses_module_effects?: boolean;
3804
4009
  /**
@@ -3864,17 +4069,19 @@ type EffectTypeLimitation = (/**
3864
4069
  */
3865
4070
  'quality')[];
3866
4071
  /**
3867
- * Precision is ignored beyond two decimals - `0.567` results in `0.56` and means 56% etc. Values can range from `-327.68` to `327.67`. Numbers outside of this range will wrap around.
3868
- *
3869
- * Quality values are multiplied by {@link QualityPrototype::next_probability | prototype:QualityPrototype::next_probability}. For example, if a module's quality effect is 0.2 and the current quality's next_probability is 0.1, then the chance to get the next quality item is 2%.
4072
+ * Precision is ignored beyond four decimals - `0.56789` results in `0.5678` and means 56.78% etc. Values can range from `-1000.0000` to `1000.0000`.
3870
4073
  * @example ```
3871
4074
  {speed = 0.07} -- 7% bonus
3872
4075
  ```
3873
4076
  * @example ```
3874
- {quality = 0.25} -- multiplied by quality normal next_probability = 0.1 -> 2.5% bonus
4077
+ {quality = 0.025} -- 2.5% bonus
3875
4078
  ```
3876
4079
  */
3877
4080
  type EffectValue = float;
4081
+ interface EffectValueRange {
4082
+ high?: EffectValue;
4083
+ low?: EffectValue;
4084
+ }
3878
4085
  type EffectVariation = /**
3879
4086
  * Valid only when {@link expansion_shaders | prototype:FeatureFlags::expansion_shaders} feature flag is enabled.
3880
4087
  */
@@ -3973,7 +4180,10 @@ type ElectricUsagePriority = /**
3973
4180
  'solar' | /**
3974
4181
  * Can only be used by {@link LampPrototype | prototype:LampPrototype}, will be ignored otherwise.
3975
4182
  */
3976
- 'lamp';
4183
+ 'lamp' | /**
4184
+ * Can only be used by {@link ElectricEnergyInterfacePrototype | prototype:ElectricEnergyInterfacePrototype}, will be ignored otherwise.
4185
+ */
4186
+ 'dynamic';
3977
4187
  /**
3978
4188
  * If this is loaded as a single ElementImageSetLayer, it gets used as `base`.
3979
4189
  */
@@ -4139,7 +4349,13 @@ type ElementImageSetLayer = {
4139
4349
  top_width?: SpriteSizeType;
4140
4350
  type?: 'none' | 'composition';
4141
4351
  } | Sprite;
4352
+ /**
4353
+ * Root style: `"empty_widget"`
4354
+ */
4142
4355
  interface EmptyWidgetStyleSpecificationBase extends BaseStyleSpecification {
4356
+ /**
4357
+ * Required on the root style.
4358
+ */
4143
4359
  graphical_set?: ElementImageSet;
4144
4360
  type: string;
4145
4361
  }
@@ -4162,6 +4378,10 @@ interface EnemyExpansionSettings {
4162
4378
  building_coefficient: double;
4163
4379
  enabled: boolean;
4164
4380
  enemy_building_influence_radius: uint32;
4381
+ /**
4382
+ * Exponential factor used to determine the size of the settler group based on the evolution factor. The size is calculated as: `size = random(min_size, max_size) * (evolution_group_size_factor ^ evolution_factor)`
4383
+ */
4384
+ evolution_group_size_factor: double;
4165
4385
  friendly_base_influence_radius: uint32;
4166
4386
  /**
4167
4387
  * A chunk has to have at most this much percent unbuildable tiles for it to be considered a candidate. This is to avoid chunks full of water to be marked as candidates.
@@ -4179,12 +4399,16 @@ interface EnemyExpansionSettings {
4179
4399
  * Ticks to expand to a single position for a base is used. Cooldown is calculated as follows: `cooldown = lerp(max_expansion_cooldown, min_expansion_cooldown, -e^2 + 2 * e)` where `lerp` is the linear interpolation function, and e is the current evolution factor.
4180
4400
  */
4181
4401
  min_expansion_cooldown: uint32;
4402
+ /**
4403
+ * Distance in chunks from the furthest base around to prevent expansions from being too close to existing bases.
4404
+ */
4405
+ min_expansion_distance: uint32;
4182
4406
  neighbouring_base_chunk_coefficient: double;
4183
4407
  neighbouring_chunk_coefficient: double;
4184
4408
  other_base_coefficient: double;
4185
4409
  settler_group_max_size: uint32;
4186
4410
  /**
4187
- * Size of the group that goes to build new base (the game interpolates between min size and max size based on evolution factor).
4411
+ * Size of the group that goes to build new base.
4188
4412
  */
4189
4413
  settler_group_min_size: uint32;
4190
4414
  }
@@ -4358,6 +4582,9 @@ type EntityPrototypeFlags = (/**
4358
4582
  * The entity can not be used in blueprints.
4359
4583
  */
4360
4584
  'not-blueprintable' | /**
4585
+ * Always show the entity in selection lists/Factoriopedia.
4586
+ */
4587
+ 'always-show' | /**
4361
4588
  * Hides the alt-info of an entity in alt-mode, for example the recipe icon.
4362
4589
  */
4363
4590
  'hide-alt-info' | /**
@@ -4381,10 +4608,19 @@ type EntityPrototypeFlags = (/**
4381
4608
  'not-upgradable' | /**
4382
4609
  * The entity is not shown in the kill statistics.
4383
4610
  */
4384
- 'not-in-kill-statistics' | 'building-direction-16-way' | 'snap-to-rail-support-spot' | /**
4385
- * The entity is not shown in the made in property of recipe tooltips.
4611
+ 'not-in-kill-statistics' | 'building-direction-16-way' | /**
4612
+ * For entities with control behavior that supports logistic connection, if this flag is set then entity will not be able to connect to logistic network.
4386
4613
  */
4387
- 'not-in-made-in')[];
4614
+ 'no-logistic-connection' | 'snap-to-rail-support-spot' | /**
4615
+ * The entity is not shown in the made in property of recipe tooltips and Factoriopedia.
4616
+ */
4617
+ 'not-in-made-in' | /**
4618
+ * The entity is not shown in the bonus GUI.
4619
+ */
4620
+ 'not-in-bonus-gui' | /**
4621
+ * The entity is not shown in the mined-by tooltip for resources.
4622
+ */
4623
+ 'not-in-mined-by')[];
4388
4624
  /**
4389
4625
  * How far (in tiles) entities should be rendered outside the visible area of the screen.
4390
4626
  */
@@ -4406,7 +4642,7 @@ interface EntityRendererSearchBoxLimits {
4406
4642
  */
4407
4643
  top: uint8;
4408
4644
  }
4409
- 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' | 'no-path' | 'broken' | 'none' | 'frozen' | 'paused' | 'not-connected-to-hub-or-pad' | 'computing-navigation' | 'no-filter' | 'waiting-at-stop' | 'destination-stop-full' | 'pipeline-overextended' | 'no-spot-seedable-by-inputs' | 'waiting-for-plants-to-grow' | 'recipe-not-researched';
4645
+ 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';
4410
4646
  interface EntityTransferTipTrigger extends CountBasedTipTrigger {
4411
4647
  transfer?: 'in' | 'out';
4412
4648
  type: 'entity-transfer';
@@ -4492,6 +4728,8 @@ interface FastReplaceTipTrigger extends CountBasedTipTrigger {
4492
4728
  }
4493
4729
  /**
4494
4730
  * A dictionary of feature flags and their status. It can be used to adjust prototypes based on whether the feature flags are enabled. It is accessible through the global object named `feature_flags`.
4731
+ *
4732
+ * See the {@link mod structure | auxiliary:mod-structure} documentation for more information on what each feature flag affects.
4495
4733
  * @example ```
4496
4734
  -- sets coal to spoil only when the spoiling feature flag is enabled
4497
4735
  if feature_flags["spoiling"] then
@@ -4500,6 +4738,7 @@ end
4500
4738
  ```
4501
4739
  */
4502
4740
  interface FeatureFlags {
4741
+ expansion: boolean;
4503
4742
  expansion_shaders: boolean;
4504
4743
  freezing: boolean;
4505
4744
  quality: boolean;
@@ -4516,6 +4755,8 @@ interface FeatureFlags {
4516
4755
  * - **base**: A path starting with `__base__` will access the resources in the base mod in data/base directory. These resources are usually available, as long as the base mod isn't removed/deactivated.
4517
4756
  *
4518
4757
  * - **mod path**: The format `__<mod-name>__` is placeholder for root of any other mod (mods/<mod-name>), and is accessible as long as the mod is active.
4758
+ *
4759
+ * Relative paths using `..` are not supported.
4519
4760
  * @example ```
4520
4761
  filename = "__base__/graphics/entity/accumulator/accumulator.png"
4521
4762
  ```
@@ -4527,10 +4768,22 @@ type FileName = string;
4527
4768
  interface FlipEntityTipTrigger extends CountBasedTipTrigger {
4528
4769
  type: 'flip-entity';
4529
4770
  }
4771
+ /**
4772
+ * Root style: `"flow"`
4773
+ */
4530
4774
  interface FlowStyleSpecification extends BaseStyleSpecification {
4775
+ /**
4776
+ * Required on the root style.
4777
+ */
4531
4778
  horizontal_spacing?: int32;
4779
+ /**
4780
+ * Required on the root style.
4781
+ */
4532
4782
  max_on_row?: int32;
4533
4783
  type: 'flow_style';
4784
+ /**
4785
+ * Required on the root style.
4786
+ */
4534
4787
  vertical_spacing?: int32;
4535
4788
  }
4536
4789
  /**
@@ -4572,10 +4825,6 @@ interface FluidBox {
4572
4825
  * Can be used to specify which fluid is allowed to enter this fluid box. See {@link here | https://forums.factorio.com/viewtopic.php?f=28&t=46302}.
4573
4826
  */
4574
4827
  filter?: FluidID;
4575
- /**
4576
- * Hides the blue input/output arrows and icons at each connection point.
4577
- */
4578
- hide_connection_info?: boolean;
4579
4828
  /**
4580
4829
  * 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.
4581
4830
  */
@@ -4675,11 +4924,16 @@ interface FluidEnergySource extends BaseEnergySource {
4675
4924
  * Only loaded if `burns_fluid` is `false`.
4676
4925
  */
4677
4926
  maximum_temperature?: float;
4927
+ output_fluid_box?: FluidBox;
4678
4928
  /**
4679
4929
  * 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.
4680
4930
  */
4681
4931
  scale_fluid_usage?: boolean;
4682
4932
  smoke?: SmokeSource[];
4933
+ /**
4934
+ * Fluid and amount produced per 1 unit of fluid consumed. Only used when `output_fluid_box` is defined. If this value is not provided, {@link FluidPrototype::spent_fluid | prototype:FluidPrototype::spent_fluid} will be used based on the input fluid being consumed.
4935
+ */
4936
+ spent_fluid?: SpentFluidSpecification;
4683
4937
  type: 'fluid';
4684
4938
  }
4685
4939
  type FluidFlowDirection = 'input-output' | 'input' | 'output';
@@ -4728,6 +4982,12 @@ interface FluidIngredientPrototype {
4728
4982
  * The name of a {@link FluidPrototype | prototype:FluidPrototype}.
4729
4983
  */
4730
4984
  name: FluidID;
4985
+ /**
4986
+ * Additional fluid boxes that will be also used by this fluid ingredient. If a machine does not have a fluid box with that index, then this index will be silently skipped without making recipe uncraftable.
4987
+ *
4988
+ * Only loaded if `fluidbox_index` is defined.
4989
+ */
4990
+ optional_fluidbox_indexes?: uint32[];
4731
4991
  /**
4732
4992
  * Sets the expected temperature of the fluid ingredient.
4733
4993
  */
@@ -4737,7 +4997,7 @@ interface FluidIngredientPrototype {
4737
4997
  /**
4738
4998
  * A fluid product definition.
4739
4999
  */
4740
- interface FluidProductPrototype {
5000
+ interface FluidProductPrototype extends ProductPrototypeBase {
4741
5001
  /**
4742
5002
  * Can not be `< 0`.
4743
5003
  */
@@ -4758,6 +5018,10 @@ interface FluidProductPrototype {
4758
5018
  * Used to specify which {@link CraftingMachinePrototype::fluid_boxes | prototype:CraftingMachinePrototype::fluid_boxes} this product should use. It will use this one fluidbox. The index is 1-based and separate for input and output fluidboxes.
4759
5019
  */
4760
5020
  fluidbox_index?: uint32;
5021
+ /**
5022
+ * Used to set crafting machine fluidbox volumes. Must be at least 1.
5023
+ */
5024
+ fluidbox_multiplier?: uint8;
4761
5025
  /**
4762
5026
  * Amount that should be deducted from any productivity induced bonus crafts.
4763
5027
  *
@@ -4779,27 +5043,17 @@ interface FluidProductPrototype {
4779
5043
  */
4780
5044
  name: FluidID;
4781
5045
  /**
4782
- * Value between 0 and 1, `0` for 0% chance and `1` for 100% chance.
4783
- *
4784
- * The effect of probability is no product, or a linear distribution on [min, max]. For a recipe with probability `p`, amount_min `min`, and amount_max `max`, the Expected Value of this product can be expressed as `p * (0.5 * (max + min))`. This is what will be shown in a recipe tooltip. The effect of `ignored_by_productivity` on the product is not shown.
5046
+ * Additional fluid boxes that will be also used by this fluid product. If a machine does not have a fluid box with that index, then this index will be silently skipped without making recipe uncraftable.
4785
5047
  *
4786
- * When `amount_min` and `amount_max` are not provided, `amount` applies as min and max. The Expected Value simplifies to `p * amount`, providing `0` product, or `amount` product, on recipe completion.
4787
- */
4788
- probability?: double;
4789
- /**
4790
- * When hovering over a recipe in the crafting menu the recipe tooltip will be shown. An additional item tooltip will be shown for every product, as a separate tooltip, if the item tooltip has a description and/or properties to show and if `show_details_in_recipe_tooltip` is `true`.
5048
+ * Only loaded if `fluidbox_index` is defined.
4791
5049
  */
4792
- show_details_in_recipe_tooltip?: boolean;
5050
+ optional_fluidbox_indexes?: uint32[];
4793
5051
  /**
4794
5052
  * The temperature of the fluid product.
4795
5053
  */
4796
5054
  temperature?: float;
4797
5055
  type: 'fluid';
4798
5056
  }
4799
- interface FluidWagonConnectorGraphics {
4800
- load_animations: PumpConnectorGraphics;
4801
- unload_animations: PumpConnectorGraphics;
4802
- }
4803
5057
  interface FogEffectProperties {
4804
5058
  color1?: Color;
4805
5059
  color2?: Color;
@@ -4933,18 +5187,48 @@ type ForceCondition = /**
4933
5187
  * The non-same forces pass.
4934
5188
  */
4935
5189
  'not-same';
5190
+ /**
5191
+ * Root style: `"frame"`
5192
+ */
4936
5193
  interface FrameStyleSpecification extends BaseStyleSpecification {
4937
5194
  background_graphical_set?: ElementImageSet;
5195
+ /**
5196
+ * Required on the root style.
5197
+ */
4938
5198
  border?: BorderImageSet;
5199
+ /**
5200
+ * Required on the root style.
5201
+ */
4939
5202
  drag_by_title?: boolean;
5203
+ /**
5204
+ * Required on the root style.
5205
+ */
4940
5206
  graphical_set?: ElementImageSet;
4941
5207
  header_background?: ElementImageSet;
5208
+ /**
5209
+ * Required on the root style.
5210
+ */
4942
5211
  header_filler_style?: EmptyWidgetStyleSpecification;
5212
+ /**
5213
+ * Required on the root style.
5214
+ */
4943
5215
  header_flow_style?: HorizontalFlowStyleSpecification;
5216
+ /**
5217
+ * Required on the root style.
5218
+ */
4944
5219
  horizontal_flow_style?: HorizontalFlowStyleSpecification;
5220
+ /**
5221
+ * Required on the root style.
5222
+ */
4945
5223
  title_style?: LabelStyleSpecification;
4946
5224
  type: 'frame_style';
5225
+ /**
5226
+ * Required on the root style.
5227
+ */
4947
5228
  use_header_filler?: boolean;
5229
+ /**
5230
+ * Required on the root style.
5231
+ */
4948
5232
  vertical_flow_style?: VerticalFlowStyleSpecification;
4949
5233
  }
4950
5234
  interface FrequencySizeRichness {
@@ -5033,6 +5317,7 @@ interface GameViewSettings {
5033
5317
  * If this is defined then it sets the default value for all other properties.
5034
5318
  */
5035
5319
  default_show_value?: boolean;
5320
+ hide_tall_entities?: boolean;
5036
5321
  show_alert_gui?: boolean;
5037
5322
  show_controller_gui?: boolean;
5038
5323
  show_crafting_queue?: boolean;
@@ -5041,6 +5326,7 @@ interface GameViewSettings {
5041
5326
  show_hotkey_suggestions?: boolean;
5042
5327
  show_map_view_options?: boolean;
5043
5328
  show_minimap?: boolean;
5329
+ show_pins_gui?: boolean;
5044
5330
  show_quickbar?: boolean;
5045
5331
  show_rail_block_visualisation?: boolean;
5046
5332
  show_research_info?: boolean;
@@ -5056,6 +5342,16 @@ interface GateOverRailBuildTipTrigger extends CountBasedTipTrigger {
5056
5342
  interface GeneratingPowerTipTrigger extends CountBasedTipTrigger {
5057
5343
  type: 'generating-power';
5058
5344
  }
5345
+ interface GeneratorPictureSet {
5346
+ east?: GeneratorPictures;
5347
+ north?: GeneratorPictures;
5348
+ south?: GeneratorPictures;
5349
+ west?: GeneratorPictures;
5350
+ }
5351
+ interface GeneratorPictures {
5352
+ animation?: Animation;
5353
+ frozen_patch?: Sprite;
5354
+ }
5059
5355
  interface GhostShimmerConfig {
5060
5356
  blend_mode: int32;
5061
5357
  distortion: float;
@@ -5144,29 +5440,82 @@ interface GlobalTintEffectProperties {
5144
5440
  zoom_factor: float;
5145
5441
  zoom_intensity: float;
5146
5442
  }
5443
+ /**
5444
+ * Root style: `"glow"`
5445
+ */
5147
5446
  interface GlowStyleSpecification extends BaseStyleSpecification {
5447
+ /**
5448
+ * Required on the root style.
5449
+ */
5148
5450
  image_set?: ElementImageSet;
5149
5451
  type: 'glow_style';
5150
5452
  }
5453
+ /**
5454
+ * Root style: `"graph"`
5455
+ */
5151
5456
  interface GraphStyleSpecification extends BaseStyleSpecification {
5457
+ /**
5458
+ * Required on the root style.
5459
+ */
5152
5460
  background_color?: Color;
5461
+ /**
5462
+ * Required on the root style.
5463
+ */
5153
5464
  data_line_highlight_distance?: uint32;
5154
5465
  /**
5155
5466
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
5467
+ *
5468
+ * Required on the root style.
5156
5469
  */
5157
5470
  font?: string;
5471
+ /**
5472
+ * Required on the root style.
5473
+ */
5158
5474
  graph_right_margin?: uint32;
5475
+ /**
5476
+ * Required on the root style.
5477
+ */
5159
5478
  graph_top_margin?: uint32;
5479
+ /**
5480
+ * Required on the root style.
5481
+ */
5160
5482
  grid_lines_color?: Color;
5483
+ /**
5484
+ * Required on the root style.
5485
+ */
5161
5486
  guide_lines_color?: Color;
5487
+ /**
5488
+ * Required on the root style.
5489
+ */
5162
5490
  horizontal_label_style?: LabelStyleSpecification;
5491
+ /**
5492
+ * Required on the root style.
5493
+ */
5163
5494
  horizontal_labels_margin?: uint32;
5495
+ /**
5496
+ * Required on the root style.
5497
+ */
5164
5498
  line_colors?: Color[];
5499
+ /**
5500
+ * Required on the root style.
5501
+ */
5165
5502
  minimal_horizontal_label_spacing?: uint32;
5503
+ /**
5504
+ * Required on the root style.
5505
+ */
5166
5506
  minimal_vertical_label_spacing?: uint32;
5507
+ /**
5508
+ * Required on the root style.
5509
+ */
5167
5510
  selection_dot_radius?: uint32;
5168
5511
  type: 'graph_style';
5512
+ /**
5513
+ * Required on the root style.
5514
+ */
5169
5515
  vertical_label_style?: LabelStyleSpecification;
5516
+ /**
5517
+ * Required on the root style.
5518
+ */
5170
5519
  vertical_labels_margin?: uint32;
5171
5520
  }
5172
5521
  interface GroupAttackTipTrigger extends CountBasedTipTrigger {
@@ -5204,7 +5553,7 @@ interface HeatBuffer {
5204
5553
  /**
5205
5554
  * May contain up to 32 connections.
5206
5555
  */
5207
- connections?: HeatConnection[];
5556
+ connections?: HeatConnectionDefinition[];
5208
5557
  default_temperature?: double;
5209
5558
  heat_glow?: Sprite4Way;
5210
5559
  heat_picture?: Sprite4Way;
@@ -5226,7 +5575,7 @@ interface HeatBuffer {
5226
5575
  /**
5227
5576
  * Defines the connections for {@link HeatEnergySource | prototype:HeatEnergySource} and {@link HeatBuffer | prototype:HeatBuffer}.
5228
5577
  */
5229
- interface HeatConnection {
5578
+ interface HeatConnectionDefinition {
5230
5579
  /**
5231
5580
  * The "outward" direction of this heat connection. For a connection to succeed, the other heat connection must face the opposite direction (a south-facing connection needs a north-facing connection to succeed). A connection rotates with the entity.
5232
5581
  */
@@ -5240,7 +5589,7 @@ interface HeatEnergySource extends BaseEnergySource {
5240
5589
  /**
5241
5590
  * May contain up to 32 connections.
5242
5591
  */
5243
- connections?: HeatConnection[];
5592
+ connections?: HeatConnectionDefinition[];
5244
5593
  default_temperature?: double;
5245
5594
  emissions_per_minute?: Record<AirbornePollutantID, double>;
5246
5595
  heat_glow?: Sprite4Way;
@@ -5262,10 +5611,19 @@ interface HeatEnergySource extends BaseEnergySource {
5262
5611
  type: 'heat';
5263
5612
  }
5264
5613
  type HorizontalAlign = 'left' | 'center' | 'right';
5614
+ /**
5615
+ * Root style: `"horizontal_flow"`
5616
+ */
5265
5617
  interface HorizontalFlowStyleSpecification extends BaseStyleSpecification {
5618
+ /**
5619
+ * Required on the root style.
5620
+ */
5266
5621
  horizontal_spacing?: int32;
5267
5622
  type: 'horizontal_flow_style';
5268
5623
  }
5624
+ /**
5625
+ * Root style: `"horizontal_scrollbar"`
5626
+ */
5269
5627
  interface HorizontalScrollBarStyleSpecification extends ScrollBarStyleSpecification {
5270
5628
  type: 'horizontal_scrollbar_style';
5271
5629
  }
@@ -5393,6 +5751,7 @@ interface IconSequencePositioning {
5393
5751
  shift?: Vector;
5394
5752
  }
5395
5753
  /**
5754
+ * Root style: `"image"`
5396
5755
  * @example ```
5397
5756
  data.raw["gui-style"]["default"]["stretchy-sprite"] =
5398
5757
  {
@@ -5404,8 +5763,14 @@ data.raw["gui-style"]["default"]["stretchy-sprite"] =
5404
5763
  ```
5405
5764
  */
5406
5765
  interface ImageStyleSpecification extends BaseStyleSpecification {
5766
+ /**
5767
+ * Required on the root style.
5768
+ */
5407
5769
  graphical_set?: ElementImageSet;
5408
5770
  invert_colors_of_picture_when_hovered_or_toggled?: boolean;
5771
+ /**
5772
+ * Required on the root style.
5773
+ */
5409
5774
  stretch_image_to_widget_size?: boolean;
5410
5775
  type: 'image_style';
5411
5776
  }
@@ -5466,7 +5831,7 @@ interface InterruptibleSound {
5466
5831
  }
5467
5832
  interface InventoryWithCustomStackSizeSpecification {
5468
5833
  /**
5469
- * Must be >= stack_size_min.
5834
+ * Must be >= stack_size_min and <= 1000000000.
5470
5835
  */
5471
5836
  stack_size_max?: ItemCountType;
5472
5837
  /**
@@ -5484,7 +5849,7 @@ interface InventoryWithCustomStackSizeSpecification {
5484
5849
  with_bar?: boolean;
5485
5850
  }
5486
5851
  interface InvokeTileEffectTriggerEffectItem extends TriggerEffectItem {
5487
- tile_collision_mask?: CollisionMaskConnector;
5852
+ tile_collision_mask?: TileCollisionMaskConnector;
5488
5853
  type: 'invoke-tile-trigger';
5489
5854
  }
5490
5855
  type ItemCountType = uint32;
@@ -5542,13 +5907,47 @@ interface ItemIngredientPrototype {
5542
5907
  */
5543
5908
  ignored_by_stats?: uint16;
5544
5909
  name: ItemID;
5545
- type: 'item';
5546
- }
5547
- /**
5548
- * An item product definition.
5549
- */
5550
- interface ItemProductPrototype {
5551
- amount?: uint16;
5910
+ /**
5911
+ * Amount of quality levels up or down this ingredient will be adjusted.
5912
+ *
5913
+ * This is the difference between the quality of the recipe and the quality of the ingredient. For a vanilla example, when legendary is selected for recipe quality, an ingredient with quality change `-1` would need to be epic quality, not legendary.
5914
+ *
5915
+ * If `quality_min` is equal to `quality_max`, this is silently set to `0` as it does not make sense to define a quality jump when ingredient quality is fixed to one value for all qualities of recipe.
5916
+ */
5917
+ quality_change?: int8;
5918
+ /**
5919
+ * Highest possible quality of ingredient that will be accepted. If not provided but `quality_min` is given, it will be set to the highest quality from a quality chain to which `quality_min` belongs. Must belong to the same quality chain as `quality_min` and be equal or better, meaning later in the chain when following {@link QualityPrototype::next | prototype:QualityPrototype::next}.
5920
+ */
5921
+ quality_max?: QualityID;
5922
+ /**
5923
+ * Lowest possible quality of ingredient that will be accepted. If not provided but `quality_max` is given, it will be set to the lowest quality from a quality chain to which `quality_max` belongs. When set, if the recipe would require ingredient from a different quality chain (due to quality of the recipe or quality roll), `quality_min` will be used for the quality instead.
5924
+ */
5925
+ quality_min?: QualityID;
5926
+ /**
5927
+ * Controls how much spoil percent of this ingredient should influence spoil percent of spoilable products.
5928
+ *
5929
+ * Must be in range `[0, 1]`.
5930
+ */
5931
+ spoil_weight?: float;
5932
+ type: 'item';
5933
+ }
5934
+ /**
5935
+ * An item product definition.
5936
+ */
5937
+ interface ItemProductPrototype extends ProductPrototypeBase {
5938
+ /**
5939
+ * Whether quality roll affects quality of products given. If set to `false`, result of a quality roll will be ignored and an item of quality based on quality of selected recipe will be given.
5940
+ *
5941
+ * Note: This may not work as expected outside of recipes (e.g. in mining drills).
5942
+ */
5943
+ affected_by_quality?: boolean;
5944
+ /**
5945
+ * When set to true, the item produced will be produced fresh (using percent_spoiled) even when ingredients were spoiled.
5946
+ *
5947
+ * Note: This may not work as expected outside of recipes (e.g. in mining drills).
5948
+ */
5949
+ always_fresh?: boolean;
5950
+ amount?: uint16;
5552
5951
  /**
5553
5952
  * Only loaded, and mandatory if `amount` is not defined.
5554
5953
  *
@@ -5588,17 +5987,31 @@ interface ItemProductPrototype {
5588
5987
  */
5589
5988
  percent_spoiled?: float;
5590
5989
  /**
5591
- * Value between 0 and 1, `0` for 0% chance and `1` for 100% chance.
5990
+ * Amount of quality levels up or down this product will be adjusted.
5592
5991
  *
5593
- * The effect of probability is no product, or a linear distribution on [min, max]. For a recipe with probability `p`, amount_min `min`, and amount_max `max`, the Expected Value of this product can be expressed as `p * (0.5 * (max + min))`. This is what will be shown in a recipe tooltip. The effect of `ignored_by_productivity` on the product is not shown.
5992
+ * This is the difference between the quality of the recipe and the quality of the product. For a vanilla example, when epic is selected for recipe quality, a product with quality change `1` would be legendary quality, not epic.
5594
5993
  *
5595
- * When `amount_min` and `amount_max` are not provided, `amount` applies as min and max. The Expected Value simplifies to `p * amount`, providing `0` product, or `amount` product, on recipe completion.
5994
+ * Note: This may not work as expected outside of recipes (e.g. in mining drills).
5596
5995
  */
5597
- probability?: double;
5996
+ quality_change?: int8;
5598
5997
  /**
5599
- * When hovering over a recipe in the crafting menu the recipe tooltip will be shown. An additional item tooltip will be shown for every product, as a separate tooltip, if the item tooltip has a description and/or properties to show and if `show_details_in_recipe_tooltip` is `true`.
5998
+ * Highest possible quality of item that will be given. If not provided but `quality_min` is given, it will be set to the highest quality from a quality chain to which `quality_min` belongs. Must belong to the same quality chain as `quality_min` and be equal or better, meaning later in the chain when following {@link QualityPrototype::next | prototype:QualityPrototype::next}.
5999
+ *
6000
+ * Note: If this is used outside of recipes (e.g. by mining drills), setting this to a custom quality chain will discard the quality roll.
5600
6001
  */
5601
- show_details_in_recipe_tooltip?: boolean;
6002
+ quality_max?: QualityID;
6003
+ /**
6004
+ * Lowest possible quality of item that will be given. If not provided but `quality_max` is given, it will be set to the lowest quality from a quality chain to which `quality_max` belongs. When set, if the recipe would produce items from a different quality chain (due to quality of the recipe or quality roll), `quality_min` will be used for the quality instead.
6005
+ *
6006
+ * Note: If this is used outside of recipes (e.g. by mining drills), setting this to a custom quality chain will discard the quality roll.
6007
+ */
6008
+ quality_min?: QualityID;
6009
+ /**
6010
+ * When set to true, if the recipe successfully finishes crafting without spoiling, the result is produced fresh (non-spoiled).
6011
+ *
6012
+ * Note: This may not work as expected outside of recipes (e.g. in mining drills).
6013
+ */
6014
+ reset_freshness_on_craft?: boolean;
5602
6015
  type: 'item';
5603
6016
  }
5604
6017
  /**
@@ -5611,6 +6024,9 @@ type ItemPrototypeFlags = (/**
5611
6024
  * Whether the trash-unrequested feature skips this item.
5612
6025
  */
5613
6026
  'excluded-from-trash-unrequested' | /**
6027
+ * Whether the rocket passenger feature skips this item when checking lift weight.
6028
+ */
6029
+ 'excluded-from-character-lift-weight' | /**
5614
6030
  * Always show the item in selection lists (item filter, logistic request etc.) even when locked recipe for that item is present.
5615
6031
  */
5616
6032
  'always-show' | /**
@@ -5637,7 +6053,7 @@ type ItemPrototypeFlags = (/**
5637
6053
  'spawnable' | 'spoil-result' | /**
5638
6054
  * Controls whether the spoil time ignores the spoil time modifier in the {@link DifficultySettings | runtime:DifficultySettings}.
5639
6055
  */
5640
- 'ignore-spoil-time-modifier')[];
6056
+ 'ignore-spoil-time-modifier' | 'hide-health-bar-in-world' | 'hide-spoilage-bar-in-world')[];
5641
6057
  type ItemStackIndex = uint16;
5642
6058
  /**
5643
6059
  * The name of an {@link ItemSubGroup | prototype:ItemSubGroup}.
@@ -5666,26 +6082,52 @@ interface ItemToPlace {
5666
6082
  item: ItemID;
5667
6083
  }
5668
6084
  interface KillTipTrigger extends CountBasedTipTrigger {
6085
+ /**
6086
+ * If this is not set, any damage type will fulfill the trigger condition.
6087
+ */
5669
6088
  damage_type?: DamageTypeID;
5670
6089
  entity?: EntityID;
5671
6090
  match_type_only?: boolean;
5672
6091
  type: 'kill';
5673
6092
  }
6093
+ /**
6094
+ * Root style: `"label"`
6095
+ */
5674
6096
  interface LabelStyleSpecification extends BaseStyleSpecification {
5675
6097
  clicked_font_color?: Color;
5676
6098
  disabled_font_color?: Color;
5677
6099
  /**
5678
6100
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
6101
+ *
6102
+ * Required on the root style.
5679
6103
  */
5680
6104
  font?: string;
6105
+ /**
6106
+ * Required on the root style.
6107
+ */
5681
6108
  font_color?: Color;
5682
6109
  game_controller_hovered_font_color?: Color;
5683
6110
  hovered_font_color?: Color;
5684
6111
  parent_hovered_font_color?: Color;
6112
+ /**
6113
+ * Required on the root style.
6114
+ */
5685
6115
  rich_text_highlight_error_color?: Color;
6116
+ /**
6117
+ * Required on the root style.
6118
+ */
5686
6119
  rich_text_highlight_ok_color?: Color;
6120
+ /**
6121
+ * Required on the root style.
6122
+ */
5687
6123
  rich_text_highlight_warning_color?: Color;
6124
+ /**
6125
+ * Required on the root style.
6126
+ */
5688
6127
  rich_text_setting?: RichTextSetting;
6128
+ /**
6129
+ * Required on the root style.
6130
+ */
5689
6131
  single_line?: boolean;
5690
6132
  type: 'label_style';
5691
6133
  underlined?: boolean;
@@ -5718,6 +6160,15 @@ type LayeredSound = {
5718
6160
  type LayeredSprite = {
5719
6161
  render_layer: RenderLayer;
5720
6162
  } | LayeredSprite[];
6163
+ /**
6164
+ * Sprites for the 4 major directions of the entity. If this is loaded as a single LayeredSprite, it applies to all directions.
6165
+ */
6166
+ type LayeredSprite4Way = {
6167
+ east: LayeredSprite;
6168
+ north: LayeredSprite;
6169
+ south: LayeredSprite;
6170
+ west: LayeredSprite;
6171
+ } | LayeredSprite;
5721
6172
  type LayeredSpriteVariations = LayeredSprite[];
5722
6173
  /**
5723
6174
  * Specifies a light source. This is loaded either as a single light source or as an array of light sources.
@@ -5946,7 +6397,13 @@ interface LightningShaderConfiguration {
5946
6397
  interface LimitChestTipTrigger extends CountBasedTipTrigger {
5947
6398
  type: 'limit-chest';
5948
6399
  }
6400
+ /**
6401
+ * Root style: `"line"`
6402
+ */
5949
6403
  interface LineStyleSpecification extends BaseStyleSpecification {
6404
+ /**
6405
+ * Required on the root style.
6406
+ */
5950
6407
  border?: BorderImageSet;
5951
6408
  type: 'line_style';
5952
6409
  }
@@ -5993,12 +6450,21 @@ interface LinkedBeltStructure {
5993
6450
  /**
5994
6451
  * The internal name of a game control (key binding).
5995
6452
  */
5996
- type LinkedGameControl = 'move-up' | 'move-down' | 'move-left' | 'move-right' | 'alternative-gui-move-up' | 'alternative-gui-move-down' | 'alternative-gui-move-left' | 'alternative-gui-move-right' | 'open-character-gui' | 'open-gui' | 'confirm-gui' | 'toggle-free-cursor' | 'mine' | 'build' | 'build-ghost' | 'super-forced-build' | 'clear-cursor' | 'pipette' | 'rotate' | 'reverse-rotate' | 'flip-horizontal' | 'flip-vertical' | 'pick-items' | 'drop-cursor' | 'show-info' | 'shoot-enemy' | 'shoot-selected' | 'next-weapon' | 'toggle-driving' | 'zoom-in' | 'zoom-out' | 'use-item' | 'alternative-use-item' | 'toggle-console' | 'copy-entity-settings' | 'paste-entity-settings' | 'controller-gui-logistics-tab' | 'controller-gui-character-tab' | 'controller-gui-crafting-tab' | 'toggle-rail-layer' | 'select-for-blueprint' | 'select-for-cancel-deconstruct' | 'select-for-super-forced-deconstruct' | 'reverse-select' | 'alt-reverse-select' | 'deselect' | 'cycle-blueprint-forwards' | 'cycle-blueprint-backwards' | 'focus-search' | 'larger-terrain-building-area' | 'smaller-terrain-building-area' | 'remove-pole-cables' | 'build-with-obstacle-avoidance' | 'add-station' | 'add-temporary-station' | 'rename-all' | 'fast-wait-condition' | 'drag-map' | 'move-tag' | 'place-in-chat' | 'place-ping' | 'pin' | 'activate-tooltip' | 'next-surface' | 'previous-surface' | 'cycle-quality-up' | 'cycle-quality-down' | 'scroll-tooltip-up' | 'scroll-tooltip-down' | 'craft' | 'craft-5' | 'craft-all' | 'cancel-craft' | 'cancel-craft-5' | 'cancel-craft-all' | 'pick-item' | 'stack-transfer' | 'inventory-transfer' | 'fast-entity-transfer' | 'cursor-split' | 'stack-split' | 'inventory-split' | 'fast-entity-split' | 'toggle-filter' | 'open-item' | 'copy-inventory-filter' | 'paste-inventory-filter' | 'show-quick-panel' | 'next-quick-panel-page' | 'previous-quick-panel-page' | 'next-quick-panel-tab' | 'previous-quick-panel-tab' | 'rotate-active-quick-bars' | 'next-active-quick-bar' | 'previous-active-quick-bar' | 'quick-bar-button-1' | 'quick-bar-button-2' | 'quick-bar-button-3' | 'quick-bar-button-4' | 'quick-bar-button-5' | 'quick-bar-button-6' | 'quick-bar-button-7' | 'quick-bar-button-8' | 'quick-bar-button-9' | 'quick-bar-button-10' | 'quick-bar-button-1-secondary' | 'quick-bar-button-2-secondary' | 'quick-bar-button-3-secondary' | 'quick-bar-button-4-secondary' | 'quick-bar-button-5-secondary' | 'quick-bar-button-6-secondary' | 'quick-bar-button-7-secondary' | 'quick-bar-button-8-secondary' | 'quick-bar-button-9-secondary' | 'quick-bar-button-10-secondary' | 'action-bar-select-page-1' | 'action-bar-select-page-2' | 'action-bar-select-page-3' | 'action-bar-select-page-4' | 'action-bar-select-page-5' | 'action-bar-select-page-6' | 'action-bar-select-page-7' | 'action-bar-select-page-8' | 'action-bar-select-page-9' | 'action-bar-select-page-10' | 'copy' | 'cut' | 'paste' | 'cycle-clipboard-forwards' | 'cycle-clipboard-backwards' | 'undo' | 'redo' | 'toggle-menu' | 'toggle-map' | 'close-menu' | 'open-technology-gui' | 'production-statistics' | 'logistic-networks' | 'toggle-blueprint-library' | 'open-trains-gui' | 'open-factoriopedia' | 'back' | 'forward' | 'pause-game' | 'confirm-message' | 'previous-mod' | 'connect-train' | 'disconnect-train' | 'submit-feedback' | 'editor-next-variation' | 'editor-previous-variation' | 'editor-clone-item' | 'editor-delete-item' | 'editor-toggle-pause' | 'editor-tick-once' | 'editor-speed-up' | 'editor-speed-down' | 'editor-reset-speed' | 'editor-set-clone-brush-source' | 'editor-set-clone-brush-destination' | 'editor-switch-to-surface' | 'editor-remove-scripting-object' | 'debug-toggle-atlas-gui' | 'debug-toggle-gui-visibility' | 'debug-toggle-debug-settings' | 'debug-toggle-basic' | 'debug-reset-zoom' | 'debug-reset-zoom-2x' | 'toggle-gui-debug' | 'toggle-gui-style-view' | 'toggle-gui-shadows' | 'toggle-gui-glows' | 'open-prototypes-gui' | 'open-prototype-explorer-gui' | 'increase-ui-scale' | 'decrease-ui-scale' | 'reset-ui-scale' | 'slash-editor' | 'toggle-entity' | 'next-player-in-replay' | 'move-blueprint-absolute-grid-up' | 'move-blueprint-absolute-grid-down' | 'move-blueprint-absolute-grid-left' | 'move-blueprint-absolute-grid-right' | 'move-blueprint-entities-up' | 'move-blueprint-entities-down' | 'move-blueprint-entities-left' | 'move-blueprint-entities-right' | 'play-next-track' | 'play-previous-track' | 'pause-resume-music' | /**
6453
+ type LinkedGameControl = 'move-up' | 'move-down' | 'move-left' | 'move-right' | 'alternative-gui-move-up' | 'alternative-gui-move-down' | 'alternative-gui-move-left' | 'alternative-gui-move-right' | 'open-character-gui' | 'open-gui' | 'confirm-gui' | 'toggle-free-cursor' | 'mine' | 'build' | 'build-ghost' | 'super-forced-build' | 'clear-cursor' | 'pipette' | 'rotate' | 'reverse-rotate' | 'flip-horizontal' | 'flip-vertical' | 'pick-items' | 'drop-cursor' | 'show-info' | 'hide-tall-entities' | 'shoot-enemy' | 'shoot-selected' | 'next-weapon' | 'toggle-driving' | 'zoom-in' | 'zoom-out' | 'use-item' | 'alternative-use-item' | 'toggle-console' | 'copy-entity-settings' | 'paste-entity-settings' | 'controller-gui-logistics-tab' | 'controller-gui-character-tab' | 'controller-gui-crafting-tab' | 'toggle-rail-layer' | 'select-for-blueprint' | 'select-for-cancel-deconstruct' | 'select-for-super-forced-deconstruct' | 'reverse-select' | 'alt-reverse-select' | 'deselect' | 'cycle-blueprint-forwards' | 'cycle-blueprint-backwards' | 'focus-search' | 'larger-terrain-building-area' | 'smaller-terrain-building-area' | 'remove-pole-cables' | 'build-with-obstacle-avoidance' | 'add-station' | 'add-temporary-station' | 'rename-all' | 'fast-wait-condition' | 'drag-map' | 'move-tag' | 'place-in-chat' | 'place-ping' | 'pin' | 'activate-tooltip' | 'next-surface' | 'previous-surface' | 'cycle-quality-up' | 'cycle-quality-down' | 'scroll-tooltip-up' | 'scroll-tooltip-down' | 'visualize-entity-fluid-segments' | 'craft' | 'craft-5' | 'craft-all' | 'cancel-craft' | 'cancel-craft-5' | 'cancel-craft-all' | 'pick-item' | 'stack-transfer' | 'inventory-transfer' | 'fast-entity-transfer' | 'cursor-split' | 'stack-split' | 'inventory-split' | 'fast-entity-split' | 'toggle-filter' | 'open-item' | 'copy-inventory-filter' | 'paste-inventory-filter' | 'show-quick-panel' | 'next-quick-panel-page' | 'previous-quick-panel-page' | 'next-quick-panel-tab' | 'previous-quick-panel-tab' | 'rotate-active-quick-bars' | 'next-active-quick-bar' | 'previous-active-quick-bar' | 'quick-bar-button-1' | 'quick-bar-button-2' | 'quick-bar-button-3' | 'quick-bar-button-4' | 'quick-bar-button-5' | 'quick-bar-button-6' | 'quick-bar-button-7' | 'quick-bar-button-8' | 'quick-bar-button-9' | 'quick-bar-button-10' | 'quick-bar-button-1-secondary' | 'quick-bar-button-2-secondary' | 'quick-bar-button-3-secondary' | 'quick-bar-button-4-secondary' | 'quick-bar-button-5-secondary' | 'quick-bar-button-6-secondary' | 'quick-bar-button-7-secondary' | 'quick-bar-button-8-secondary' | 'quick-bar-button-9-secondary' | 'quick-bar-button-10-secondary' | 'action-bar-select-page-1' | 'action-bar-select-page-2' | 'action-bar-select-page-3' | 'action-bar-select-page-4' | 'action-bar-select-page-5' | 'action-bar-select-page-6' | 'action-bar-select-page-7' | 'action-bar-select-page-8' | 'action-bar-select-page-9' | 'action-bar-select-page-10' | 'copy' | 'cut' | 'paste' | 'cycle-clipboard-forwards' | 'cycle-clipboard-backwards' | 'undo' | 'redo' | 'toggle-menu' | 'toggle-map' | 'close-menu' | 'open-technology-gui' | 'production-statistics' | 'logistic-networks' | 'toggle-blueprint-library' | 'open-trains-gui' | 'open-factoriopedia' | 'back' | 'forward' | 'pause-game' | 'confirm-message' | 'previous-mod' | 'connect-train' | 'disconnect-train' | 'submit-feedback' | 'editor-next-variation' | 'editor-previous-variation' | 'editor-clone-item' | 'editor-delete-item' | 'editor-toggle-pause' | 'editor-tick-once' | 'editor-speed-up' | 'editor-speed-down' | 'editor-reset-speed' | 'editor-set-clone-brush-source' | 'editor-set-clone-brush-destination' | 'editor-switch-to-surface' | 'editor-remove-scripting-object' | 'debug-toggle-atlas-gui' | 'debug-toggle-gui-visibility' | 'debug-toggle-debug-settings' | 'debug-toggle-basic' | 'debug-reset-zoom' | 'debug-reset-zoom-2x' | 'toggle-gui-debug' | 'toggle-gui-style-view' | 'toggle-gui-shadows' | 'toggle-gui-glows' | 'open-prototypes-gui' | 'open-prototype-explorer-gui' | 'increase-ui-scale' | 'decrease-ui-scale' | 'reset-ui-scale' | 'slash-editor' | 'toggle-entity' | 'next-player-in-replay' | 'move-blueprint-absolute-grid-up' | 'move-blueprint-absolute-grid-down' | 'move-blueprint-absolute-grid-left' | 'move-blueprint-absolute-grid-right' | 'move-blueprint-entities-up' | 'move-blueprint-entities-down' | 'move-blueprint-entities-left' | 'move-blueprint-entities-right' | 'toggle-blueprint-snap-to-grid' | 'play-next-track' | 'play-previous-track' | 'pause-resume-music' | /**
5997
6454
  * Indicates no linked game control.
5998
6455
  */
5999
6456
  '';
6457
+ /**
6458
+ * Root style: `"list_box"`
6459
+ */
6000
6460
  interface ListBoxStyleSpecification extends BaseStyleSpecification {
6461
+ /**
6462
+ * Required on the root style.
6463
+ */
6001
6464
  item_style?: ButtonStyleSpecification;
6465
+ /**
6466
+ * Required on the root style.
6467
+ */
6002
6468
  scroll_pane_style?: ScrollPaneStyleSpecification;
6003
6469
  type: 'list_box_style';
6004
6470
  }
@@ -6051,24 +6517,7 @@ localised_description = {"", {"item-name.iron-plate"}, ": ", tostring(60)}
6051
6517
  */
6052
6518
  type LocalisedString = string | LocalisedString[];
6053
6519
  type LogisticFilterIndex = uint16;
6054
- /**
6055
- * The items generated when an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype} is killed.
6056
- */
6057
- interface LootItem {
6058
- /**
6059
- * Must be `> 0`.
6060
- */
6061
- count_max?: double;
6062
- count_min?: double;
6063
- /**
6064
- * The item to spawn.
6065
- */
6066
- item: ItemID;
6067
- /**
6068
- * `0` is 0% and `1` is 100%. Must be `> 0`.
6069
- */
6070
- probability?: double;
6071
- }
6520
+ type LogisticMode = 'active-provider' | 'passive-provider' | 'requester' | 'storage' | 'buffer';
6072
6521
  interface LowPowerTipTrigger extends CountBasedTipTrigger {
6073
6522
  type: 'low-power';
6074
6523
  }
@@ -6089,6 +6538,12 @@ interface MainSound {
6089
6538
  match_progress_to_activity?: boolean;
6090
6539
  match_speed_to_activity?: boolean;
6091
6540
  match_volume_to_activity?: boolean;
6541
+ /**
6542
+ * The `sound` is played when the entity has one the specified direction.
6543
+ *
6544
+ * Unused when {@link WorkingSound::persistent | prototype:WorkingSound::persistent} is `true`.
6545
+ */
6546
+ play_for_directions?: defines.direction[];
6092
6547
  /**
6093
6548
  * Array of {@link WorkingVisualisation::name | prototype:WorkingVisualisation::name}s, individual names cannot be empty.
6094
6549
  *
@@ -6127,24 +6582,6 @@ interface ManualWireDragTipTrigger extends CountBasedTipTrigger {
6127
6582
  type: 'manual-wire-drag';
6128
6583
  wire_type?: 'red' | 'green' | 'copper';
6129
6584
  }
6130
- interface MapEditorConstants {
6131
- cliff_editor_remove_cliffs_color: Color;
6132
- clone_editor_brush_cursor_preview_tint: Color;
6133
- clone_editor_brush_destination_color: Color;
6134
- clone_editor_brush_source_color: Color;
6135
- clone_editor_brush_world_preview_tint: Color;
6136
- clone_editor_copy_destination_allowed_color: Color;
6137
- clone_editor_copy_destination_not_allowed_color: Color;
6138
- clone_editor_copy_source_color: Color;
6139
- decorative_editor_selection_preview_radius: uint8;
6140
- decorative_editor_selection_preview_tint: Color;
6141
- force_editor_select_area_color: Color;
6142
- script_editor_drag_area_color: Color;
6143
- script_editor_select_area_color: Color;
6144
- tile_editor_area_selection_color: Color;
6145
- tile_editor_selection_preview_radius: uint8;
6146
- tile_editor_selection_preview_tint: Color;
6147
- }
6148
6585
  interface MapGenPreset {
6149
6586
  /**
6150
6587
  * If any setting is not set, it will use the default values.
@@ -6189,6 +6626,10 @@ interface MapGenPresetEnemyEvolutionSettings {
6189
6626
  }
6190
6627
  interface MapGenPresetEnemyExpansionSettings {
6191
6628
  enabled?: boolean;
6629
+ /**
6630
+ * Factor by which the evolution factor influences the size of the settler group
6631
+ */
6632
+ evolution_group_size_factor?: double;
6192
6633
  /**
6193
6634
  * In ticks.
6194
6635
  */
@@ -6201,6 +6642,10 @@ interface MapGenPresetEnemyExpansionSettings {
6201
6642
  * Ticks to expand to a single position for a base is used. Cooldown is calculated as follows: `cooldown = lerp(max_expansion_cooldown, min_expansion_cooldown, -e^2 + 2 * e)` where `lerp` is the linear interpolation function, and e is the current evolution factor.
6202
6643
  */
6203
6644
  min_expansion_cooldown?: uint32;
6645
+ /**
6646
+ * Distance in chunks from the furthest base around to prevent expansions from being too close to existing bases.
6647
+ */
6648
+ min_expansion_distance?: uint32;
6204
6649
  settler_group_max_size?: uint32;
6205
6650
  /**
6206
6651
  * Size of the group that goes to build new base (the game interpolates between min size and max size based on evolution factor).
@@ -6424,6 +6869,13 @@ interface MaterialTextureParameters {
6424
6869
  ```
6425
6870
  */
6426
6871
  type MathExpression = string;
6872
+ interface MaxCargoBayUnloadingDistanceModifier extends SimpleModifier {
6873
+ type: 'max-cargo-bay-unloading-distance';
6874
+ /**
6875
+ * If `false`, do not draw the small "constant" icon over the technology effect icon.
6876
+ */
6877
+ use_icon_overlay_constant?: boolean;
6878
+ }
6427
6879
  interface MaxFailedAttemptsPerTickPerConstructionQueueModifier extends SimpleModifier {
6428
6880
  type: 'max-failed-attempts-per-tick-per-construction-queue';
6429
6881
  /**
@@ -6507,12 +6959,18 @@ interface MinableProperties {
6507
6959
  transfer_entity_health_to_products?: boolean;
6508
6960
  }
6509
6961
  interface MineEntityTechnologyTrigger {
6510
- entity: EntityID;
6962
+ /**
6963
+ * Must contain at least 1 element. The trigger is considered fulfilled if at least one of these entities is mined.
6964
+ */
6965
+ entities: EntityID[];
6511
6966
  type: 'mine-entity';
6512
6967
  }
6513
6968
  interface MineItemByRobotTipTrigger extends CountBasedTipTrigger {
6514
6969
  type: 'mine-item-by-robot';
6515
6970
  }
6971
+ /**
6972
+ * Root style: `"minimap"`
6973
+ */
6516
6974
  interface MinimapStyleSpecification extends EmptyWidgetStyleSpecificationBase {
6517
6975
  type: 'minimap_style';
6518
6976
  }
@@ -6555,7 +7013,6 @@ interface MiningWithFluidModifier extends BoolModifier {
6555
7013
  */
6556
7014
  use_icon_overlay_constant?: boolean;
6557
7015
  }
6558
- type Mirroring = 'horizontal' | 'vertical' | 'diagonal-pos' | 'diagonal-neg';
6559
7016
  /**
6560
7017
  * The user-set value of a startup {@link mod setting | https://wiki.factorio.com/Tutorial:Mod_settings}.
6561
7018
  */
@@ -6685,12 +7142,18 @@ UnlockQualityModifier | /**
6685
7142
  * Loaded when the `type` is `"unlock-space-platforms"`.
6686
7143
  */
6687
7144
  SpacePlatformsModifier | /**
7145
+ * Loaded when the `type` is `"unlock-travel-to-space-platforms"`
7146
+ */
7147
+ TravelToSpacePlatformsModifier | /**
6688
7148
  * Loaded when the `type` is `"unlock-circuit-network"`.
6689
7149
  */
6690
7150
  CircuitNetworkModifier | /**
6691
7151
  * Loaded when the `type` is `"cargo-landing-pad-count"`.
6692
7152
  */
6693
7153
  CargoLandingPadLimitModifier | /**
7154
+ * Loaded when the `type` is `"max-cargo-bay-unloading-distance"`.
7155
+ */
7156
+ MaxCargoBayUnloadingDistanceModifier | /**
6694
7157
  * Loaded when the `type` is `"change-recipe-productivity"`.
6695
7158
  */
6696
7159
  ChangeRecipeProductivityModifier | /**
@@ -6714,7 +7177,10 @@ BeaconDistributionModifier | /**
6714
7177
  CreateGhostOnEntityDeathModifier | /**
6715
7178
  * Loaded when the `type` is `"belt-stack-size-bonus"`.
6716
7179
  */
6717
- BeltStackSizeBonusModifier;
7180
+ BeltStackSizeBonusModifier | /**
7181
+ * Loaded when the `type` is `"unlock-logistic-network"`.
7182
+ */
7183
+ UnlockLogisticNetworkModifier;
6718
7184
  /**
6719
7185
  * A dictionary of mod names to mod versions of all active mods. It can be used to adjust mod functionality based on the presence of other mods.
6720
7186
  * @example ```
@@ -6729,6 +7195,12 @@ end
6729
7195
  for name, version in pairs(mods) do
6730
7196
  log(name .. " version " .. version) -- => space-age version 2.0.7
6731
7197
  end
7198
+ ```
7199
+ * @example ```
7200
+ -- uses a features only available past a certain base mod version
7201
+ if helpers.compare_version(mods["base"], "2.0.56") >= 0 then
7202
+ use_new_features()
7203
+ end
6732
7204
  ```
6733
7205
  */
6734
7206
  type Mods = Record<string, string>;
@@ -6805,7 +7277,7 @@ interface NestedTriggerEffectItem extends TriggerEffectItem {
6805
7277
  *
6806
7278
  * - **Operator:** See the list below
6807
7279
  *
6808
- * Identifiers are used to name functions and variables. The built-in functions and variables are documented in the {@link auxiliary docs | runtime:noise-expressions}. Mods can define their own noise expressions which can be used as variables and functions. The entry points for this are {@link NamedNoiseFunction | prototype:NamedNoiseFunction} and {@link NamedNoiseExpression | prototype:NamedNoiseExpression} as well as local functions and expressions.
7280
+ * Identifiers are used to name functions and variables. The built-in functions and variables are documented in the {@link auxiliary docs | auxiliary:noise-expressions}. Mods can define their own noise expressions which can be used as variables and functions. The entry points for this are {@link NamedNoiseFunction | prototype:NamedNoiseFunction} and {@link NamedNoiseExpression | prototype:NamedNoiseExpression} as well as local functions and expressions.
6809
7281
  *
6810
7282
  * All functions accept both named and positional arguments. To differentiate between these function calls, positional arguments start/end with `(`/`)` and named arguments with `{`/`}`, e.g. `clamp(x, -1, 1)` and `clamp{min = -1, max = 1, value = x}` are the same function call. Because of this, positional arguments can't be mixed with named arguments. A function can't have more than 255 parameters.
6811
7283
  *
@@ -7178,6 +7650,18 @@ type PersistentWorldAmbientSoundsDefinitionCrossfade = Fade & {
7178
7650
  ];
7179
7651
  };
7180
7652
  interface PipeConnectionDefinition {
7653
+ /**
7654
+ * Direction this connection should be facing when entity direction is north-east. When entity is rotated, effective direction will be computed based on this value.
7655
+ *
7656
+ * Only loaded if `connection_type` is `"normal"` or `"underground"`.
7657
+ */
7658
+ alt_direction?: defines.direction;
7659
+ /**
7660
+ * Relative position of the pipe connection when entity direction is north-east.
7661
+ *
7662
+ * Only loaded if `connection_type` is `"normal"` or `"underground"`.
7663
+ */
7664
+ alt_position?: MapPosition;
7181
7665
  /**
7182
7666
  * Fluidboxes' pipe connections are only allowed to connect with each other if they share a connection category. For example a mod could have a "steam pipes" and "cryogenic pipes" category that should not connect with each other.
7183
7667
  *
@@ -7210,6 +7694,10 @@ interface PipeConnectionDefinition {
7210
7694
  * Allowed direction of fluid flow at this connection. Pipeline entities (`pipe`, `pipe-to-ground`, and `storage-tank`) do not support this property.
7211
7695
  */
7212
7696
  flow_direction?: FluidFlowDirection;
7697
+ /**
7698
+ * If true, connection arrows and fluid icons will not be drawn for this connection when the entity is selected or in alt-mode.
7699
+ */
7700
+ hide_connection_info?: boolean;
7213
7701
  /**
7214
7702
  * Expected to be unique inside of a single entity. Used to uniquely identify where a linked connection should connect to.
7215
7703
  *
@@ -7391,6 +7879,170 @@ interface PlanetPrototypeMapGenSettings {
7391
7879
  property_expression_names?: Record<string, string | boolean | double>;
7392
7880
  territory_settings?: TerritorySettings;
7393
7881
  }
7882
+ interface PlatformBackdrop {
7883
+ /**
7884
+ * Color of atmospheric light. Multiplied by 10 in shader.
7885
+ */
7886
+ atmosphere_color?: Color;
7887
+ /**
7888
+ * Color of dawn side of terminator light. Multiplied by 10 in shader.
7889
+ */
7890
+ atmosphere_ray_light_color_1?: Color;
7891
+ /**
7892
+ * Color of dusk side of terminator light. Multiplied by 10 in shader.
7893
+ */
7894
+ atmosphere_ray_light_color_2?: Color;
7895
+ /**
7896
+ * Width of the atmosphere layer as portion of the total radius.
7897
+ */
7898
+ atmosphere_thickness?: float;
7899
+ /**
7900
+ * Intensity of the flow map effect. Begins to degenerate at high values.
7901
+ */
7902
+ cloud_flow_intensity?: float;
7903
+ /**
7904
+ * How many seconds it takes the flow effect to loop.
7905
+ */
7906
+ cloud_flow_seconds?: float;
7907
+ cloud_normal_intensity?: float;
7908
+ /**
7909
+ * Rotational speed of the clouds laterally across the planet relative to `rotation_seconds` of the planet. `-1.0` means it counteracts the rotation rate and makes clouds remain in place. `0.0` means it drifts along with planet surface.
7910
+ */
7911
+ cloud_panning_rate?: float;
7912
+ /**
7913
+ * How far below the atmosphere layer should the clouds be.
7914
+ */
7915
+ cloud_vertical_offset?: float;
7916
+ /**
7917
+ * Amount of cloud texture to be used based off of the alpha channel of the cloud texture.
7918
+ */
7919
+ cloudiness?: float;
7920
+ emission_scalar?: float;
7921
+ /**
7922
+ * When true only the dark side will receive emission.
7923
+ */
7924
+ emission_scales_with_shadow?: boolean;
7925
+ /**
7926
+ * Scales the speed at which the planet appears in view when flown towards.
7927
+ */
7928
+ flight_approach_speed?: float;
7929
+ /**
7930
+ * Cloud mapped over the planet as the surface texture.
7931
+ */
7932
+ global_cloud?: EffectTexture;
7933
+ /**
7934
+ * Flow map distorting the global cloud.
7935
+ */
7936
+ global_cloud_flow?: EffectTexture;
7937
+ global_cloud_normal?: EffectTexture;
7938
+ /**
7939
+ * Sprite or Animation to be referenced by `hero_clouds` definitions with `sprite_index` 1.
7940
+ */
7941
+ hero_cloud_texture_1?: Animation;
7942
+ /**
7943
+ * Sprite or Animation to be referenced by `hero_clouds` definitions with `sprite_index` 2.
7944
+ */
7945
+ hero_cloud_texture_2?: Animation;
7946
+ /**
7947
+ * Sprite or Animation to be referenced by `hero_clouds` definitions with `sprite_index` 3.
7948
+ */
7949
+ hero_cloud_texture_3?: Animation;
7950
+ /**
7951
+ * Individual Hero Cloud decals over the planet surface. The maximum number is four.
7952
+ */
7953
+ hero_clouds?: PlatformBackdropHeroCloud[];
7954
+ /**
7955
+ * When true the hero clouds will add their color to emission as well.
7956
+ */
7957
+ hero_clouds_are_emissive?: boolean;
7958
+ /**
7959
+ * Color of light. Multiplied by 10 in shader.
7960
+ */
7961
+ light_color?: Color;
7962
+ light_direction?: Vector3D;
7963
+ /**
7964
+ * Harshness of the terminator. Functions like atmosphere thickness.
7965
+ */
7966
+ light_intensity_contrast?: float;
7967
+ /**
7968
+ * Perceived size of the light. Also affects size of the specular spot.
7969
+ */
7970
+ light_radius?: float;
7971
+ /**
7972
+ * How strongly the planet moves with camera. `{1.0, 1.0}` means it tracks the starfield. `{0.0, 0.0}` means it tracks the foreground tiles.
7973
+ */
7974
+ parallax_strength?: Vector;
7975
+ /**
7976
+ * Tilt and pitch of the planet axis.
7977
+ */
7978
+ planet_axis?: Vector;
7979
+ /**
7980
+ * How much tilt and pitch vary over time.
7981
+ */
7982
+ planet_axis_deviation_amplitude?: Vector;
7983
+ /**
7984
+ * Number of seconds it takes for tilt and pitch to complete one cycle of deviation.
7985
+ */
7986
+ planet_axis_deviation_seconds?: Vector;
7987
+ /**
7988
+ * Emissive light added to the surface. Can be disabled on lit side using the `emission_scales_with_shadow` property.
7989
+ */
7990
+ planet_emission?: EffectTexture;
7991
+ /**
7992
+ * Normal map of the surface deforming local sphere normal.
7993
+ */
7994
+ planet_normal?: EffectTexture;
7995
+ /**
7996
+ * Glossiness of the surface in red channel.
7997
+ */
7998
+ planet_reflectivity?: EffectTexture;
7999
+ /**
8000
+ * Wrapped around the surface of the sphere using equirectangular projection.
8001
+ */
8002
+ planet_surface?: EffectTexture;
8003
+ position?: Vector;
8004
+ radius?: float;
8005
+ /**
8006
+ * How many seconds it takes for the planet to do one revolution.
8007
+ */
8008
+ rotation_seconds?: float;
8009
+ /**
8010
+ * Color of specular light. Multiplied by 10 in shader.
8011
+ */
8012
+ specular_color?: Color;
8013
+ specular_intensity?: float;
8014
+ surface_normal_intensity?: float;
8015
+ /**
8016
+ * How far below the atmosphere layer should the surface be.
8017
+ */
8018
+ surface_vertical_offset?: float;
8019
+ }
8020
+ interface PlatformBackdropHeroCloud {
8021
+ /**
8022
+ * Random position offset of the cloud animation. Refreshed every loop.
8023
+ */
8024
+ position_deviation?: Vector;
8025
+ /**
8026
+ * With each planet revolution, the cloud smoothly travels along this path by approximating the provided points. If only single position is provided, it remains stationary at that point.
8027
+ */
8028
+ positions?: Vector[];
8029
+ projection_style?: 'none' | 'front-only' | 'front-and-back' | 'front-and-back-inverted';
8030
+ rotate_with_planet?: boolean;
8031
+ rotation_deviation?: float;
8032
+ rotation_speed?: float;
8033
+ /**
8034
+ * Cloud size as a proportion of the total planet size, meaning `1` spans whole planet.
8035
+ */
8036
+ size?: Vector;
8037
+ /**
8038
+ * 1, 2, 3 use cloud sprites 1, 2, 3 respectively. 0 will disable this cloud. Anything else is invalid.
8039
+ */
8040
+ sprite_index?: uint8;
8041
+ /**
8042
+ * Random frame offset of the cloud animation if the graphic is an animation.
8043
+ */
8044
+ starting_frame_offset?: uint16;
8045
+ }
7394
8046
  /**
7395
8047
  * Defines when controller vibrations should be played.
7396
8048
  */
@@ -7894,7 +8546,29 @@ ItemProductPrototype | /**
7894
8546
  * Loaded when the `type` is `"fluid"`.
7895
8547
  */
7896
8548
  FluidProductPrototype;
8549
+ interface ProductPrototypeBase {
8550
+ /**
8551
+ * Value between 0 and 1. When a product has probability set, a probability roll is performed when trying to give product: if probability roll fails then product is not given. This value controls threshold of the independent probability roll, which means if there are multiple products to be given, they may use different roll value causing products to all be given, some of them given or none of them given at all.
8552
+ */
8553
+ independent_probability?: double;
8554
+ /**
8555
+ * A range of values where lower end is at at least at value of 0 and upper end is at most at value of 1. This range is used as part of shared probability test: When a set of products is attempted to be given, there is a single random generator roll performed that gives a value from range `[0, 1)`. This rolled value is compared to ranges of all products that are given at the same time. In order for the product to be given, the roll must test to be within this range, meaning `roll >= min && roll < max` must be true. If the test fails, then the product is not given.
8556
+ *
8557
+ * Note: for a product to be given, both independent_probability test and shared_probability tests must pass. That means probability values seen in gui are equal to `independent_probability * (shared_probability.max - shared_probability.min)`
8558
+ *
8559
+ * Note: ranges between different products are independent, that means they are allowed to overlap. This may be used to create set of products that are always given in pairs if ranges are equal or to make products that are given exclusively (one or the other) if the ranges do not overlap.
8560
+ */
8561
+ shared_probability?: SharedProbabilityDefinition;
8562
+ /**
8563
+ * When hovering over a recipe in the crafting menu the recipe tooltip will be shown. An additional item tooltip will be shown for every product, as a separate tooltip, if the item tooltip has a description and/or properties to show and if `show_details_in_recipe_tooltip` is `true`.
8564
+ */
8565
+ show_details_in_recipe_tooltip?: boolean;
8566
+ }
7897
8567
  interface ProductionHealthEffect {
8568
+ /**
8569
+ * Defaults to "physical" damage.
8570
+ */
8571
+ damage_type?: DamageTypeID;
7898
8572
  not_producing?: float;
7899
8573
  producing?: float;
7900
8574
  }
@@ -7924,22 +8598,50 @@ interface ProgrammableSpeakerNote {
7924
8598
  */
7925
8599
  sound?: Sound;
7926
8600
  }
8601
+ /**
8602
+ * Root style: `"progressbar"`
8603
+ */
7927
8604
  interface ProgressBarStyleSpecification extends BaseStyleSpecification {
8605
+ /**
8606
+ * Required on the root style.
8607
+ */
7928
8608
  bar?: ElementImageSet;
8609
+ /**
8610
+ * Required on the root style.
8611
+ */
7929
8612
  bar_background?: ElementImageSet;
7930
8613
  /**
7931
8614
  * The thickness of the bar, not the horizontal size.
8615
+ *
8616
+ * Required on the root style.
7932
8617
  */
7933
8618
  bar_width?: uint32;
8619
+ /**
8620
+ * Required on the root style.
8621
+ */
7934
8622
  color?: Color;
8623
+ /**
8624
+ * Required on the root style.
8625
+ */
7935
8626
  embed_text_in_bar?: boolean;
7936
8627
  filled_font_color?: Color;
7937
8628
  /**
7938
8629
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
8630
+ *
8631
+ * Required on the root style.
7939
8632
  */
7940
8633
  font?: string;
8634
+ /**
8635
+ * Required on the root style.
8636
+ */
7941
8637
  font_color?: Color;
8638
+ /**
8639
+ * Required on the root style.
8640
+ */
7942
8641
  other_colors?: OtherColors[];
8642
+ /**
8643
+ * Required on the root style.
8644
+ */
7943
8645
  side_text_padding?: int16;
7944
8646
  type: 'progressbar_style';
7945
8647
  }
@@ -7975,6 +8677,10 @@ interface ProjectileTriggerDelivery extends TriggerDeliveryItem {
7975
8677
  * Maximum deviation of the projectile from source orientation, in +/- (`x radians / 2`). Example: `3.14 radians -> +/- (180° / 2)`, meaning up to 90° deviation in either direction of rotation.
7976
8678
  */
7977
8679
  direction_deviation?: float;
8680
+ /**
8681
+ * If `true`, the projectile will inherit any positive speed component from the source entity's movement toward the target.
8682
+ */
8683
+ inherit_speed?: boolean;
7978
8684
  max_range?: double;
7979
8685
  min_range?: double;
7980
8686
  /**
@@ -8034,77 +8740,54 @@ interface PuddleTileEffectParameters {
8034
8740
  water_effect?: TileEffectDefinitionID;
8035
8741
  water_effect_parameters?: WaterTileEffectParameters;
8036
8742
  }
8037
- /**
8038
- * A mapping of arrays of {@link PumpConnectorGraphicsAnimations | prototype:PumpConnectorGraphicsAnimation} to all 4 directions of the pump connection (to a fluid wagon).
8039
- * @example ```
8040
- load_animations =
8041
- {
8042
- west =
8043
- {
8044
- [1] =
8045
- {
8046
- standup_base =
8047
- {
8048
- filename = "__base__/graphics/entity/pump/connector/V-R-135-load-standup-base.png",
8049
- width = 110,
8050
- height = 126,
8051
- scale = 0.5,
8052
- line_length = 1,
8053
- frame_count = 20,
8054
- shift = util.by_pixel(-23.5, -13.5)
8055
- },
8056
- standup_shadow =
8057
- {
8058
- filename = "__base__/graphics/entity/pump/connector/V-R-1-load-standup-base-shadow.png",
8059
- width = 157,
8060
- height = 136,
8061
- scale = 0.5,
8062
- line_length = 1,
8063
- frame_count = 20,
8064
- shift = util.by_pixel(-8.75, 8.5)
8065
- },
8066
- },
8067
- [2] =
8068
- {
8069
- standup_base = { ... },
8070
- standup_shadow = { ... },
8071
- connector_shadow = { ... },
8072
- },
8073
- [3] = { ... },
8074
- [4] = { ... },
8075
- [5] = { ... },
8076
- [6] = { ... },
8077
- },
8078
- north = { ... },
8079
- east = { ... },
8080
- south = { ... },
8081
- }
8082
- ```
8083
- */
8084
- interface PumpConnectorGraphics {
8743
+ interface PumpWagonConnectionGraphics {
8744
+ base?: BasePumpWagonConnectionAnimations;
8745
+ /**
8746
+ * Value between 0 and 1 (both exclusive). The base animation will play up until the connecting progress reaches the value. Needs to be less than `clamp_animation_starts_at_progress`. The arm (`part_1` and `part_2`) will rotate and extend in the time in between.
8747
+ */
8748
+ base_animation_finished_at_progress?: double;
8085
8749
  /**
8086
- * Size of the array must be 6 or more.
8750
+ * Value between 0 and 1 (both exclusive). The clamp animation will play up starting when the connecting progress reaches the value. Needs to be larger than `base_animation_finished_at_progress`. The arm (`part_1` and `part_2`) will rotate and extend in the time in between.
8087
8751
  */
8088
- east: PumpConnectorGraphicsAnimation[];
8752
+ clamp_animation_starts_at_progress?: double;
8753
+ clamp_y_shift?: float;
8754
+ height_diff_to_wagon?: float;
8755
+ part1_to_2_shift?: Vector;
8089
8756
  /**
8090
- * Size of the array must be 6 or more.
8757
+ * Adjusts where the sprites will be cropped
8091
8758
  */
8092
- north: PumpConnectorGraphicsAnimation[];
8759
+ part2_crop_adjustment?: float;
8093
8760
  /**
8094
- * Size of the array must be 6 or more.
8761
+ * Adjusts where the sprites will be cropped
8095
8762
  */
8096
- south: PumpConnectorGraphicsAnimation[];
8763
+ part2_shadow_crop_adjustment?: float;
8097
8764
  /**
8098
- * Size of the array must be 6 or more.
8765
+ * Rotating top part.
8099
8766
  */
8100
- west: PumpConnectorGraphicsAnimation[];
8767
+ part_1?: RotatedSprite;
8768
+ part_1_shadow?: RotatedSprite;
8769
+ /**
8770
+ * Rotating arm.
8771
+ */
8772
+ part_2?: RotatedSprite;
8773
+ part_2_shadow?: RotatedSprite;
8774
+ /**
8775
+ * Projected render rest position of `suction_clamp` relative to the parent pump position.
8776
+ */
8777
+ resting_position_shift?: PumpWagonConnectionShift4Way;
8778
+ shadow_shift?: Vector;
8779
+ suction_clamp?: Animation;
8780
+ suction_clamp_shadow?: Animation;
8781
+ /**
8782
+ * Relative projected render position of `part_1` to the parent pump position.
8783
+ */
8784
+ top_pivot_shift?: PumpWagonConnectionShift4Way;
8101
8785
  }
8102
- interface PumpConnectorGraphicsAnimation {
8103
- connector?: Animation;
8104
- connector_shadow?: Animation;
8105
- standup_base?: Animation;
8106
- standup_shadow?: Animation;
8107
- standup_top?: Animation;
8786
+ interface PumpWagonConnectionShift4Way {
8787
+ east: Vector;
8788
+ north: Vector;
8789
+ south: Vector;
8790
+ west: Vector;
8108
8791
  }
8109
8792
  /**
8110
8793
  * The push back effect used by the {@link discharge defense | https://wiki.factorio.com/Discharge_defense}.
@@ -8125,13 +8808,27 @@ interface PushBackTriggerEffectItem extends TriggerEffectItem {
8125
8808
  ```
8126
8809
  */
8127
8810
  type QualityID = string;
8811
+ /**
8812
+ * Root style: `"radiobutton"`
8813
+ */
8128
8814
  interface RadioButtonStyleSpecification extends StyleWithClickableGraphicalSetSpecification {
8815
+ /**
8816
+ * Required on the root style.
8817
+ */
8129
8818
  disabled_font_color?: Color;
8130
8819
  /**
8131
8820
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
8821
+ *
8822
+ * Required on the root style.
8132
8823
  */
8133
8824
  font?: string;
8825
+ /**
8826
+ * Required on the root style.
8827
+ */
8134
8828
  font_color?: Color;
8829
+ /**
8830
+ * Required on the root style.
8831
+ */
8135
8832
  text_padding?: uint32;
8136
8833
  type: 'radiobutton_style';
8137
8834
  }
@@ -8157,6 +8854,14 @@ interface RadiusVisualisationSpecification {
8157
8854
  * This distance is silently overwritten by prototypes with a custom distance: {@link AgriculturalTowerPrototype::radius | prototype:AgriculturalTowerPrototype::radius}, {@link AsteroidCollectorPrototype::collection_radius | prototype:AsteroidCollectorPrototype::collection_radius}, {@link BeaconPrototype::supply_area_distance | prototype:BeaconPrototype::supply_area_distance}, {@link ElectricPolePrototype::supply_area_distance | prototype:ElectricPolePrototype::supply_area_distance}, {@link MiningDrillPrototype::resource_searching_radius | prototype:MiningDrillPrototype::resource_searching_radius}.
8158
8855
  */
8159
8856
  distance?: double;
8857
+ /**
8858
+ * Each value must be >= 0.01.
8859
+ *
8860
+ * If value is not provided for a quality, then `1` will be used as a multiplier instead.
8861
+ *
8862
+ * This does not affect the visualisation of prototypes with a custom distance specification because their distance automatically scales based on quality: agricultural tower (no quality scaling), {@link asteroid collector | prototype:QualityPrototype::asteroid_collector_collection_radius_bonus}, {@link beacon | prototype:QualityPrototype::beacon_supply_area_distance_bonus}, cargo landing pad (no quality scaling), {@link electric pole | prototype:QualityPrototype::electric_pole_supply_area_distance_bonus}, and {@link mining drill | prototype:QualityPrototype::mining_drill_mining_radius_bonus}.
8863
+ */
8864
+ distance_quality_multiplier?: LuaTable<QualityID, double>;
8160
8865
  draw_in_cursor?: boolean;
8161
8866
  draw_on_selection?: boolean;
8162
8867
  /**
@@ -8168,7 +8873,7 @@ interface RadiusVisualisationSpecification {
8168
8873
  /**
8169
8874
  * The sprite to show.
8170
8875
  *
8171
- * This sprite is silently overwritten by prototypes with a custom radius picture: {@link AgriculturalTowerPrototype::radius_visualisation_picture | prototype:AgriculturalTowerPrototype::radius_visualisation_picture}, {@link AsteroidCollectorPrototype::radius_visualisation_picture | prototype:AsteroidCollectorPrototype::radius_visualisation_picture}, {@link BeaconPrototype::radius_visualisation_picture | prototype:BeaconPrototype::radius_visualisation_picture}, {@link ElectricPolePrototype::radius_visualisation_picture | prototype:ElectricPolePrototype::radius_visualisation_picture}, {@link MiningDrillPrototype::radius_visualisation_picture | prototype:MiningDrillPrototype::radius_visualisation_picture}.
8876
+ * This sprite is silently overwritten by prototypes with a custom radius picture: {@link AgriculturalTowerPrototype::radius_visualisation_picture | prototype:AgriculturalTowerPrototype::radius_visualisation_picture}, {@link AsteroidCollectorPrototype::radius_visualisation_picture | prototype:AsteroidCollectorPrototype::radius_visualisation_picture}, {@link BeaconPrototype::radius_visualisation_picture | prototype:BeaconPrototype::radius_visualisation_picture}, {@link CargoLandingPadPrototype::radius_visualisation_picture | prototype:CargoLandingPadPrototype::radius_visualisation_picture}, {@link ElectricPolePrototype::radius_visualisation_picture | prototype:ElectricPolePrototype::radius_visualisation_picture}, {@link MiningDrillPrototype::radius_visualisation_picture | prototype:MiningDrillPrototype::radius_visualisation_picture}.
8172
8877
  */
8173
8878
  sprite?: Sprite;
8174
8879
  }
@@ -8484,6 +9189,21 @@ interface Resistance {
8484
9189
  */
8485
9190
  type ResourceCategoryID = string;
8486
9191
  type RichTextSetting = 'enabled' | 'disabled' | 'highlight';
9192
+ interface RobotDoorSpecification {
9193
+ /**
9194
+ * Drawn when a robot brings/takes items from this entity.
9195
+ */
9196
+ animation?: Animation;
9197
+ /**
9198
+ * Played when a robot brings/takes items from this entity. Only loaded if `animation` is defined.
9199
+ */
9200
+ animation_sound?: Sound;
9201
+ /**
9202
+ * The offset from the center of this entity where a robot visually brings/takes items.
9203
+ */
9204
+ location_offset?: Vector;
9205
+ opened_duration?: uint8;
9206
+ }
8487
9207
  interface RollingStockRotatedSlopedGraphics {
8488
9208
  rotated: RotatedSprite;
8489
9209
  slope_angle_between_frames?: double;
@@ -8754,8 +9474,14 @@ interface ScrollBarStyleSpecification extends BaseStyleSpecification {
8754
9474
  background_graphical_set?: ElementImageSet;
8755
9475
  thumb_button_style?: ButtonStyleSpecification;
8756
9476
  }
9477
+ /**
9478
+ * Root style: `"scroll_pane"`
9479
+ */
8757
9480
  interface ScrollPaneStyleSpecification extends BaseStyleSpecification {
8758
9481
  always_draw_borders?: boolean;
9482
+ /**
9483
+ * Required on the root style.
9484
+ */
8759
9485
  background_graphical_set?: ElementImageSet;
8760
9486
  dont_force_clipping_rect_for_contents?: boolean;
8761
9487
  extra_bottom_margin_when_activated?: int32;
@@ -8774,11 +9500,23 @@ interface ScrollPaneStyleSpecification extends BaseStyleSpecification {
8774
9500
  extra_right_padding_when_activated?: int32;
8775
9501
  extra_top_margin_when_activated?: int32;
8776
9502
  extra_top_padding_when_activated?: int32;
9503
+ /**
9504
+ * Required on the root style.
9505
+ */
8777
9506
  graphical_set?: ElementImageSet;
9507
+ /**
9508
+ * Required on the root style.
9509
+ */
8778
9510
  horizontal_scrollbar_style?: HorizontalScrollBarStyleSpecification;
8779
9511
  scrollbars_go_outside?: boolean;
8780
9512
  type: 'scroll_pane_style';
9513
+ /**
9514
+ * Required on the root style.
9515
+ */
8781
9516
  vertical_flow_style?: VerticalFlowStyleSpecification;
9517
+ /**
9518
+ * Required on the root style.
9519
+ */
8782
9520
  vertical_scrollbar_style?: VerticalScrollBarStyleSpecification;
8783
9521
  }
8784
9522
  /**
@@ -8808,6 +9546,18 @@ interface SelectionModeData {
8808
9546
  entity_filter_mode?: 'whitelist' | 'blacklist';
8809
9547
  entity_filters?: EntityID[];
8810
9548
  entity_type_filters?: string[];
9549
+ /**
9550
+ * If this is `false`, using any of the mode flags `"blueprint"`, `"deconstruct"`, `"cancel-deconstruct"`, `"upgrade"`, `"cancel-upgrade"` or `"downgrade"` without also specifying another flag that selects entities will result in an error, because the selection tool cannot select any entities and this is likely undesired behavior.
9551
+ *
9552
+ * Setting this to `true` disables this error.
9553
+ */
9554
+ ignore_cannot_select_entities?: boolean;
9555
+ /**
9556
+ * If this is `false`, using any of the mode flags `"blueprint"` or `"deconstruct"` without also specifying any flag that selects tiles will result in an error, because the selection tool cannot select any tiles and this is likely undesired behavior.
9557
+ *
9558
+ * Setting this to `true` disables this error.
9559
+ */
9560
+ ignore_cannot_select_tiles?: boolean;
8811
9561
  mode: SelectionModeFlags;
8812
9562
  play_ended_sound_when_nothing_selected?: boolean;
8813
9563
  started_sound?: Sound;
@@ -8820,13 +9570,13 @@ interface SelectionModeData {
8820
9570
  * Some flags only exclude objects from the selection, meaning they need to be combined with another flag to select anything.
8821
9571
  */
8822
9572
  type SelectionModeFlags = (/**
8823
- * Selects entities and tiles as if selecting them for a blueprint.
9573
+ * Excludes entities and tiles that can't be selected for blueprinting.
8824
9574
  */
8825
9575
  'blueprint' | /**
8826
- * Selects entities and tiles as if selecting them for deconstruction.
9576
+ * Excludes entities and tiles that can't be selected for deconstruction.
8827
9577
  */
8828
9578
  'deconstruct' | /**
8829
- * Selects entities and tiles as if selecting them for deconstruction cancellation.
9579
+ * Excludes entities that can't be selected for deconstruction cancellation.
8830
9580
  */
8831
9581
  'cancel-deconstruct' | /**
8832
9582
  * Selects items on the ground.
@@ -8862,13 +9612,13 @@ type SelectionModeFlags = (/**
8862
9612
  * Excludes entities that are not from an enemy force from the selection.
8863
9613
  */
8864
9614
  'enemy' | /**
8865
- * Selects entities as if selecting them for upgrading.
9615
+ * Excludes entities that can't be selected for upgrading.
8866
9616
  */
8867
9617
  'upgrade' | /**
8868
- * Selects entities as if selecting them for upgrade cancellation.
9618
+ * Excludes entities that can't be selected for upgrade cancellation.
8869
9619
  */
8870
9620
  'cancel-upgrade' | /**
8871
- * Selects entities as if selecting them for downgrading.
9621
+ * Excludes entities that can't be selected for downgrading.
8872
9622
  */
8873
9623
  'downgrade' | /**
8874
9624
  * Selects entities that are an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype}.
@@ -8892,13 +9642,13 @@ type SelectionModeFlags = (/**
8892
9642
  * Selects entities that are a {@link TileGhostPrototype | prototype:TileGhostPrototype}.
8893
9643
  */
8894
9644
  'tile-ghost') | (/**
8895
- * Selects entities and tiles as if selecting them for a blueprint.
9645
+ * Excludes entities and tiles that can't be selected for blueprinting.
8896
9646
  */
8897
9647
  'blueprint' | /**
8898
- * Selects entities and tiles as if selecting them for deconstruction.
9648
+ * Excludes entities and tiles that can't be selected for deconstruction.
8899
9649
  */
8900
9650
  'deconstruct' | /**
8901
- * Selects entities and tiles as if selecting them for deconstruction cancellation.
9651
+ * Excludes entities that can't be selected for deconstruction cancellation.
8902
9652
  */
8903
9653
  'cancel-deconstruct' | /**
8904
9654
  * Selects items on the ground.
@@ -8934,13 +9684,13 @@ type SelectionModeFlags = (/**
8934
9684
  * Excludes entities that are not from an enemy force from the selection.
8935
9685
  */
8936
9686
  'enemy' | /**
8937
- * Selects entities as if selecting them for upgrading.
9687
+ * Excludes entities that can't be selected for upgrading.
8938
9688
  */
8939
9689
  'upgrade' | /**
8940
- * Selects entities as if selecting them for upgrade cancellation.
9690
+ * Excludes entities that can't be selected for upgrade cancellation.
8941
9691
  */
8942
9692
  'cancel-upgrade' | /**
8943
- * Selects entities as if selecting them for downgrading.
9693
+ * Excludes entities that can't be selected for downgrading.
8944
9694
  */
8945
9695
  'downgrade' | /**
8946
9696
  * Selects entities that are an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype}.
@@ -9008,7 +9758,7 @@ interface SetTileTriggerEffectItem extends TriggerEffectItem {
9008
9758
  apply_on_space_platform?: boolean;
9009
9759
  apply_projection?: boolean;
9010
9760
  radius: float;
9011
- tile_collision_mask?: CollisionMaskConnector;
9761
+ tile_collision_mask?: TileCollisionMaskConnector;
9012
9762
  tile_name: TileID;
9013
9763
  type: 'set-tile';
9014
9764
  }
@@ -9025,6 +9775,16 @@ interface Settings {
9025
9775
  */
9026
9776
  startup: Record<string, ModSetting>;
9027
9777
  }
9778
+ interface SharedProbabilityDefinition {
9779
+ /**
9780
+ * Upper end of the range of shared roll values that will allow product to be given. Must be >= `min` and <= `1`.
9781
+ */
9782
+ max: double;
9783
+ /**
9784
+ * Lower end of the range of shared roll values that will allow product to be given. Must be >= `0` and <= `max`.
9785
+ */
9786
+ min: double;
9787
+ }
9028
9788
  interface ShiftAnimationWaypoints {
9029
9789
  east: Vector[];
9030
9790
  north: Vector[];
@@ -9047,6 +9807,10 @@ interface SignalIDConnectorBase {
9047
9807
  * Name of the signal.
9048
9808
  */
9049
9809
  name: VirtualSignalID | ItemID | FluidID | RecipeID | EntityID | SpaceLocationID | AsteroidChunkID | QualityID;
9810
+ /**
9811
+ * Defaults to `normal`.
9812
+ */
9813
+ quality?: QualityID;
9050
9814
  type: string;
9051
9815
  }
9052
9816
  /**
@@ -9097,11 +9861,11 @@ interface SimulationDefinition {
9097
9861
  /**
9098
9862
  * Only loaded if `init_file` is not defined.
9099
9863
  *
9100
- * This code is run as a (silent) console command inside the simulation when it is first initialized. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | runtime:libraries}.
9864
+ * This code is run as a (silent) console command inside the simulation when it is first initialized. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | auxiliary:libraries}.
9101
9865
  */
9102
9866
  init?: string;
9103
9867
  /**
9104
- * This code is run as a (silent) console command inside the simulation when it is first initialized. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | runtime:libraries}.
9868
+ * This code is run as a (silent) console command inside the simulation when it is first initialized. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | auxiliary:libraries}.
9105
9869
  */
9106
9870
  init_file?: FileName;
9107
9871
  /**
@@ -9136,11 +9900,11 @@ interface SimulationDefinition {
9136
9900
  /**
9137
9901
  * Only loaded if `update_file` is not defined.
9138
9902
  *
9139
- * This code is run as a (silent) console command inside the simulation every time the simulation is updated. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | runtime:libraries}.
9903
+ * This code is run as a (silent) console command inside the simulation every time the simulation is updated. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | auxiliary:libraries}.
9140
9904
  */
9141
9905
  update?: string;
9142
9906
  /**
9143
- * This code is run as a (silent) console command inside the simulation every time the simulation is updated. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | runtime:libraries}.
9907
+ * This code is run as a (silent) console command inside the simulation every time the simulation is updated. Since this is run as a console command, the restrictions of console commands apply, e.g. `require` is not available, see {@link here | auxiliary:libraries}.
9144
9908
  */
9145
9909
  update_file?: FileName;
9146
9910
  /**
@@ -9234,14 +9998,41 @@ interface SingleGraphicProcessionLayer {
9234
9998
  shift_rotates_with_pod?: boolean;
9235
9999
  type: 'single-graphic';
9236
10000
  }
10001
+ /**
10002
+ * Root style: `"slider"`
10003
+ */
9237
10004
  interface SliderStyleSpecificationBase extends BaseStyleSpecification {
10005
+ /**
10006
+ * Required on the root style.
10007
+ */
9238
10008
  button?: ButtonStyleSpecification;
10009
+ /**
10010
+ * Required on the root style.
10011
+ */
9239
10012
  draw_notches?: boolean;
10013
+ /**
10014
+ * Required on the root style.
10015
+ */
9240
10016
  empty_bar?: ElementImageSet;
10017
+ /**
10018
+ * Required on the root style.
10019
+ */
9241
10020
  empty_bar_disabled?: ElementImageSet;
10021
+ /**
10022
+ * Required on the root style.
10023
+ */
9242
10024
  full_bar?: ElementImageSet;
10025
+ /**
10026
+ * Required on the root style.
10027
+ */
9243
10028
  full_bar_disabled?: ElementImageSet;
10029
+ /**
10030
+ * Required on the root style.
10031
+ */
9244
10032
  high_button?: ButtonStyleSpecification;
10033
+ /**
10034
+ * Required on the root style.
10035
+ */
9245
10036
  notch?: ElementImageSet;
9246
10037
  type: string;
9247
10038
  }
@@ -9380,6 +10171,10 @@ type Sound = {
9380
10171
  } | SoundDefinition | SoundDefinition[];
9381
10172
  interface SoundAccent {
9382
10173
  frame?: uint16;
10174
+ /**
10175
+ * The `sound` is played when the entity has one the specified direction.
10176
+ */
10177
+ play_for_directions?: defines.direction[];
9383
10178
  /**
9384
10179
  * Play the `sound` for a working visualisation of a given {@link WorkingVisualisation::name | prototype:WorkingVisualisation::name}.
9385
10180
  *
@@ -9434,7 +10229,7 @@ interface SoundModifier {
9434
10229
  type: SoundModifierType;
9435
10230
  volume_multiplier: float;
9436
10231
  }
9437
- type SoundModifierType = 'game' | 'main-menu' | 'tips-and-tricks' | 'driving' | 'elevation' | 'space-platform';
10232
+ type SoundModifierType = 'game' | 'main-menu' | 'tips-and-tricks' | 'driving' | 'elevation' | 'space-platform' | 'tall-entities-hidden';
9438
10233
  /**
9439
10234
  * This defines which slider in the sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.
9440
10235
  */
@@ -9544,15 +10339,41 @@ type SpawnPoint = {
9544
10339
  double,
9545
10340
  double
9546
10341
  ];
10342
+ /**
10343
+ * Root style: `"speech_bubble"`
10344
+ */
9547
10345
  interface SpeechBubbleStyleSpecification extends BaseStyleSpecification {
10346
+ /**
10347
+ * Required on the root style.
10348
+ */
9548
10349
  arrow_graphical_set?: ElementImageSet;
10350
+ /**
10351
+ * Required on the root style.
10352
+ */
9549
10353
  arrow_indent?: double;
10354
+ /**
10355
+ * Required on the root style.
10356
+ */
9550
10357
  close_color?: Color;
10358
+ /**
10359
+ * Required on the root style.
10360
+ */
9551
10361
  frame_style?: FrameStyleSpecification;
10362
+ /**
10363
+ * Required on the root style.
10364
+ */
9552
10365
  label_style?: LabelStyleSpecification;
10366
+ /**
10367
+ * Required on the root style.
10368
+ */
9553
10369
  pass_through_mouse?: boolean;
9554
10370
  type: 'speech_bubble_style';
9555
10371
  }
10372
+ interface SpentFluidSpecification {
10373
+ amount?: double;
10374
+ name: FluidID;
10375
+ temperature?: float;
10376
+ }
9556
10377
  /**
9557
10378
  * Used by {@link SpiderVehiclePrototype | prototype:SpiderVehiclePrototype}.
9558
10379
  */
@@ -9651,7 +10472,13 @@ interface SpiderTorsoGraphicsSet {
9651
10472
  base_animation?: RotatedAnimation;
9652
10473
  base_render_layer?: RenderLayer;
9653
10474
  render_layer?: RenderLayer;
10475
+ /**
10476
+ * If no sprite flags are defined, then this animation is loaded and treated as a shadow by default.
10477
+ */
9654
10478
  shadow_animation?: RotatedAnimation;
10479
+ /**
10480
+ * If no sprite flags are defined, then this animation is loaded and treated as a shadow by default.
10481
+ */
9655
10482
  shadow_base_animation?: RotatedAnimation;
9656
10483
  /**
9657
10484
  * Refer to {@link EntityPrototype::water_reflection | prototype:EntityPrototype::water_reflection}.
@@ -9904,14 +10731,56 @@ type Sprite4Way = {
9904
10731
  *
9905
10732
  * Only loaded if `north` is defined.
9906
10733
  */
9907
- south?: Sprite;
10734
+ south?: Sprite;
10735
+ /**
10736
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10737
+ *
10738
+ * Only loaded if `north` is defined.
10739
+ */
10740
+ west?: Sprite;
10741
+ } | Sprite;
10742
+ /**
10743
+ * A map of sprites for 8 directions of the entity.
10744
+ */
10745
+ interface Sprite8Way {
10746
+ /**
10747
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10748
+ */
10749
+ east?: Sprite;
10750
+ /**
10751
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10752
+ */
10753
+ north?: Sprite;
10754
+ /**
10755
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10756
+ */
10757
+ north_east?: Sprite;
10758
+ /**
10759
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10760
+ */
10761
+ north_west?: Sprite;
10762
+ /**
10763
+ * Only loaded if `sheets` is not defined.
10764
+ */
10765
+ sheet?: SpriteNWaySheet;
10766
+ sheets?: SpriteNWaySheet[];
10767
+ /**
10768
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10769
+ */
10770
+ south?: Sprite;
10771
+ /**
10772
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10773
+ */
10774
+ south_east?: Sprite;
10775
+ /**
10776
+ * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
10777
+ */
10778
+ south_west?: Sprite;
9908
10779
  /**
9909
10780
  * Only loaded, and mandatory if both `sheets` and `sheet` are not defined.
9910
- *
9911
- * Only loaded if `north` is defined.
9912
10781
  */
9913
10782
  west?: Sprite;
9914
- } | Sprite;
10783
+ }
9915
10784
  /**
9916
10785
  * An array containing the following values.
9917
10786
  * @example ```
@@ -9951,7 +10820,13 @@ type SpriteFlags = (/**
9951
10820
  'smoke' | /**
9952
10821
  * This flag will internally set these flags: `"group=decal"`
9953
10822
  */
9954
- 'decal' | 'low-object' | 'corpse-decay' | 'trilinear-filtering' | 'group=none' | 'group=terrain' | 'group=shadow' | 'group=smoke' | 'group=decal' | 'group=low-object' | 'group=gui' | 'group=icon' | 'group=icon-background' | 'group=effect-texture')[];
10823
+ 'decal' | 'low-object' | 'corpse-decay' | 'trilinear-filtering' | /**
10824
+ * This flag will internally set these flags: `"linear-minification"`, `"linear-magnification"`, `"group=procession-cover"`
10825
+ */
10826
+ 'procession-cover' | /**
10827
+ * This flag will internally limit colors to only RG and set these flags: `"no-crop"`, `"not-compressed"`
10828
+ */
10829
+ 'normal-map' | 'group=none' | 'group=terrain' | 'group=shadow' | 'group=smoke' | 'group=decal' | 'group=low-object' | 'group=gui' | 'group=icon' | 'group=icon-background' | 'group=procession' | 'group=procession-cover' | 'group=effect-texture')[];
9955
10830
  /**
9956
10831
  * @example ```
9957
10832
  sheet =
@@ -9966,6 +10841,10 @@ sheet =
9966
10841
  ```
9967
10842
  */
9968
10843
  interface SpriteNWaySheet extends SpriteParameters {
10844
+ /**
10845
+ * Specifies for how many directions each frame is used. Silently forced to always be at least `1`.
10846
+ */
10847
+ frame_repeat?: uint32;
9969
10848
  /**
9970
10849
  * Specifies how many of the directions of the SpriteNWay are filled up with this sheet.
9971
10850
  */
@@ -10034,7 +10913,7 @@ interface SpriteParameters extends SpriteSource {
10034
10913
  usage?: SpriteUsageHint;
10035
10914
  }
10036
10915
  /**
10037
- * This sets the "caching priority" of a sprite, so deciding priority of it being included in VRAM instead of streaming it and is therefore a purely technical value. See {@link here | https://forums.factorio.com/viewtopic.php?p=437380#p437380} and {@link here | https://www.factorio.com/blog/post/fff-264}. The possible values are listed below.
10916
+ * This sets the caching priority of a sprite, influencing whether it is kept in VRAM or streamed from disk in VRAM-limited situations. See {@link here | https://forums.factorio.com/viewtopic.php?p=437380#p437380} and {@link here | https://www.factorio.com/blog/post/fff-264} for context.
10038
10917
  */
10039
10918
  type SpritePriority = 'extra-high-no-scale' | 'extra-high' | 'high' | 'medium' | 'low' | 'very-low' | 'no-atlas';
10040
10919
  interface SpriteSheet extends SpriteParameters {
@@ -10077,6 +10956,12 @@ interface SpriteSource {
10077
10956
  * If `true`, the sprite may be downsampled to half its size on load even when 'Sprite quality' graphics setting is set to 'High'. Whether downsampling happens depends on detected hardware and other graphics settings.
10078
10957
  */
10079
10958
  allow_forced_downscale?: boolean;
10959
+ /**
10960
+ * All textures have 4 channels by default. This property can be used for no-atlas textures to force their format to R, RG, RGB or RGBA with 8 bytes for each channel and save VRAM space. Compression setting is based on player config.
10961
+ *
10962
+ * We use BC4 compression for R, BC5 for RG, BC1 for RGB, and DXT5_BC3 for RGBA, see "{@link S3 Texture Compression | https://en.wikipedia.org/wiki/S3_Texture_Compression}" to read more about compression ratios.
10963
+ */
10964
+ color_channels?: 1 | 2 | 3 | 4;
10080
10965
  /**
10081
10966
  * The path to the sprite file to use.
10082
10967
  * This property is required, but marked as optional due to typescript inheritance limitations
@@ -10167,16 +11052,12 @@ interface StackTransferTipTrigger extends CountBasedTipTrigger {
10167
11052
  type: 'stack-transfer';
10168
11053
  }
10169
11054
  interface StateSteeringSettings {
10170
- /**
10171
- * Used only for special "to look good" purposes (like in trailer).
10172
- */
10173
- force_unit_fuzzy_goto_behavior: boolean;
10174
11055
  /**
10175
11056
  * Not including the radius of the unit.
10176
11057
  */
10177
- radius: double;
10178
- separation_factor: double;
10179
- separation_force: double;
11058
+ radius?: double;
11059
+ separation_factor?: double;
11060
+ separation_force?: double;
10180
11061
  }
10181
11062
  interface StatelessVisualisation {
10182
11063
  acceleration_x?: float;
@@ -10259,8 +11140,12 @@ interface StatusColors {
10259
11140
  working?: Color;
10260
11141
  }
10261
11142
  interface SteeringSettings {
10262
- default: StateSteeringSettings;
10263
- moving: StateSteeringSettings;
11143
+ /**
11144
+ * Used only for special "to look good" purposes (like in trailer).
11145
+ */
11146
+ force_unit_fuzzy_goto_behavior?: boolean;
11147
+ move?: StateSteeringSettings;
11148
+ stay?: StateSteeringSettings;
10264
11149
  }
10265
11150
  interface StorageTankPictures {
10266
11151
  flow_sprite?: Sprite;
@@ -10465,60 +11350,164 @@ interface SurfaceRenderParameters {
10465
11350
  */
10466
11351
  draw_sprite_clouds?: boolean;
10467
11352
  fog?: FogEffectProperties;
11353
+ platform_backdrop?: PlatformBackdrop;
10468
11354
  shadow_opacity?: float;
10469
11355
  space_dust_background?: SpaceDustEffectProperties;
10470
11356
  space_dust_foreground?: SpaceDustEffectProperties;
10471
11357
  terrain_tint_effect?: GlobalTintEffectProperties;
10472
11358
  }
11359
+ /**
11360
+ * Root style: `"switch"`
11361
+ */
10473
11362
  interface SwitchStyleSpecification extends BaseStyleSpecification {
11363
+ /**
11364
+ * Required on the root style.
11365
+ */
10474
11366
  active_label?: LabelStyleSpecification;
11367
+ /**
11368
+ * Required on the root style.
11369
+ */
10475
11370
  button?: ButtonStyleSpecification;
11371
+ /**
11372
+ * Required on the root style.
11373
+ */
10476
11374
  default_background?: Sprite;
11375
+ /**
11376
+ * Required on the root style.
11377
+ */
10477
11378
  disabled_background?: Sprite;
11379
+ /**
11380
+ * Required on the root style.
11381
+ */
10478
11382
  hover_background?: Sprite;
11383
+ /**
11384
+ * Required on the root style.
11385
+ */
10479
11386
  inactive_label?: LabelStyleSpecification;
11387
+ /**
11388
+ * Required on the root style.
11389
+ */
10480
11390
  left_button_position?: uint32;
11391
+ /**
11392
+ * Required on the root style.
11393
+ */
10481
11394
  middle_button_position?: uint32;
11395
+ /**
11396
+ * Required on the root style.
11397
+ */
10482
11398
  right_button_position?: uint32;
10483
11399
  type: 'switch_style';
10484
11400
  }
11401
+ /**
11402
+ * Root style: `"tab"`
11403
+ */
10485
11404
  interface TabStyleSpecification extends StyleWithClickableGraphicalSetSpecification {
10486
11405
  /**
10487
11406
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
11407
+ *
11408
+ * Required on the root style.
10488
11409
  */
10489
11410
  badge_font?: string;
11411
+ /**
11412
+ * Required on the root style.
11413
+ */
10490
11414
  badge_horizontal_spacing?: int16;
11415
+ /**
11416
+ * Required on the root style.
11417
+ */
10491
11418
  default_badge_font_color?: Color;
11419
+ /**
11420
+ * Required on the root style.
11421
+ */
10492
11422
  default_badge_graphical_set?: ElementImageSet;
11423
+ /**
11424
+ * Required on the root style.
11425
+ */
10493
11426
  default_font_color?: Color;
11427
+ /**
11428
+ * Required on the root style.
11429
+ */
10494
11430
  disabled_badge_font_color?: Color;
11431
+ /**
11432
+ * Required on the root style.
11433
+ */
10495
11434
  disabled_badge_graphical_set?: ElementImageSet;
11435
+ /**
11436
+ * Required on the root style.
11437
+ */
10496
11438
  disabled_font_color?: Color;
10497
11439
  draw_grayscale_picture?: boolean;
10498
11440
  /**
10499
11441
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
11442
+ *
11443
+ * Required on the root style.
10500
11444
  */
10501
11445
  font?: string;
11446
+ /**
11447
+ * Required on the root style.
11448
+ */
10502
11449
  hover_badge_graphical_set?: ElementImageSet;
11450
+ /**
11451
+ * Required on the root style.
11452
+ */
10503
11453
  increase_height_when_selected?: boolean;
11454
+ /**
11455
+ * Required on the root style.
11456
+ */
10504
11457
  left_edge_selected_graphical_set?: ElementImageSet;
11458
+ /**
11459
+ * Required on the root style.
11460
+ */
10505
11461
  override_graphics_on_edges?: boolean;
11462
+ /**
11463
+ * Required on the root style.
11464
+ */
10506
11465
  press_badge_graphical_set?: ElementImageSet;
11466
+ /**
11467
+ * Required on the root style.
11468
+ */
10507
11469
  right_edge_selected_graphical_set?: ElementImageSet;
11470
+ /**
11471
+ * Required on the root style.
11472
+ */
10508
11473
  selected_badge_font_color?: Color;
11474
+ /**
11475
+ * Required on the root style.
11476
+ */
10509
11477
  selected_badge_graphical_set?: ElementImageSet;
11478
+ /**
11479
+ * Required on the root style.
11480
+ */
10510
11481
  selected_font_color?: Color;
10511
11482
  type: 'tab_style';
10512
11483
  }
11484
+ /**
11485
+ * Root style: `"tabbed_pane"`
11486
+ */
10513
11487
  interface TabbedPaneStyleSpecification extends BaseStyleSpecification {
11488
+ /**
11489
+ * Required on the root style.
11490
+ */
10514
11491
  tab_container?: TableStyleSpecification;
11492
+ /**
11493
+ * Required on the root style.
11494
+ */
10515
11495
  tab_content_frame?: FrameStyleSpecification;
10516
11496
  type: 'tabbed_pane_style';
11497
+ /**
11498
+ * Required on the root style.
11499
+ */
10517
11500
  vertical_spacing?: uint32;
10518
11501
  }
11502
+ /**
11503
+ * Root style: `"table"`
11504
+ */
10519
11505
  interface TableStyleSpecification extends BaseStyleSpecification {
10520
11506
  apply_row_graphical_set_per_column?: boolean;
10521
11507
  background_graphical_set?: ElementImageSet;
11508
+ /**
11509
+ * Required on the root style.
11510
+ */
10522
11511
  border?: BorderImageSet;
10523
11512
  bottom_cell_padding?: int16;
10524
11513
  /**
@@ -10534,6 +11523,9 @@ interface TableStyleSpecification extends BaseStyleSpecification {
10534
11523
  default_row_graphical_set?: ElementImageSet;
10535
11524
  even_row_graphical_set?: ElementImageSet;
10536
11525
  horizontal_line_color?: Color;
11526
+ /**
11527
+ * Required on the root style.
11528
+ */
10537
11529
  horizontal_spacing?: int32 | SpacingItem[];
10538
11530
  hovered_graphical_set?: ElementImageSet;
10539
11531
  hovered_row_color?: Color;
@@ -10549,6 +11541,9 @@ interface TableStyleSpecification extends BaseStyleSpecification {
10549
11541
  top_cell_padding?: int16;
10550
11542
  type: 'table_style';
10551
11543
  vertical_line_color?: Color;
11544
+ /**
11545
+ * Required on the root style.
11546
+ */
10552
11547
  vertical_spacing?: int32 | SpacingItem[];
10553
11548
  wide_as_column_count?: boolean;
10554
11549
  }
@@ -10562,46 +11557,149 @@ interface TableStyleSpecification extends BaseStyleSpecification {
10562
11557
  ```
10563
11558
  */
10564
11559
  type TechnologyID = string;
11560
+ /**
11561
+ * Root style: `"technology_slot"`
11562
+ */
10565
11563
  interface TechnologySlotStyleSpecification extends ButtonStyleSpecificationBase {
11564
+ /**
11565
+ * Required on the root style.
11566
+ */
10566
11567
  clicked_ingredients_background?: ElementImageSet;
11568
+ /**
11569
+ * Required on the root style.
11570
+ */
10567
11571
  clicked_overlay?: ElementImageSet;
11572
+ /**
11573
+ * Required on the root style.
11574
+ */
10568
11575
  default_background_shadow?: ElementImageSet;
11576
+ /**
11577
+ * Required on the root style.
11578
+ */
10569
11579
  default_ingredients_background?: ElementImageSet;
11580
+ /**
11581
+ * Required on the root style.
11582
+ */
10570
11583
  disabled_ingredients_background?: ElementImageSet;
11584
+ /**
11585
+ * Required on the root style.
11586
+ */
10571
11587
  drag_handle_style?: EmptyWidgetStyleSpecification;
11588
+ /**
11589
+ * Required on the root style.
11590
+ */
10572
11591
  highlighted_graphical_set?: ElementImageSet;
11592
+ /**
11593
+ * Required on the root style.
11594
+ */
10573
11595
  highlighted_ingredients_background?: ElementImageSet;
11596
+ /**
11597
+ * Required on the root style.
11598
+ */
10574
11599
  hovered_ingredients_background?: ElementImageSet;
11600
+ /**
11601
+ * Required on the root style.
11602
+ */
10575
11603
  hovered_level_band?: ElementImageSet;
11604
+ /**
11605
+ * Required on the root style.
11606
+ */
10576
11607
  hovered_level_font_color?: Color;
11608
+ /**
11609
+ * Required on the root style.
11610
+ */
10577
11611
  hovered_level_range_band?: ElementImageSet;
11612
+ /**
11613
+ * Required on the root style.
11614
+ */
10578
11615
  hovered_level_range_font_color?: Color;
11616
+ /**
11617
+ * Required on the root style.
11618
+ */
10579
11619
  ingredient_icon_overlap?: uint32;
11620
+ /**
11621
+ * Required on the root style.
11622
+ */
10580
11623
  ingredient_icon_size?: uint32;
11624
+ /**
11625
+ * Required on the root style.
11626
+ */
10581
11627
  ingredients_height?: uint32;
11628
+ /**
11629
+ * Required on the root style.
11630
+ */
10582
11631
  ingredients_padding?: uint32;
11632
+ /**
11633
+ * Required on the root style.
11634
+ */
10583
11635
  level_band?: ElementImageSet;
11636
+ /**
11637
+ * Required on the root style.
11638
+ */
10584
11639
  level_band_height?: uint32;
11640
+ /**
11641
+ * Required on the root style.
11642
+ */
10585
11643
  level_band_width?: uint32;
10586
11644
  /**
10587
11645
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
11646
+ *
11647
+ * Required on the root style.
10588
11648
  */
10589
11649
  level_font?: string;
11650
+ /**
11651
+ * Required on the root style.
11652
+ */
10590
11653
  level_font_color?: Color;
11654
+ /**
11655
+ * Required on the root style.
11656
+ */
10591
11657
  level_offset_x?: int32;
11658
+ /**
11659
+ * Required on the root style.
11660
+ */
10592
11661
  level_offset_y?: int32;
11662
+ /**
11663
+ * Required on the root style.
11664
+ */
10593
11665
  level_range_band?: ElementImageSet;
10594
11666
  /**
10595
11667
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
11668
+ *
11669
+ * Required on the root style.
10596
11670
  */
10597
11671
  level_range_font?: string;
11672
+ /**
11673
+ * Required on the root style.
11674
+ */
10598
11675
  level_range_font_color?: Color;
11676
+ /**
11677
+ * Required on the root style.
11678
+ */
10599
11679
  level_range_offset_x?: int32;
11680
+ /**
11681
+ * Required on the root style.
11682
+ */
10600
11683
  level_range_offset_y?: int32;
11684
+ /**
11685
+ * Required on the root style.
11686
+ */
10601
11687
  progress_bar?: ElementImageSet;
11688
+ /**
11689
+ * Required on the root style.
11690
+ */
10602
11691
  progress_bar_background?: ElementImageSet;
11692
+ /**
11693
+ * Required on the root style.
11694
+ */
10603
11695
  progress_bar_color?: Color;
11696
+ /**
11697
+ * Required on the root style.
11698
+ */
10604
11699
  progress_bar_height?: uint32;
11700
+ /**
11701
+ * Required on the root style.
11702
+ */
10605
11703
  progress_bar_shadow?: ElementImageSet;
10606
11704
  type: 'technology_slot_style';
10607
11705
  }
@@ -10673,7 +11771,7 @@ interface TechnologyUnit {
10673
11771
  */
10674
11772
  count_formula?: MathExpression;
10675
11773
  /**
10676
- * List of ingredients needed for one unit of research. The items must all be {@link ToolPrototypes | prototype:ToolPrototype}.
11774
+ * List of ingredients needed for one unit of research.
10677
11775
  */
10678
11776
  ingredients: ResearchIngredient[];
10679
11777
  /**
@@ -10699,24 +11797,71 @@ interface TerritorySettings {
10699
11797
  */
10700
11798
  units?: EntityID[];
10701
11799
  }
11800
+ /**
11801
+ * Root style: `"textbox"`
11802
+ */
10702
11803
  interface TextBoxStyleSpecification extends BaseStyleSpecification {
11804
+ /**
11805
+ * Required on the root style.
11806
+ */
10703
11807
  active_background?: ElementImageSet;
11808
+ /**
11809
+ * Required on the root style.
11810
+ */
10704
11811
  default_background?: ElementImageSet;
11812
+ /**
11813
+ * Required on the root style.
11814
+ */
10705
11815
  disabled_background?: ElementImageSet;
11816
+ /**
11817
+ * Required on the root style.
11818
+ */
10706
11819
  disabled_font_color?: Color;
10707
11820
  /**
10708
11821
  * Name of a {@link FontPrototype | prototype:FontPrototype}.
11822
+ *
11823
+ * Required on the root style.
10709
11824
  */
10710
11825
  font?: string;
11826
+ /**
11827
+ * Required on the root style.
11828
+ */
10711
11829
  font_color?: Color;
11830
+ /**
11831
+ * Required on the root style.
11832
+ */
10712
11833
  game_controller_hovered_background?: ElementImageSet;
11834
+ /**
11835
+ * Required on the root style.
11836
+ */
10713
11837
  rich_text_highlight_error_color?: Color;
11838
+ /**
11839
+ * Required on the root style.
11840
+ */
10714
11841
  rich_text_highlight_ok_color?: Color;
11842
+ /**
11843
+ * Required on the root style.
11844
+ */
10715
11845
  rich_text_highlight_warning_color?: Color;
11846
+ /**
11847
+ * Required on the root style.
11848
+ */
10716
11849
  rich_text_setting?: RichTextSetting;
11850
+ /**
11851
+ * Required on the root style.
11852
+ */
10717
11853
  selected_rich_text_highlight_error_color?: Color;
11854
+ /**
11855
+ * Required on the root style.
11856
+ */
10718
11857
  selected_rich_text_highlight_ok_color?: Color;
11858
+ /**
11859
+ * Required on the root style.
11860
+ */
10719
11861
  selected_rich_text_highlight_warning_color?: Color;
11862
+ /**
11863
+ * Required on the root style.
11864
+ */
10720
11865
  selection_background_color?: Color;
10721
11866
  type: 'textbox_style';
10722
11867
  }
@@ -10774,9 +11919,18 @@ interface TileBuildSound {
10774
11919
  */
10775
11920
  interface TileBuildabilityRule {
10776
11921
  area: SimpleBoundingBox;
10777
- colliding_tiles?: CollisionMaskConnector;
11922
+ colliding_tiles?: TileCollisionMaskConnector;
10778
11923
  remove_on_collision?: boolean;
10779
- required_tiles?: CollisionMaskConnector;
11924
+ required_tiles?: TileCollisionMaskConnector;
11925
+ }
11926
+ /**
11927
+ * The base game provides common collision mask functions in a Lua file in the core {@link lualib | https://github.com/wube/factorio-data/blob/master/core/lualib/collision-mask-util.lua}.
11928
+ */
11929
+ interface TileCollisionMaskConnector {
11930
+ /**
11931
+ * Every key in the dictionary is the name of one {@link layer | prototype:CollisionLayerPrototype} the object collides with. The value is meaningless and always `true`. An empty table means that no layers are set.
11932
+ */
11933
+ layers: Record<CollisionLayerID, true>;
10780
11934
  }
10781
11935
  /**
10782
11936
  * The name of an {@link TileEffectDefinition | prototype:TileEffectDefinition}.
@@ -11739,6 +12893,85 @@ interface TransportBeltConnectorFrame {
11739
12893
  frame_main_scanner_vertical_y_scale: float;
11740
12894
  frame_shadow: AnimationVariations;
11741
12895
  }
12896
+ interface TravelToSpacePlatformsModifier extends BoolModifier {
12897
+ type: 'unlock-travel-to-space-platforms';
12898
+ /**
12899
+ * If `false`, do not draw the small "constant" icon over the technology effect icon.
12900
+ */
12901
+ use_icon_overlay_constant?: boolean;
12902
+ }
12903
+ /**
12904
+ * {@link TreePrototype | prototype:TreePrototype}s develop over time. To introduce visual fidelity, the shape of the plant is shrunk and distorted using a warp texture, and it slowly retracts back into its grown state.
12905
+ */
12906
+ interface TreeGrowth {
12907
+ /**
12908
+ * Encodes the initial UV offset at a given pixel, used to sample {@link TreeGrowth::trunk_warp | prototype:TreeGrowth::trunk_warp}.
12909
+ *
12910
+ * The offset is calculated like in the following pseudocode:
12911
+ * ```
12912
+ * vec2 growthWarpLinear = vec2((growthWarp.r - 0.5) * 2 * pow(time, 2.546872), 0);
12913
+ * vec2 growthWarpQuadratic = (uv - vec2(0.3, 0.2)) * pow(growthWarp.g * pow(time, 4.06187), 2) * 1000;
12914
+ * vec2 growthWarpUVOffset = clamp(growthWarpLinear + growthWarpQuadratic + uv, 0, 1);
12915
+ * ```
12916
+ */
12917
+ growth_warp: Sprite;
12918
+ /**
12919
+ * Encodes the point in time (0-1) since the plant started growing, at which a given pixel of the *leaves* texture becomes visible.
12920
+ *
12921
+ * This is a grayscale texture where white is t=0 (beginning of growth) and black is t=1 (end of growth).
12922
+ */
12923
+ harvest_alpha: Sprite;
12924
+ /**
12925
+ * Encodes the UV offset at a given pixel, used to sample the leaves texture.
12926
+ *
12927
+ * The final UV is calculated like in the following pseudocode:
12928
+ * ```
12929
+ * vec2 harvestWarpLinear = (harvestWarp.rg - 0.5) * 2 * pow(time, 2.546872);
12930
+ * vec2 harvestUV = clamp(trunkUV + harvestWarpLinear, 0, 1);
12931
+ * ```
12932
+ *
12933
+ * See {@link TreeGrowth::trunk_warp | prototype:TreeGrowth::trunk_warp} for how `trunkUV` is calculated.
12934
+ */
12935
+ harvest_warp: Sprite;
12936
+ /**
12937
+ * Exponent for the easing function of the growth progress (progress ^ progressExponent) which is used by the growth animation.
12938
+ */
12939
+ progress_exponent: float;
12940
+ /**
12941
+ * Encodes the point in time (0-1) since the plant started growing, at which a given pixel of the *shadow* texture becomes visible.
12942
+ *
12943
+ * This is a grayscale texture where white is t=0 (beginning of growth) and black is t=1 (end of growth).
12944
+ */
12945
+ shadow_alpha: Sprite;
12946
+ /**
12947
+ * Encodes the UV offset at a given pixel, used to sample the shadow texture.
12948
+ *
12949
+ * The final UV is calculated like in the following pseudocode:
12950
+ * ```
12951
+ * vec2 shadowWarpLinear = (shadowWarp.rg - 0.5) * 2 * pow(time, 2.546872);
12952
+ * vec2 shadowUV = clamp(uv + shadowWarpLinear, 0, 1);
12953
+ * ```
12954
+ */
12955
+ shadow_warp: Sprite;
12956
+ /**
12957
+ * Encodes the point in time (0-1) since the plant started growing, at which a given pixel of the *trunk* texture becomes visible.
12958
+ *
12959
+ * This is a grayscale texture where white is t=0 (beginning of growth) and black is t=1 (end of growth).
12960
+ */
12961
+ trunk_alpha: Sprite;
12962
+ /**
12963
+ * Encodes the UV offset at a given pixel, used to sample the trunk texture, and {@link TreeGrowth::harvest_warp | prototype:TreeGrowth::harvest_warp}.
12964
+ *
12965
+ * The final UV is calculated like in the following pseudocode:
12966
+ * ```
12967
+ * vec2 trunkWarpLinear = (trunkWarp.rg - 0.5) * 2 * pow(time, 2.546872);
12968
+ * vec2 trunkUV = clamp(growthWarpUVOffset + trunkWarpLinear + growthWarpQuadratic, 0, 1);
12969
+ * ```
12970
+ *
12971
+ * See {@link TreeGrowth::growth_warp | prototype:TreeGrowth::growth_warp} for how `growthWarpQuadratic` and `growthWarpUVOffset` are calculated.
12972
+ */
12973
+ trunk_warp: Sprite;
12974
+ }
11742
12975
  /**
11743
12976
  * 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.
11744
12977
  */
@@ -11919,7 +13152,10 @@ DestroyDecorativesTriggerEffectItem | /**
11919
13152
  CameraEffectTriggerEffectItem | /**
11920
13153
  * Loaded when the `type` is `"activate-impact"`.
11921
13154
  */
11922
- ActivateImpactTriggerEffectItem) | (/**
13155
+ ActivateImpactTriggerEffectItem | /**
13156
+ * Loaded when the `type` is `"create-pollution"`.
13157
+ */
13158
+ CreatePollutionTriggerEffectItem) | (/**
11923
13159
  * Loaded when the `type` is `"damage"`.
11924
13160
  */
11925
13161
  DamageEntityTriggerEffectItem | /**
@@ -11988,7 +13224,10 @@ DestroyDecorativesTriggerEffectItem | /**
11988
13224
  CameraEffectTriggerEffectItem | /**
11989
13225
  * Loaded when the `type` is `"activate-impact"`.
11990
13226
  */
11991
- ActivateImpactTriggerEffectItem)[];
13227
+ ActivateImpactTriggerEffectItem | /**
13228
+ * Loaded when the `type` is `"create-pollution"`.
13229
+ */
13230
+ CreatePollutionTriggerEffectItem)[];
11992
13231
  /**
11993
13232
  * The abstract base of all {@link TriggerEffects | prototype:TriggerEffect}.
11994
13233
  */
@@ -12291,6 +13530,13 @@ type UnitSpawnDefinition = {
12291
13530
  EntityID,
12292
13531
  SpawnPoint[]
12293
13532
  ];
13533
+ interface UnlockLogisticNetworkModifier extends BoolModifier {
13534
+ type: 'unlock-logistic-network';
13535
+ /**
13536
+ * If `false`, do not draw the small "constant" icon over the technology effect icon.
13537
+ */
13538
+ use_icon_overlay_constant?: boolean;
13539
+ }
12294
13540
  interface UnlockQualityModifier extends BaseModifier {
12295
13541
  quality: QualityID;
12296
13542
  type: 'unlock-quality';
@@ -12443,6 +13689,8 @@ interface VariableAmbientSoundLayer {
12443
13689
  * Number of samples must be the same across all variants.
12444
13690
  *
12445
13691
  * Samples cannot have variable volume and all samples must have the same default volume.
13692
+ *
13693
+ * Samples are required to have sampling frequency of 44.1kHz. This is checked at runtime.
12446
13694
  */
12447
13695
  variants: Sound[];
12448
13696
  }
@@ -12632,7 +13880,7 @@ type VariableAmbientSoundStateType = 'regular' | /**
12632
13880
  'stop';
12633
13881
  interface VariableAmbientSoundVariableSound {
12634
13882
  /**
12635
- * Number of audio signal samples (default sampling frequency is 44.1kHz) defining a time grid. Music samples are aligned with this grid when queued.
13883
+ * Number of audio signal samples (sampling frequency is 44.1kHz) defining a time grid. Music samples are aligned with this grid when queued.
12636
13884
  */
12637
13885
  alignment_samples?: uint32;
12638
13886
  intermezzo?: Sound;
@@ -12708,10 +13956,19 @@ interface VehicleLogisticsModifier extends BoolModifier {
12708
13956
  use_icon_overlay_constant?: boolean;
12709
13957
  }
12710
13958
  type VerticalAlign = 'top' | 'center' | 'bottom';
13959
+ /**
13960
+ * Root style: `"vertical_flow"`
13961
+ */
12711
13962
  interface VerticalFlowStyleSpecification extends BaseStyleSpecification {
12712
13963
  type: 'vertical_flow_style';
13964
+ /**
13965
+ * Required on the root style.
13966
+ */
12713
13967
  vertical_spacing?: int32;
12714
13968
  }
13969
+ /**
13970
+ * Root style: `"vertical_scrollbar"`
13971
+ */
12715
13972
  interface VerticalScrollBarStyleSpecification extends ScrollBarStyleSpecification {
12716
13973
  type: 'vertical_scrollbar_style';
12717
13974
  }
@@ -13062,7 +14319,7 @@ type WorldAmbientSoundDefinition = {
13062
14319
  sound?: Sound;
13063
14320
  } | Sound;
13064
14321
  /**
13065
- * Format uses a dot as its decimal delimiter. Doubles are stored in the {@link double precision | http://en.wikipedia.org/wiki/Double-precision_floating-point_format} floating point format.
14322
+ * Format uses a dot as its decimal delimiter. Doubles are stored in the {@link double precision | https://en.wikipedia.org/wiki/Double-precision_floating-point_format} floating point format.
13066
14323
  *
13067
14324
  * May not be {@link NaN | https://en.wikipedia.org/wiki/NaN}.
13068
14325
  * @example ```
@@ -13100,7 +14357,7 @@ type int32 = number;
13100
14357
  */
13101
14358
  type int8 = number;
13102
14359
  /**
13103
- * A simple {@link Lua table | http://www.lua.org/pil/2.5.html}. An array is a table that uses continuous integer keys starting at `1`, while a dictionary can use numeric or string keys in any order or combination.
14360
+ * A simple {@link Lua table | https://www.lua.org/pil/2.5.html}. An array is a table that uses continuous integer keys starting at `1`, while a dictionary can use numeric or string keys in any order or combination.
13104
14361
  *
13105
14362
  * Tables used by prototypes may be parsed via an internal class called "property tree". Errors that reference this class treat tables as 0-indexed. For example `Value must be a number in property tree at ROOT.technology.steel-plate-productivity.effects[0].change` refers to element 0 of the property tree array which in Lua is at index 1.
13106
14363
  */