factorio-types 1.2.72 → 1.2.74

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.1.23
5
+ // Factorio version 2.1.25
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
@@ -2431,6 +2431,9 @@ interface CargoBayConnections {
2431
2431
  }
2432
2432
  interface CargoHatchDefinition {
2433
2433
  busy_timeout_ticks?: uint32;
2434
+ /**
2435
+ * The {@link cargo pod | prototype:CargoPodPrototype} that this cargo hatch spawns when sending cargo.
2436
+ */
2434
2437
  cargo_unit_entity_to_spawn?: EntityID;
2435
2438
  /**
2436
2439
  * Cannot use `fade_ticks`.
@@ -2456,6 +2459,9 @@ interface CargoHatchDefinition {
2456
2459
  */
2457
2460
  opening_sound?: InterruptibleSound;
2458
2461
  pod_shadow_offset?: Vector;
2462
+ /**
2463
+ * The {@link cargo pods | prototype:CargoPodPrototype} that this cargo hatch can receive.
2464
+ */
2459
2465
  receiving_cargo_units?: EntityID[];
2460
2466
  /**
2461
2467
  * y height relative to hatch position where the pod art gets clipped from sky to regular sorting layer.
@@ -4187,7 +4193,11 @@ interface ElectricEnergySource extends BaseEnergySource {
4187
4193
  */
4188
4194
  buffer_capacity?: Energy;
4189
4195
  /**
4190
- * How much energy (per second) will be continuously removed from the energy buffer. In-game, this is shown in the tooltip as "Min. [Minimum] Consumption". Applied as a constant consumption-per-tick, even when the entity is not {@link active | runtime:LuaEntity::active}.
4196
+ * How much energy (per second) will be continuously removed from the energy buffer. It is applied as a constant consumption-per-tick, even when the entity is not {@link active | runtime:LuaEntity::active}.
4197
+ *
4198
+ * If this is an output energy source then the drain will only affect this energy source's buffer, it will not result in energy being drawn from the network.
4199
+ *
4200
+ * If this is an input energy source then the drain is shown in the tooltip as "Min. [Minimum] Consumption".
4191
4201
  * @example ```
4192
4202
  drain = "1kW"
4193
4203
  ```
@@ -4961,7 +4971,9 @@ interface FluidEnergySource extends BaseEnergySource {
4961
4971
  */
4962
4972
  destroy_non_fuel_fluid?: boolean;
4963
4973
  /**
4964
- * `1` means 100% effectivity. Must be greater than `0`. Multiplier of the energy output.
4974
+ * `1` means 100% effectivity. Must be greater than `0`.
4975
+ *
4976
+ * How much energy the fluid energy source produces compared to how much energy it consumes. For example, an effectivity of 0.5
4965
4977
  */
4966
4978
  effectivity?: double;
4967
4979
  /**
@@ -4993,7 +5005,9 @@ interface FluidEnergySource extends BaseEnergySource {
4993
5005
  minimum_input_temperature?: float;
4994
5006
  output_fluid_box?: FluidBox;
4995
5007
  /**
4996
- * If set to `true`, the energy source will consume as much fluid as required to produce the desired power, otherwise it will consume as much as it is allowed to, wasting any excess.
5008
+ * Scales the energy source's fluid usage to its maximum power output.
5009
+ *
5010
+ * If this is `false` the energy source will overconsume fluid. For example when higher than `maximum_temperature` fluid is fed to the energy source, it will consume the full `fluid_usage_per_tick` and any of the extra energy in the fluid (in the form of higher temperature) is wasted. Setting scale_fluid_usage to `true` prevents this behavior.
4997
5011
  */
4998
5012
  scale_fluid_usage?: boolean;
4999
5013
  smoke?: SmokeSource[];
@@ -7801,7 +7815,7 @@ interface PipeConnectionDefinition {
7801
7815
  MapPosition
7802
7816
  ];
7803
7817
  /**
7804
- * An underground connection may be defined as colliding with tiles in which case if any tile is placed between underground ends the connection will not be established.
7818
+ * An underground connection may be defined as colliding with tiles in which case if any colliding tile is placed between underground ends the connection will not be established.
7805
7819
  *
7806
7820
  * In order to connect, both ends must have the same collision mask specified.
7807
7821
  *
@@ -7820,41 +7834,41 @@ type PipeConnectionType = /**
7820
7834
  */
7821
7835
  'linked';
7822
7836
  interface PipePictures {
7823
- corner_down_left?: Sprite;
7837
+ corner_down_left?: SpriteVariations;
7824
7838
  corner_down_left_disabled_visualization?: Sprite;
7825
- corner_down_left_frozen?: Sprite;
7839
+ corner_down_left_frozen?: SpriteVariations;
7826
7840
  corner_down_left_visualization?: Sprite;
7827
- corner_down_right?: Sprite;
7841
+ corner_down_right?: SpriteVariations;
7828
7842
  corner_down_right_disabled_visualization?: Sprite;
7829
- corner_down_right_frozen?: Sprite;
7843
+ corner_down_right_frozen?: SpriteVariations;
7830
7844
  corner_down_right_visualization?: Sprite;
7831
- corner_up_left?: Sprite;
7845
+ corner_up_left?: SpriteVariations;
7832
7846
  corner_up_left_disabled_visualization?: Sprite;
7833
- corner_up_left_frozen?: Sprite;
7847
+ corner_up_left_frozen?: SpriteVariations;
7834
7848
  corner_up_left_visualization?: Sprite;
7835
- corner_up_right?: Sprite;
7849
+ corner_up_right?: SpriteVariations;
7836
7850
  corner_up_right_disabled_visualization?: Sprite;
7837
- corner_up_right_frozen?: Sprite;
7851
+ corner_up_right_frozen?: SpriteVariations;
7838
7852
  corner_up_right_visualization?: Sprite;
7839
- cross?: Sprite;
7853
+ cross?: SpriteVariations;
7840
7854
  cross_disabled_visualization?: Sprite;
7841
- cross_frozen?: Sprite;
7855
+ cross_frozen?: SpriteVariations;
7842
7856
  cross_visualization?: Sprite;
7843
- ending_down?: Sprite;
7857
+ ending_down?: SpriteVariations;
7844
7858
  ending_down_disabled_visualization?: Sprite;
7845
- ending_down_frozen?: Sprite;
7859
+ ending_down_frozen?: SpriteVariations;
7846
7860
  ending_down_visualization?: Sprite;
7847
- ending_left?: Sprite;
7861
+ ending_left?: SpriteVariations;
7848
7862
  ending_left_disabled_visualization?: Sprite;
7849
- ending_left_frozen?: Sprite;
7863
+ ending_left_frozen?: SpriteVariations;
7850
7864
  ending_left_visualization?: Sprite;
7851
- ending_right?: Sprite;
7865
+ ending_right?: SpriteVariations;
7852
7866
  ending_right_disabled_visualization?: Sprite;
7853
- ending_right_frozen?: Sprite;
7867
+ ending_right_frozen?: SpriteVariations;
7854
7868
  ending_right_visualization?: Sprite;
7855
- ending_up?: Sprite;
7869
+ ending_up?: SpriteVariations;
7856
7870
  ending_up_disabled_visualization?: Sprite;
7857
- ending_up_frozen?: Sprite;
7871
+ ending_up_frozen?: SpriteVariations;
7858
7872
  ending_up_visualization?: Sprite;
7859
7873
  fluid_background?: Sprite;
7860
7874
  /**
@@ -7874,41 +7888,41 @@ interface PipePictures {
7874
7888
  * Visualizes the flow of the fluid in the pipe. Drawn when `(fluid_temp - fluid_min_temp) / (fluid_max_temp - fluid_min_temp)` is larger than `1/3` and less than or equal to `2/3` and the fluid's temperature is below {@link FluidPrototype::gas_temperature | prototype:FluidPrototype::gas_temperature}.
7875
7889
  */
7876
7890
  middle_temperature_flow?: Sprite;
7877
- straight_horizontal?: Sprite;
7891
+ straight_horizontal?: SpriteVariations;
7878
7892
  straight_horizontal_disabled_visualization?: Sprite;
7879
- straight_horizontal_frozen?: Sprite;
7893
+ straight_horizontal_frozen?: SpriteVariations;
7880
7894
  straight_horizontal_visualization?: Sprite;
7881
- straight_horizontal_window?: Sprite;
7895
+ straight_horizontal_window?: SpriteVariations;
7882
7896
  straight_horizontal_window_disabled_visualization?: Sprite;
7883
- straight_horizontal_window_frozen?: Sprite;
7897
+ straight_horizontal_window_frozen?: SpriteVariations;
7884
7898
  straight_horizontal_window_visualization?: Sprite;
7885
- straight_vertical?: Sprite;
7899
+ straight_vertical?: SpriteVariations;
7886
7900
  straight_vertical_disabled_visualization?: Sprite;
7887
- straight_vertical_frozen?: Sprite;
7888
- straight_vertical_single?: Sprite;
7901
+ straight_vertical_frozen?: SpriteVariations;
7902
+ straight_vertical_single?: SpriteVariations;
7889
7903
  straight_vertical_single_disabled_visualization?: Sprite;
7890
- straight_vertical_single_frozen?: Sprite;
7904
+ straight_vertical_single_frozen?: SpriteVariations;
7891
7905
  straight_vertical_single_visualization?: Sprite;
7892
7906
  straight_vertical_visualization?: Sprite;
7893
- straight_vertical_window?: Sprite;
7907
+ straight_vertical_window?: SpriteVariations;
7894
7908
  straight_vertical_window_disabled_visualization?: Sprite;
7895
- straight_vertical_window_frozen?: Sprite;
7909
+ straight_vertical_window_frozen?: SpriteVariations;
7896
7910
  straight_vertical_window_visualization?: Sprite;
7897
- t_down?: Sprite;
7911
+ t_down?: SpriteVariations;
7898
7912
  t_down_disabled_visualization?: Sprite;
7899
- t_down_frozen?: Sprite;
7913
+ t_down_frozen?: SpriteVariations;
7900
7914
  t_down_visualization?: Sprite;
7901
- t_left?: Sprite;
7915
+ t_left?: SpriteVariations;
7902
7916
  t_left_disabled_visualization?: Sprite;
7903
- t_left_frozen?: Sprite;
7917
+ t_left_frozen?: SpriteVariations;
7904
7918
  t_left_visualization?: Sprite;
7905
- t_right?: Sprite;
7919
+ t_right?: SpriteVariations;
7906
7920
  t_right_disabled_visualization?: Sprite;
7907
- t_right_frozen?: Sprite;
7921
+ t_right_frozen?: SpriteVariations;
7908
7922
  t_right_visualization?: Sprite;
7909
- t_up?: Sprite;
7923
+ t_up?: SpriteVariations;
7910
7924
  t_up_disabled_visualization?: Sprite;
7911
- t_up_frozen?: Sprite;
7925
+ t_up_frozen?: SpriteVariations;
7912
7926
  t_up_visualization?: Sprite;
7913
7927
  vertical_window_background?: Sprite;
7914
7928
  }
@@ -9613,6 +9627,10 @@ interface SelectionModeData {
9613
9627
  chart_color?: Color;
9614
9628
  count_button_color?: Color;
9615
9629
  cursor_box_type: CursorBoxType;
9630
+ /**
9631
+ * Whether the list of how many entities are selected should be shown.
9632
+ */
9633
+ draw_selection_counts?: boolean;
9616
9634
  ended_sound?: Sound;
9617
9635
  entity_filter_mode?: 'whitelist' | 'blacklist';
9618
9636
  entity_filters?: EntityID[];
@@ -13064,7 +13082,7 @@ interface TreeGrowth {
13064
13082
  trunk_warp: Sprite;
13065
13083
  }
13066
13084
  /**
13067
- * Tree has number of "dying" stages, which is deduced from frame count of `shadow` if shadow is defined, otherwise from frame count of `trunk`. Frame count of `leaves` has to be one less than the deduced number of stages, as last the stage is always assumed to be leafless.
13085
+ * Tree has number of "dying" stages, which is deduced from frame count of `shadow` if shadow is defined, otherwise from frame count of `trunk`. The frame count of `leaves` has to be one less than the deduced number of stages, as the last stage is always assumed to be leafless.
13068
13086
  */
13069
13087
  interface TreeVariation {
13070
13088
  branch_generation: CreateParticleTriggerEffectItem;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "factorio-types",
3
- "version": "1.2.72",
3
+ "version": "1.2.74",
4
4
  "description": "Typescript declarations for the Factorio mod API",
5
5
  "main": "index.d.ts",
6
6
  "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,7 +23,7 @@
23
23
  "src/**/*.d.ts",
24
24
  "dist/**/*.d.ts"
25
25
  ],
26
- "factorioVersion": "2.1.23",
26
+ "factorioVersion": "2.1.25",
27
27
  "dependencies": {
28
28
  "lua-types": "^2.13.1"
29
29
  },