factorio-types 1.2.69 → 1.2.70
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/classes.d.ts +61 -21
- package/dist/concepts.d.ts +58 -6
- package/dist/datacollection.d.ts +1 -1
- package/dist/defines.d.ts +1 -1
- package/dist/events.d.ts +1 -1
- package/dist/global.d.ts +1 -1
- package/dist/prototypes.d.ts +75 -14
- package/dist/types.d.ts +5 -5
- package/package.json +2 -2
package/dist/classes.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/runtime-api.json
|
|
4
4
|
// Definition source https://github.com/sguest/factorio-types
|
|
5
|
-
// Factorio version 2.1.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace runtime {
|
|
@@ -4770,12 +4770,16 @@ interface LuaBurner {
|
|
|
4770
4770
|
* The currently burning item. Writing `nil` will void the currently burning item without producing a {@link LuaBurner::burnt_result | runtime:LuaBurner::burnt_result}.
|
|
4771
4771
|
*
|
|
4772
4772
|
* Writing to this automatically handles correcting {@link LuaBurner::remaining_burning_fuel | runtime:LuaBurner::remaining_burning_fuel}.
|
|
4773
|
+
*
|
|
4774
|
+
* When writing, any item with a {@link fuel value | runtime:LuaItemPrototype::fuel_value} is considered valid fuel; the fuel category does not have to match.
|
|
4773
4775
|
*/
|
|
4774
4776
|
readonly currently_burning?: ItemIDAndQualityIDPair;
|
|
4775
4777
|
/**
|
|
4776
4778
|
* The currently burning item. Writing `nil` will void the currently burning item without producing a {@link LuaBurner::burnt_result | runtime:LuaBurner::burnt_result}.
|
|
4777
4779
|
*
|
|
4778
4780
|
* Writing to this automatically handles correcting {@link LuaBurner::remaining_burning_fuel | runtime:LuaBurner::remaining_burning_fuel}.
|
|
4781
|
+
*
|
|
4782
|
+
* When writing, any item with a {@link fuel value | runtime:LuaItemPrototype::fuel_value} is considered valid fuel; the fuel category does not have to match.
|
|
4779
4783
|
* @customName currently_burning
|
|
4780
4784
|
*/
|
|
4781
4785
|
currently_burning_write?: ItemWithQualityID;
|
|
@@ -4904,11 +4908,13 @@ interface LuaCargoHatch {
|
|
|
4904
4908
|
* Control behavior for cargo landing pad.
|
|
4905
4909
|
*/
|
|
4906
4910
|
interface LuaCargoLandingPadControlBehavior extends LuaControlBehavior {
|
|
4911
|
+
empty_slots_signal?: SignalID;
|
|
4907
4912
|
/**
|
|
4908
4913
|
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
|
4909
4914
|
*/
|
|
4910
4915
|
readonly object_name: string;
|
|
4911
4916
|
read_contents: boolean;
|
|
4917
|
+
read_empty_slots: boolean;
|
|
4912
4918
|
set_requests: boolean;
|
|
4913
4919
|
/**
|
|
4914
4920
|
* Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
|
|
@@ -5211,6 +5217,7 @@ interface LuaConstantCombinatorControlBehavior extends LuaControlBehavior {
|
|
|
5211
5217
|
* Control behavior for container entities.
|
|
5212
5218
|
*/
|
|
5213
5219
|
interface LuaContainerControlBehavior extends LuaControlBehavior {
|
|
5220
|
+
empty_slots_signal?: SignalID;
|
|
5214
5221
|
/**
|
|
5215
5222
|
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
|
5216
5223
|
*/
|
|
@@ -5219,6 +5226,7 @@ interface LuaContainerControlBehavior extends LuaControlBehavior {
|
|
|
5219
5226
|
* `true` if this container is sending its content to a circuit network.
|
|
5220
5227
|
*/
|
|
5221
5228
|
read_contents: boolean;
|
|
5229
|
+
read_empty_slots: boolean;
|
|
5222
5230
|
/**
|
|
5223
5231
|
* Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
|
|
5224
5232
|
*/
|
|
@@ -7060,6 +7068,15 @@ interface LuaEntity extends LuaControl {
|
|
|
7060
7068
|
* @returns Current values of all signals.
|
|
7061
7069
|
*/
|
|
7062
7070
|
get_signals(this: void, wire_connector_id: defines.wire_connector_id, extra_wire_connector_id?: defines.wire_connector_id): Signal[] | null;
|
|
7071
|
+
/**
|
|
7072
|
+
* Checks if signals on a circuit connector changed recently.
|
|
7073
|
+
*
|
|
7074
|
+
* Returns `true` if signals changed since last tick. If a tick of last check is provided, returns `true` if signals changed since the specified tick. May also return `true` spuriously in other situations when values seen on this connector may be different, caused by addition of wires, removal of wires, circuit network merges, circuit network splits, input network selection changes, etc.
|
|
7075
|
+
*
|
|
7076
|
+
* `nil` if entity has no circuit connector with provided identifier.
|
|
7077
|
+
* @param tick_of_last_check Value of {@link LuaGameScript::tick | runtime:LuaGameScript::tick} of the previous check.
|
|
7078
|
+
*/
|
|
7079
|
+
get_signals_changed(this: void, wire_connector_id: defines.wire_connector_id, tick_of_last_check?: MapTick): boolean | null;
|
|
7063
7080
|
/**
|
|
7064
7081
|
* Gets legs of given SpiderVehicle.
|
|
7065
7082
|
*/
|
|
@@ -7951,7 +7968,9 @@ interface LuaEntity extends LuaControl {
|
|
|
7951
7968
|
*/
|
|
7952
7969
|
health?: float;
|
|
7953
7970
|
/**
|
|
7954
|
-
* The entities connected to this
|
|
7971
|
+
* The entities connected to this entity's heat energy source or this entity's heat buffer.
|
|
7972
|
+
*
|
|
7973
|
+
* The following entity types have a heat buffer: heat pipe, reactor and heat interface.
|
|
7955
7974
|
*/
|
|
7956
7975
|
readonly heat_neighbours: LuaEntity[];
|
|
7957
7976
|
/**
|
|
@@ -8511,7 +8530,9 @@ interface LuaEntity extends LuaControl {
|
|
|
8511
8530
|
*/
|
|
8512
8531
|
tags?: Tags;
|
|
8513
8532
|
/**
|
|
8514
|
-
* The temperature of this entity's heat energy source. `nil` if this entity does not use a heat energy source.
|
|
8533
|
+
* The temperature of this entity's heat energy source or this entity's heat buffer. `nil` if this entity does not use a heat energy source or does not have a heat buffer.
|
|
8534
|
+
*
|
|
8535
|
+
* The following entity types have a heat buffer: heat pipe, reactor and heat interface.
|
|
8515
8536
|
*/
|
|
8516
8537
|
temperature?: double;
|
|
8517
8538
|
/**
|
|
@@ -8939,9 +8960,9 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
|
|
|
8939
8960
|
readonly braking_force?: double;
|
|
8940
8961
|
readonly build_distance?: uint32;
|
|
8941
8962
|
/**
|
|
8942
|
-
* The
|
|
8963
|
+
* The {@link grid size | prototype:EntityPrototype::build_grid_size} of the building.
|
|
8943
8964
|
*/
|
|
8944
|
-
readonly
|
|
8965
|
+
readonly build_grid_size: uint32;
|
|
8945
8966
|
/**
|
|
8946
8967
|
* Whether this inserter is a bulk-type.
|
|
8947
8968
|
*/
|
|
@@ -9099,9 +9120,11 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
|
|
|
9099
9120
|
readonly default_copy_color_from_train_stop?: boolean;
|
|
9100
9121
|
readonly default_day_length_output_signal?: SignalID;
|
|
9101
9122
|
readonly default_day_tick_output_signal?: SignalID;
|
|
9123
|
+
readonly default_empty_slots_signal?: SignalID;
|
|
9102
9124
|
readonly default_game_tick_output_signal?: SignalID;
|
|
9103
9125
|
readonly default_green_output_signal?: SignalID;
|
|
9104
9126
|
readonly default_green_signal?: SignalID;
|
|
9127
|
+
readonly default_launched_signal?: SignalID;
|
|
9105
9128
|
readonly default_orange_output_signal?: SignalID;
|
|
9106
9129
|
readonly default_output_signal?: SignalID;
|
|
9107
9130
|
readonly default_recipe_finished_signal?: SignalID;
|
|
@@ -10570,6 +10593,7 @@ interface LuaEquipmentPrototype extends LuaPrototypeBase {
|
|
|
10570
10593
|
readonly solar_panel_performance_at_day?: double;
|
|
10571
10594
|
readonly solar_panel_performance_at_night?: double;
|
|
10572
10595
|
readonly solar_panel_solar_coefficient_property?: LuaSurfacePropertyPrototype;
|
|
10596
|
+
readonly sunglasses?: boolean;
|
|
10573
10597
|
/**
|
|
10574
10598
|
* The result item when taking this equipment out of an equipment grid, if any.
|
|
10575
10599
|
*/
|
|
@@ -12027,6 +12051,10 @@ interface LuaGameScript {
|
|
|
12027
12051
|
* See {@link LuaGameScript::players | runtime:LuaGameScript::players} for accessing all players.
|
|
12028
12052
|
*/
|
|
12029
12053
|
readonly player?: LuaPlayer;
|
|
12054
|
+
/**
|
|
12055
|
+
* True by default. Can be used to prevent the game engine from printing messages for player deaths and respawns.
|
|
12056
|
+
*/
|
|
12057
|
+
player_death_notifications_enabled: boolean;
|
|
12030
12058
|
/**
|
|
12031
12059
|
* Get a table of all the players that currently exist. This sparse table allows you to find players by indexing it with either their `name` or `index`. Iterating this table with `pairs()` will provide the `index`es as the keys. Iterating with `ipairs()` will not work at all.
|
|
12032
12060
|
*
|
|
@@ -12037,6 +12065,10 @@ interface LuaGameScript {
|
|
|
12037
12065
|
* Simulation-related functions, or `nil` if the current game is not a simulation.
|
|
12038
12066
|
*/
|
|
12039
12067
|
readonly simulation: LuaSimulation;
|
|
12068
|
+
/**
|
|
12069
|
+
* True by default. Can be used to prevent the game engine from printing messages for space platform deaths.
|
|
12070
|
+
*/
|
|
12071
|
+
space_platform_death_notifications_enabled: boolean;
|
|
12040
12072
|
/**
|
|
12041
12073
|
* Speed to update the map at. 1.0 is normal speed -- 60 UPS. Minimum value is 0.01.
|
|
12042
12074
|
*/
|
|
@@ -14027,8 +14059,9 @@ interface LuaItemCommon {
|
|
|
14027
14059
|
/**
|
|
14028
14060
|
* Set new entities to be a part of this blueprint.
|
|
14029
14061
|
* @param entities The new blueprint entities.
|
|
14062
|
+
* @param fix_positions If false, positions will be left unchanged unless invalid for the current snapping.
|
|
14030
14063
|
*/
|
|
14031
|
-
set_blueprint_entities(this: void, entities: BlueprintEntity[]): void;
|
|
14064
|
+
set_blueprint_entities(this: void, entities: BlueprintEntity[], fix_positions?: boolean): void;
|
|
14032
14065
|
/**
|
|
14033
14066
|
* Sets the given tag on the given blueprint entity index in this blueprint item.
|
|
14034
14067
|
* @param index The entity index.
|
|
@@ -14955,6 +14988,7 @@ interface LuaLogisticContainerControlBehavior extends LuaControlBehavior {
|
|
|
14955
14988
|
* Whether the circuit condition is in effect.
|
|
14956
14989
|
*/
|
|
14957
14990
|
circuit_condition_enabled: boolean;
|
|
14991
|
+
empty_slots_signal?: SignalID;
|
|
14958
14992
|
/**
|
|
14959
14993
|
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
|
14960
14994
|
*/
|
|
@@ -14963,6 +14997,7 @@ interface LuaLogisticContainerControlBehavior extends LuaControlBehavior {
|
|
|
14963
14997
|
* `true` if this logistic container is sending its content to a circuit network.
|
|
14964
14998
|
*/
|
|
14965
14999
|
read_contents: boolean;
|
|
15000
|
+
read_empty_slots: boolean;
|
|
14966
15001
|
/**
|
|
14967
15002
|
* `true` if this logistic container has its requests set by a circuit network.
|
|
14968
15003
|
*
|
|
@@ -15668,7 +15703,7 @@ interface LuaPin {
|
|
|
15668
15703
|
alert_type?: defines.alert_type;
|
|
15669
15704
|
always_visible: boolean;
|
|
15670
15705
|
/**
|
|
15671
|
-
* The custom chart tag - if this pin
|
|
15706
|
+
* The custom chart tag - if this pin specifically binds to a chart tag.
|
|
15672
15707
|
*
|
|
15673
15708
|
* The chart tag must be on the same force as the owning player.
|
|
15674
15709
|
*/
|
|
@@ -15676,7 +15711,7 @@ interface LuaPin {
|
|
|
15676
15711
|
/**
|
|
15677
15712
|
* The index of this pin (unique to this player).
|
|
15678
15713
|
*
|
|
15679
|
-
* Note that this index has no
|
|
15714
|
+
* Note that this index has no correlation to the position of the pin within {@link LuaPlayer::get_pins | runtime:LuaPlayer::get_pins}
|
|
15680
15715
|
*/
|
|
15681
15716
|
readonly index: uint32;
|
|
15682
15717
|
/**
|
|
@@ -15726,8 +15761,6 @@ interface LuaPin {
|
|
|
15726
15761
|
interface LuaPlanet {
|
|
15727
15762
|
/**
|
|
15728
15763
|
* Associates the given surface with this planet. Surface must not already be associated with a planet and the planet must not already have an associated surface.
|
|
15729
|
-
*
|
|
15730
|
-
* Planet must not be using {@link entities_require_heating | runtime:LuaSpaceLocationPrototype::entities_require_heating}.
|
|
15731
15764
|
* @param surface The surface to be associated.
|
|
15732
15765
|
*/
|
|
15733
15766
|
associate_surface(this: void, surface: SurfaceIdentification): void;
|
|
@@ -16993,6 +17026,7 @@ interface LuaPrototypes {
|
|
|
16993
17026
|
* Control behavior for proxy container.
|
|
16994
17027
|
*/
|
|
16995
17028
|
interface LuaProxyContainerControlBehavior extends LuaControlBehavior {
|
|
17029
|
+
empty_slots_signal?: SignalID;
|
|
16996
17030
|
/**
|
|
16997
17031
|
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
|
16998
17032
|
*/
|
|
@@ -17001,6 +17035,7 @@ interface LuaProxyContainerControlBehavior extends LuaControlBehavior {
|
|
|
17001
17035
|
* `true` if this proxy container is sending inventory contents to a circuit network
|
|
17002
17036
|
*/
|
|
17003
17037
|
read_contents: boolean;
|
|
17038
|
+
read_empty_slots: boolean;
|
|
17004
17039
|
/**
|
|
17005
17040
|
* Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
|
|
17006
17041
|
*/
|
|
@@ -17755,8 +17790,9 @@ interface LuaRecord {
|
|
|
17755
17790
|
/**
|
|
17756
17791
|
* Set new entities to be a part of this blueprint.
|
|
17757
17792
|
* @param entities The new blueprint entities.
|
|
17793
|
+
* @param fix_positions If false, positions will be left unchanged unless invalid for the current snapping.
|
|
17758
17794
|
*/
|
|
17759
|
-
set_blueprint_entities(this: void, entities: BlueprintEntity[]): void;
|
|
17795
|
+
set_blueprint_entities(this: void, entities: BlueprintEntity[], fix_positions?: boolean): void;
|
|
17760
17796
|
/**
|
|
17761
17797
|
* Sets the given tag on the given blueprint entity index in this blueprint.
|
|
17762
17798
|
* @param index The entity index.
|
|
@@ -18229,7 +18265,7 @@ interface LuaRendering {
|
|
|
18229
18265
|
* @param table.players The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
|
18230
18266
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18231
18267
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18232
|
-
* @param table.tall Defaults to false.
|
|
18268
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18233
18269
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18234
18270
|
* @param table.light_mode Whether this object should be rendered as a sprite, light or both at once. Defaults to "occluder".
|
|
18235
18271
|
*/
|
|
@@ -18270,7 +18306,7 @@ interface LuaRendering {
|
|
|
18270
18306
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18271
18307
|
* @param table.draw_on_ground If this should be drawn below sprites and entities. Defaults to false.
|
|
18272
18308
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18273
|
-
* @param table.tall Defaults to false.
|
|
18309
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18274
18310
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18275
18311
|
*/
|
|
18276
18312
|
draw_arc(this: void, table: {
|
|
@@ -18303,7 +18339,7 @@ interface LuaRendering {
|
|
|
18303
18339
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18304
18340
|
* @param table.draw_on_ground If this should be drawn below sprites and entities. Defaults to false.
|
|
18305
18341
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18306
|
-
* @param table.tall Defaults to false.
|
|
18342
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18307
18343
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18308
18344
|
*/
|
|
18309
18345
|
draw_circle(this: void, table: {
|
|
@@ -18340,7 +18376,7 @@ interface LuaRendering {
|
|
|
18340
18376
|
* @param table.players The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
|
18341
18377
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18342
18378
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18343
|
-
* @param table.tall Defaults to false.
|
|
18379
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18344
18380
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18345
18381
|
*/
|
|
18346
18382
|
draw_light(this: void, table: {
|
|
@@ -18375,7 +18411,7 @@ interface LuaRendering {
|
|
|
18375
18411
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18376
18412
|
* @param table.draw_on_ground If this should be drawn below sprites and entities. Defaults to false.
|
|
18377
18413
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18378
|
-
* @param table.tall Defaults to false.
|
|
18414
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18379
18415
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18380
18416
|
* @example ```
|
|
18381
18417
|
-- Draw a white and 2 pixel wide line from {0, 0} to {2, 2}.
|
|
@@ -18418,7 +18454,7 @@ interface LuaRendering {
|
|
|
18418
18454
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18419
18455
|
* @param table.draw_on_ground If this should be drawn below sprites and entities. Defaults to false.
|
|
18420
18456
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18421
|
-
* @param table.tall Defaults to false.
|
|
18457
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18422
18458
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18423
18459
|
*/
|
|
18424
18460
|
draw_polygon(this: void, table: {
|
|
@@ -18450,7 +18486,7 @@ interface LuaRendering {
|
|
|
18450
18486
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18451
18487
|
* @param table.draw_on_ground If this should be drawn below sprites and entities. Defaults to false.
|
|
18452
18488
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18453
|
-
* @param table.tall Defaults to false.
|
|
18489
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18454
18490
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18455
18491
|
* @example ```
|
|
18456
18492
|
-- Draw a white and 1 pixel wide square outline with the corners {0, 0} and {2, 2}.
|
|
@@ -18490,7 +18526,7 @@ interface LuaRendering {
|
|
|
18490
18526
|
* @param table.players The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
|
18491
18527
|
* @param table.visible If this is rendered to anyone at all. Defaults to true.
|
|
18492
18528
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18493
|
-
* @param table.tall Defaults to false.
|
|
18529
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18494
18530
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18495
18531
|
* @param table.light_mode Whether this object should be rendered as a sprite, light or both at once. Defaults to "occluder".
|
|
18496
18532
|
* @example ```
|
|
@@ -18541,7 +18577,7 @@ interface LuaRendering {
|
|
|
18541
18577
|
* @param table.vertical_alignment Defaults to "top".
|
|
18542
18578
|
* @param table.scale_with_zoom Defaults to false. If true, the text scales with player zoom, resulting in it always being the same size on screen, and the size compared to the game world changes.
|
|
18543
18579
|
* @param table.only_in_alt_mode If this should only be rendered in alt mode. Defaults to false.
|
|
18544
|
-
* @param table.tall Defaults to false.
|
|
18580
|
+
* @param table.tall If this will be translucent when "Hide tall entities" mode is active. Defaults to false.
|
|
18545
18581
|
* @param table.render_mode Mode which this object should render in. Defaults to "game".
|
|
18546
18582
|
* @param table.use_rich_text If rich text rendering is enabled. Defaults to false.
|
|
18547
18583
|
*/
|
|
@@ -18628,10 +18664,12 @@ interface LuaRoboportControlBehavior extends LuaControlBehavior {
|
|
|
18628
18664
|
* Control behavior for rocket silos.
|
|
18629
18665
|
*/
|
|
18630
18666
|
interface LuaRocketSiloControlBehavior extends LuaControlBehavior {
|
|
18667
|
+
launched_signal?: SignalID;
|
|
18631
18668
|
/**
|
|
18632
18669
|
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
|
18633
18670
|
*/
|
|
18634
18671
|
readonly object_name: string;
|
|
18672
|
+
read_launched: boolean;
|
|
18635
18673
|
/**
|
|
18636
18674
|
* The items read mode for the rocket silo.
|
|
18637
18675
|
*/
|
|
@@ -19635,6 +19673,7 @@ interface LuaSpacePlatformHubControlBehavior extends LuaControlBehavior {
|
|
|
19635
19673
|
* Signal to be transmitted with platform's damage taken value.
|
|
19636
19674
|
*/
|
|
19637
19675
|
damage_taken_signal?: SignalID;
|
|
19676
|
+
empty_slots_signal?: SignalID;
|
|
19638
19677
|
/**
|
|
19639
19678
|
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
|
19640
19679
|
*/
|
|
@@ -19647,6 +19686,7 @@ interface LuaSpacePlatformHubControlBehavior extends LuaControlBehavior {
|
|
|
19647
19686
|
* Whether damage taken by the space platform is sent to circuit network.
|
|
19648
19687
|
*/
|
|
19649
19688
|
read_damage_taken: boolean;
|
|
19689
|
+
read_empty_slots: boolean;
|
|
19650
19690
|
/**
|
|
19651
19691
|
* Whether current connection "from" end is sent to circuit network.
|
|
19652
19692
|
*/
|
|
@@ -22899,7 +22939,7 @@ interface LuaTransportLine {
|
|
|
22899
22939
|
get_item_count(this: void, item?: ItemFilter): uint32;
|
|
22900
22940
|
/**
|
|
22901
22941
|
* Gives position of the selected item on this transport line.
|
|
22902
|
-
* @param index Index of the item. Allowed values are from 1 up to #
|
|
22942
|
+
* @param index Index of the item. Allowed values are from 1 up to {@link # (length) | runtime:LuaTransportLine::length_operator}.
|
|
22903
22943
|
* @returns [0] - Linear position of the item along the transport line
|
|
22904
22944
|
* @returns [1] - Map position of the item
|
|
22905
22945
|
*/
|
package/dist/concepts.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/runtime-api.json
|
|
4
4
|
// Definition source https://github.com/sguest/factorio-types
|
|
5
|
-
// Factorio version 2.1.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace runtime {
|
|
@@ -1543,6 +1543,11 @@ interface CargoLandingPadBlueprintControlBehavior {
|
|
|
1543
1543
|
* Defaults to `true`.
|
|
1544
1544
|
*/
|
|
1545
1545
|
read_contents?: boolean;
|
|
1546
|
+
/**
|
|
1547
|
+
* Defaults to `false`.
|
|
1548
|
+
*/
|
|
1549
|
+
read_empty_slots?: boolean;
|
|
1550
|
+
empty_slots_signal?: SignalID;
|
|
1546
1551
|
/**
|
|
1547
1552
|
* Defaults to `false`.
|
|
1548
1553
|
*/
|
|
@@ -2145,6 +2150,11 @@ interface ContainerBlueprintControlBehavior {
|
|
|
2145
2150
|
* Defaults to `true`.
|
|
2146
2151
|
*/
|
|
2147
2152
|
read_contents?: boolean;
|
|
2153
|
+
/**
|
|
2154
|
+
* Defaults to `false`.
|
|
2155
|
+
*/
|
|
2156
|
+
read_empty_slots?: boolean;
|
|
2157
|
+
empty_slots_signal?: SignalID;
|
|
2148
2158
|
}
|
|
2149
2159
|
interface CraftingQueueItem {
|
|
2150
2160
|
/**
|
|
@@ -2591,7 +2601,7 @@ interface ElemID {
|
|
|
2591
2601
|
/**
|
|
2592
2602
|
* A {@link string | runtime:string} specifying a type for {@link choose elem buttons | runtime:LuaGuiElement::elem_type}. It's also used by {@link ElemID | runtime:ElemID} for {@link LuaGuiElement::elem_tooltip | runtime:LuaGuiElement::elem_tooltip}.
|
|
2593
2603
|
*/
|
|
2594
|
-
type ElemType = 'achievement' | 'decorative' | 'entity' | 'equipment' | 'fluid' | 'item' | 'item-group' | 'recipe' | 'signal' | 'technology' | 'tile' | 'asteroid-chunk' | 'space-location' | 'item-with-quality' | 'entity-with-quality' | 'recipe-with-quality' | 'equipment-with-quality';
|
|
2604
|
+
type ElemType = 'achievement' | 'decorative' | 'entity' | 'equipment' | 'fluid' | 'item' | 'item-group' | 'recipe' | 'signal' | 'technology' | 'tile' | 'asteroid-chunk' | 'space-location' | 'item-with-quality' | 'entity-with-quality' | 'recipe-with-quality' | 'equipment-with-quality' | 'ammo-category' | 'airborne-pollutant' | 'quality' | 'shortcut' | 'space-connection' | 'surface' | 'virtual-signal';
|
|
2595
2605
|
interface EmptySlotInfo {
|
|
2596
2606
|
/**
|
|
2597
2607
|
* The icon to use.
|
|
@@ -4728,6 +4738,11 @@ interface LogisticContainerBlueprintControlBehavior {
|
|
|
4728
4738
|
* Defaults to `true`.
|
|
4729
4739
|
*/
|
|
4730
4740
|
read_contents?: boolean;
|
|
4741
|
+
/**
|
|
4742
|
+
* Defaults to `false`.
|
|
4743
|
+
*/
|
|
4744
|
+
read_empty_slots?: boolean;
|
|
4745
|
+
empty_slots_signal?: SignalID;
|
|
4731
4746
|
/**
|
|
4732
4747
|
* Defaults to `false`.
|
|
4733
4748
|
*/
|
|
@@ -8035,6 +8050,11 @@ interface ProxyContainerBlueprintControlBehavior {
|
|
|
8035
8050
|
* Defaults to `true`.
|
|
8036
8051
|
*/
|
|
8037
8052
|
read_contents?: boolean;
|
|
8053
|
+
/**
|
|
8054
|
+
* Defaults to `false`.
|
|
8055
|
+
*/
|
|
8056
|
+
read_empty_slots?: boolean;
|
|
8057
|
+
empty_slots_signal?: SignalID;
|
|
8038
8058
|
}
|
|
8039
8059
|
interface PumpBlueprintControlBehavior {
|
|
8040
8060
|
input_networks?: CircuitNetworkSelection;
|
|
@@ -8184,7 +8204,7 @@ interface ReactorBlueprintControlBehavior {
|
|
|
8184
8204
|
* Defaults to `false`.
|
|
8185
8205
|
*/
|
|
8186
8206
|
read_temperature?: boolean;
|
|
8187
|
-
temperature_signal
|
|
8207
|
+
temperature_signal?: SignalID;
|
|
8188
8208
|
}
|
|
8189
8209
|
/**
|
|
8190
8210
|
* The smooth orientation. It is a `float` in the range `[0, 1)` that covers a full circle, starting at the top and going clockwise.
|
|
@@ -8766,7 +8786,10 @@ interface ResearchTriggerCraftItem extends BaseResearchTrigger {
|
|
|
8766
8786
|
*/
|
|
8767
8787
|
interface ResearchTriggerMineEntity extends BaseResearchTrigger {
|
|
8768
8788
|
'type': 'mine-entity';
|
|
8769
|
-
|
|
8789
|
+
/**
|
|
8790
|
+
* The trigger is considered fulfilled if at least one of these entities is mined.
|
|
8791
|
+
*/
|
|
8792
|
+
'entities': string[];
|
|
8770
8793
|
}
|
|
8771
8794
|
/**
|
|
8772
8795
|
*
|
|
@@ -8814,6 +8837,11 @@ interface RocketSiloBlueprintControlBehavior {
|
|
|
8814
8837
|
* Defaults to `logistic_inventory`.
|
|
8815
8838
|
*/
|
|
8816
8839
|
read_items_mode?: defines.control_behavior.rocket_silo.read_mode;
|
|
8840
|
+
/**
|
|
8841
|
+
* Defaults to `false`.
|
|
8842
|
+
*/
|
|
8843
|
+
read_launched?: boolean;
|
|
8844
|
+
launched_signal?: SignalID;
|
|
8817
8845
|
}
|
|
8818
8846
|
interface RollingStockDrawData {
|
|
8819
8847
|
position: MapPosition;
|
|
@@ -9217,14 +9245,14 @@ type SelectionModeFlags = Record</**
|
|
|
9217
9245
|
* Selects entities that are `tile-ghost`s.
|
|
9218
9246
|
*/
|
|
9219
9247
|
'tile-ghost', true>;
|
|
9220
|
-
type SelectorCombinatorParameterOperation = 'select' | 'count' | 'random' | 'quality-transfer' | 'rocket-capacity' | 'stack-size' | 'quality-filter' | 'time';
|
|
9248
|
+
type SelectorCombinatorParameterOperation = 'select' | 'count' | 'random' | 'quality-transfer' | 'rocket-capacity' | 'stack-size' | 'quality-filter' | 'time' | 'quality-select';
|
|
9221
9249
|
interface BaseSelectorCombinatorParameters {
|
|
9222
9250
|
/**
|
|
9223
9251
|
* Defaults to `"select"`.
|
|
9224
9252
|
*/
|
|
9225
9253
|
operation?: SelectorCombinatorParameterOperation;
|
|
9226
9254
|
}
|
|
9227
|
-
type SelectorCombinatorParameters = BaseSelectorCombinatorParameters | SelectorCombinatorParametersCount | SelectorCombinatorParametersQualityFilter | SelectorCombinatorParametersQualityTransfer | SelectorCombinatorParametersRandom | SelectorCombinatorParametersSelect | SelectorCombinatorParametersTime;
|
|
9255
|
+
type SelectorCombinatorParameters = BaseSelectorCombinatorParameters | SelectorCombinatorParametersCount | SelectorCombinatorParametersQualityFilter | SelectorCombinatorParametersQualitySelect | SelectorCombinatorParametersQualityTransfer | SelectorCombinatorParametersRandom | SelectorCombinatorParametersSelect | SelectorCombinatorParametersTime;
|
|
9228
9256
|
/**
|
|
9229
9257
|
*
|
|
9230
9258
|
* Applies to variant case `count`
|
|
@@ -9253,6 +9281,20 @@ interface SelectorCombinatorParametersQualityFilter extends BaseSelectorCombinat
|
|
|
9253
9281
|
*/
|
|
9254
9282
|
'quality_filter'?: QualityCondition;
|
|
9255
9283
|
}
|
|
9284
|
+
/**
|
|
9285
|
+
*
|
|
9286
|
+
* Applies to variant case `quality-select`
|
|
9287
|
+
*/
|
|
9288
|
+
interface SelectorCombinatorParametersQualitySelect extends BaseSelectorCombinatorParameters {
|
|
9289
|
+
/**
|
|
9290
|
+
* Defaults to `"select"`.
|
|
9291
|
+
*/
|
|
9292
|
+
'operation'?: 'quality-select';
|
|
9293
|
+
/**
|
|
9294
|
+
* Defaults to `true`.
|
|
9295
|
+
*/
|
|
9296
|
+
'select_highest_quality'?: boolean;
|
|
9297
|
+
}
|
|
9256
9298
|
/**
|
|
9257
9299
|
*
|
|
9258
9300
|
* Applies to variant case `quality-transfer`
|
|
@@ -9293,6 +9335,10 @@ interface SelectorCombinatorParametersSelect extends BaseSelectorCombinatorParam
|
|
|
9293
9335
|
* Defaults to `"select"`.
|
|
9294
9336
|
*/
|
|
9295
9337
|
'operation'?: 'select';
|
|
9338
|
+
/**
|
|
9339
|
+
* Defaults to `"="`.
|
|
9340
|
+
*/
|
|
9341
|
+
'index_comparator'?: ComparatorString;
|
|
9296
9342
|
/**
|
|
9297
9343
|
* The signal index to use if not using a specific `index_signal`. Defaults to `0`.
|
|
9298
9344
|
*/
|
|
@@ -9606,6 +9652,11 @@ interface SpacePlatformHubBlueprintControlBehavior {
|
|
|
9606
9652
|
* Defaults to `true`.
|
|
9607
9653
|
*/
|
|
9608
9654
|
read_contents?: boolean;
|
|
9655
|
+
/**
|
|
9656
|
+
* Defaults to `false`.
|
|
9657
|
+
*/
|
|
9658
|
+
read_empty_slots?: boolean;
|
|
9659
|
+
empty_slots_signal?: SignalID;
|
|
9609
9660
|
/**
|
|
9610
9661
|
* Defaults to `false`.
|
|
9611
9662
|
*/
|
|
@@ -9828,6 +9879,7 @@ string;
|
|
|
9828
9879
|
* The effect that is applied when a technology is researched.
|
|
9829
9880
|
*/
|
|
9830
9881
|
interface BaseTechnologyModifier {
|
|
9882
|
+
hidden: boolean;
|
|
9831
9883
|
/**
|
|
9832
9884
|
* Modifier type. Specifies which of the other fields will be available.
|
|
9833
9885
|
*/
|
package/dist/datacollection.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.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace prototype {
|
package/dist/defines.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/runtime-api.json
|
|
4
4
|
// Definition source https://github.com/sguest/factorio-types
|
|
5
|
-
// Factorio version 2.1.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace defines {
|
package/dist/events.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/runtime-api.json
|
|
4
4
|
// Definition source https://github.com/sguest/factorio-types
|
|
5
|
-
// Factorio version 2.1.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace runtime {
|
package/dist/global.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/runtime-api.json
|
|
4
4
|
// Definition source https://github.com/sguest/factorio-types
|
|
5
|
-
// Factorio version 2.1.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
/**
|
package/dist/prototypes.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.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace prototype {
|
|
@@ -83,6 +83,8 @@ interface AccumulatorPrototype extends EntityWithOwnerPrototype {
|
|
|
83
83
|
draw_copper_wires?: boolean;
|
|
84
84
|
/**
|
|
85
85
|
* The capacity of the energy source buffer specifies the capacity of the accumulator.
|
|
86
|
+
*
|
|
87
|
+
* Any {@link usage_priority | prototype:ElectricEnergySource::usage_priority} set here will be ignored, accumulators always have the "managed-accumulator" usage priority.
|
|
86
88
|
*/
|
|
87
89
|
energy_source: ElectricEnergySource;
|
|
88
90
|
}
|
|
@@ -953,6 +955,11 @@ interface AssemblingMachinePrototype extends CraftingMachinePrototype {
|
|
|
953
955
|
* The preset recipe of this machine. This machine does not show a recipe selection if this is set. The base game uses this for the {@link rocket silo | https://wiki.factorio.com/Rocket_silo}.
|
|
954
956
|
*/
|
|
955
957
|
fixed_recipe?: RecipeID;
|
|
958
|
+
/**
|
|
959
|
+
* Whether the {@link fluid boxes | prototype:CraftingMachinePrototype::fluid_boxes} are disabled when this assembling machine has no recipe set.
|
|
960
|
+
*
|
|
961
|
+
* If a recipe is set, this property does not affect fluidbox behavior. Instead, whether fluidboxes are enabled depends on whether the recipe needs them, e.g. if a recipe without fluid ingredients is set, the input fluidboxes will be disabled.
|
|
962
|
+
*/
|
|
956
963
|
fluid_boxes_off_when_no_fluid_recipe?: boolean;
|
|
957
964
|
/**
|
|
958
965
|
* The locale key of the title of the recipe selection GUI that is shown when the player opens the assembling machine. May not be longer than 200 characters.
|
|
@@ -1303,7 +1310,7 @@ interface BoilerPrototype extends EntityWithOwnerPrototype {
|
|
|
1303
1310
|
output_fluid_box: FluidBox;
|
|
1304
1311
|
pictures?: BoilerPictureSet;
|
|
1305
1312
|
/**
|
|
1306
|
-
* Only loaded, and mandatory if `mode` is `"output-to-separate-pipe"`.
|
|
1313
|
+
* Only loaded, and mandatory if `mode` is `"output-to-separate-pipe"`. The boiler heats the input fluid to exactly this temperature and moves the fluid to the output fluid box.
|
|
1307
1314
|
*/
|
|
1308
1315
|
target_temperature?: float;
|
|
1309
1316
|
}
|
|
@@ -1519,6 +1526,7 @@ interface CargoLandingPadPrototype extends EntityWithOwnerPrototype {
|
|
|
1519
1526
|
* The maximum circuit wire distance for this entity.
|
|
1520
1527
|
*/
|
|
1521
1528
|
circuit_wire_max_distance?: double;
|
|
1529
|
+
default_empty_slots_signal?: SignalIDConnector;
|
|
1522
1530
|
draw_circuit_wires?: boolean;
|
|
1523
1531
|
draw_copper_wires?: boolean;
|
|
1524
1532
|
graphics_set?: CargoBayConnectableGraphicsSet;
|
|
@@ -1980,6 +1988,7 @@ interface ContainerPrototype extends EntityWithOwnerPrototype {
|
|
|
1980
1988
|
* The maximum circuit wire distance for this container.
|
|
1981
1989
|
*/
|
|
1982
1990
|
circuit_wire_max_distance?: double;
|
|
1991
|
+
default_empty_slots_signal?: SignalIDConnector;
|
|
1983
1992
|
default_status?: EntityStatus;
|
|
1984
1993
|
/**
|
|
1985
1994
|
* Amount of directions this container should have. Allowed values are 1, 2 and 4.
|
|
@@ -2125,6 +2134,10 @@ interface CraftingMachinePrototype extends EntityWithOwnerPrototype {
|
|
|
2125
2134
|
* Sets the {@link module categories | prototype:ModuleCategory} that are allowed to be inserted into this machine.
|
|
2126
2135
|
*/
|
|
2127
2136
|
allowed_module_categories?: ModuleCategoryID[];
|
|
2137
|
+
/**
|
|
2138
|
+
* If true the starting frame will be randomized upon placement.
|
|
2139
|
+
*/
|
|
2140
|
+
animation_random_start_frame?: boolean;
|
|
2128
2141
|
/**
|
|
2129
2142
|
* A list of {@link recipe categories | prototype:RecipeCategory} this crafting machine can use.
|
|
2130
2143
|
* @example ```
|
|
@@ -4076,7 +4089,7 @@ interface FluidPrototype extends Prototype {
|
|
|
4076
4089
|
*/
|
|
4077
4090
|
default_temperature: float;
|
|
4078
4091
|
/**
|
|
4079
|
-
* Whether the fluid should glow in pipe and storage tank windows.
|
|
4092
|
+
* Whether the fluid should glow in pipe and storage tank windows. The glow is only drawn when the {@link expansion_shaders | prototype:FeatureFlags::expansion_shaders} feature flag is enabled.
|
|
4080
4093
|
*/
|
|
4081
4094
|
draw_as_glow?: boolean;
|
|
4082
4095
|
/**
|
|
@@ -4253,10 +4266,18 @@ interface FluidTurretPrototype extends TurretPrototype {
|
|
|
4253
4266
|
interface FluidWagonPrototype extends RollingStockPrototype {
|
|
4254
4267
|
/**
|
|
4255
4268
|
* Horizontal (xy) offset of the central valve from the wagon position when it is oriented east/west.
|
|
4269
|
+
*
|
|
4270
|
+
* For all directions, the elliptical interpolation for the offset is performed based on both `base_valve_xy_offset_when_horizontal` and `base_valve_xy_offset_when_vertical` and the tangential and normal are calculated separately.
|
|
4271
|
+
*
|
|
4272
|
+
* The tangential component of the offset is interpolated from values `base_valve_xy_offset_when_horizontal.x` and `base_valve_xy_offset_when_vertical.y`. The normal component of the offset is interpolated from values `base_valve_xy_offset_when_vertical.x` and `base_valve_xy_offset_when_horizontal.y`.
|
|
4273
|
+
*
|
|
4274
|
+
* Interpolating the components with one value non-zero and the other zero would produce undesirable behaviour and is therefore not allowed.
|
|
4256
4275
|
*/
|
|
4257
4276
|
base_valve_xy_offset_when_horizontal?: Vector;
|
|
4258
4277
|
/**
|
|
4259
4278
|
* Horizontal (xy) offset of the central valve from the wagon position when it is oriented north/south.
|
|
4279
|
+
*
|
|
4280
|
+
* See `base_valve_xy_offset_when_horizontal` for how this value is used in the offset calculation.
|
|
4260
4281
|
*/
|
|
4261
4282
|
base_valve_xy_offset_when_vertical?: Vector;
|
|
4262
4283
|
/**
|
|
@@ -4283,10 +4304,18 @@ interface FluidWagonPrototype extends RollingStockPrototype {
|
|
|
4283
4304
|
tank_spacing?: float;
|
|
4284
4305
|
/**
|
|
4285
4306
|
* Projected offset between valves when the wagon is oriented east/west.
|
|
4307
|
+
*
|
|
4308
|
+
* For all directions, the elliptical interpolation for the offset is performed based on both `valve_to_valve_offset_when_horizontal` and `valve_to_valve_offset_when_vertical` and the tangential and normal are calculated separately.
|
|
4309
|
+
*
|
|
4310
|
+
* The tangential component of the offset is interpolated from values `valve_to_valve_offset_when_horizontal.x` and `valve_to_valve_offset_when_vertical.y`. The normal component of the offset is interpolated from values `valve_to_valve_offset_when_vertical.x` and `valve_to_valve_offset_when_horizontal.y`.
|
|
4311
|
+
*
|
|
4312
|
+
* Interpolating the components with one value non-zero and the other zero would produce undesirable behaviour and is therefore not allowed.
|
|
4286
4313
|
*/
|
|
4287
4314
|
valve_to_valve_offset_when_horizontal?: Vector;
|
|
4288
4315
|
/**
|
|
4289
4316
|
* Projected offset between valves when the wagon is oriented north/south.
|
|
4317
|
+
*
|
|
4318
|
+
* See `valve_to_valve_offset_when_horizontal` for how this value is used in the offset calculation.
|
|
4290
4319
|
*/
|
|
4291
4320
|
valve_to_valve_offset_when_vertical?: Vector;
|
|
4292
4321
|
}
|
|
@@ -5596,6 +5625,8 @@ interface LampPrototype extends EntityWithOwnerPrototype {
|
|
|
5596
5625
|
draw_copper_wires?: boolean;
|
|
5597
5626
|
/**
|
|
5598
5627
|
* The emissions set on the energy source are ignored so lamps cannot produce pollution.
|
|
5628
|
+
*
|
|
5629
|
+
* If this is an electric energy source, any {@link usage_priority | prototype:ElectricEnergySource::usage_priority} set here will be ignored, lamps always have the "lamp" usage priority.
|
|
5599
5630
|
*/
|
|
5600
5631
|
energy_source: ElectricEnergySource | VoidEnergySource;
|
|
5601
5632
|
/**
|
|
@@ -5773,6 +5804,7 @@ interface LinkedContainerPrototype extends EntityWithOwnerPrototype {
|
|
|
5773
5804
|
* The maximum circuit wire distance for this linked container.
|
|
5774
5805
|
*/
|
|
5775
5806
|
circuit_wire_max_distance?: double;
|
|
5807
|
+
default_empty_slots_signal?: SignalIDConnector;
|
|
5776
5808
|
draw_circuit_wires?: boolean;
|
|
5777
5809
|
draw_copper_wires?: boolean;
|
|
5778
5810
|
/**
|
|
@@ -6411,11 +6443,15 @@ interface NightVisionEquipmentPrototype extends EquipmentPrototype {
|
|
|
6411
6443
|
activate_sound?: Sound;
|
|
6412
6444
|
color_lookup: DaytimeColorLookupTable;
|
|
6413
6445
|
/**
|
|
6414
|
-
* Must be >= 0 and <= 1.
|
|
6446
|
+
* Must be >= 0 and <= 1. By default, this equipment turns on when `surface_darkness >= darkness_to_turn_on`.
|
|
6415
6447
|
*/
|
|
6416
6448
|
darkness_to_turn_on?: float;
|
|
6417
6449
|
deactivate_sound?: Sound;
|
|
6418
6450
|
energy_input: Energy;
|
|
6451
|
+
/**
|
|
6452
|
+
* If `true`, this equipment turns on when `surface_darkness <= darkness_to_turn_on`.
|
|
6453
|
+
*/
|
|
6454
|
+
sunglasses?: boolean;
|
|
6419
6455
|
}
|
|
6420
6456
|
/**
|
|
6421
6457
|
* An {@link offshore pump | https://wiki.factorio.com/Offshore_pump}.
|
|
@@ -6924,18 +6960,26 @@ interface PrototypeBase {
|
|
|
6924
6960
|
* A container that must be set to point at other entity and inventory index so it can forward all inventory interactions to the other entity.
|
|
6925
6961
|
*/
|
|
6926
6962
|
interface ProxyContainerPrototype extends EntityWithOwnerPrototype {
|
|
6927
|
-
|
|
6963
|
+
/**
|
|
6964
|
+
* If given, there must be exactly `direction_count` elements in the table.
|
|
6965
|
+
*/
|
|
6966
|
+
circuit_connector?: CircuitConnectorDefinition[];
|
|
6928
6967
|
/**
|
|
6929
6968
|
* The maximum circuit wire distance for this entity.
|
|
6930
6969
|
*/
|
|
6931
6970
|
circuit_wire_max_distance?: double;
|
|
6971
|
+
default_empty_slots_signal?: SignalIDConnector;
|
|
6972
|
+
/**
|
|
6973
|
+
* Amount of directions this container should have. Allowed values are 1, 2 and 4.
|
|
6974
|
+
*/
|
|
6975
|
+
direction_count?: uint8;
|
|
6932
6976
|
draw_circuit_wires?: boolean;
|
|
6933
6977
|
draw_copper_wires?: boolean;
|
|
6934
6978
|
/**
|
|
6935
6979
|
* If the content of the inventory should be rendered in alt mode.
|
|
6936
6980
|
*/
|
|
6937
6981
|
draw_inventory_content?: boolean;
|
|
6938
|
-
picture?:
|
|
6982
|
+
picture?: Sprite4Way;
|
|
6939
6983
|
}
|
|
6940
6984
|
/**
|
|
6941
6985
|
* The pump is used to transfer fluids between tanks, fluid wagons and pipes.
|
|
@@ -7633,9 +7677,9 @@ interface RecipePrototype extends Prototype {
|
|
|
7633
7677
|
*/
|
|
7634
7678
|
always_show_made_in?: boolean;
|
|
7635
7679
|
/**
|
|
7636
|
-
* Whether the recipe should be included in the recycling recipes automatically generated by the
|
|
7680
|
+
* Whether the recipe should be included in the recycling recipes automatically generated by the recycler mod.
|
|
7637
7681
|
*
|
|
7638
|
-
* This property is not read by the game engine itself, but the
|
|
7682
|
+
* This property is not read by the game engine itself, but the recycler mod's recycling.lua file. This means it is discarded by the game engine after loading finishes.
|
|
7639
7683
|
*/
|
|
7640
7684
|
auto_recycle?: boolean;
|
|
7641
7685
|
/**
|
|
@@ -7765,6 +7809,12 @@ interface RecipePrototype extends Prototype {
|
|
|
7765
7809
|
```
|
|
7766
7810
|
*/
|
|
7767
7811
|
raise_on_crafted?: boolean;
|
|
7812
|
+
/**
|
|
7813
|
+
* If set, this recipe's recycling recipe is generated by the recycler mod based on the ingredients of the given recipe, instead of this recipe's own ingredients.
|
|
7814
|
+
*
|
|
7815
|
+
* This property is not read by the game engine itself, but the recycler mod's recycling.lua file. This means it is discarded by the game engine after loading finishes.
|
|
7816
|
+
*/
|
|
7817
|
+
recycle_to_ingredients_of?: RecipeID;
|
|
7768
7818
|
requester_paste_multiplier?: uint32;
|
|
7769
7819
|
/**
|
|
7770
7820
|
* Whether enabling this recipe requires the ingredients be unlocked before the products are marked as unlocked.
|
|
@@ -7798,6 +7848,8 @@ interface RecipePrototype extends Prototype {
|
|
|
7798
7848
|
results?: ProductPrototype[];
|
|
7799
7849
|
/**
|
|
7800
7850
|
* When set to `true`, item ingredients will be sorted based on {@link ItemGroup::order_in_recipe | prototype:ItemGroup::order_in_recipe}.
|
|
7851
|
+
*
|
|
7852
|
+
* Otherwise, the item ingredients appear in the order that they are defined in the prototype.
|
|
7801
7853
|
*/
|
|
7802
7854
|
sort_item_ingredients?: boolean;
|
|
7803
7855
|
surface_conditions?: SurfaceCondition[];
|
|
@@ -8341,6 +8393,7 @@ interface RocketSiloPrototype extends AssemblingMachinePrototype {
|
|
|
8341
8393
|
* Applied when switching into the {@link arms_advance | runtime:defines.rocket_silo_status.arms_advance} state.
|
|
8342
8394
|
*/
|
|
8343
8395
|
clamps_on_trigger?: TriggerEffect;
|
|
8396
|
+
default_launched_signal?: SignalIDConnector;
|
|
8344
8397
|
door_back_frozen?: Sprite;
|
|
8345
8398
|
door_back_open_offset: Vector;
|
|
8346
8399
|
door_back_sprite?: Sprite;
|
|
@@ -9201,11 +9254,11 @@ interface SpaceLocationPrototype extends Prototype {
|
|
|
9201
9254
|
asteroid_spawn_influence?: double;
|
|
9202
9255
|
auto_save_on_first_trip?: boolean;
|
|
9203
9256
|
/**
|
|
9204
|
-
* Distance from the
|
|
9257
|
+
* Distance from the origin in map coordinates.
|
|
9205
9258
|
*/
|
|
9206
9259
|
distance: double;
|
|
9207
9260
|
/**
|
|
9208
|
-
* If `false`, the orbital ring around the
|
|
9261
|
+
* If `false`, the orbital ring around the origin will not be drawn for this location.
|
|
9209
9262
|
*/
|
|
9210
9263
|
draw_orbit?: boolean;
|
|
9211
9264
|
/**
|
|
@@ -9245,9 +9298,12 @@ interface SpaceLocationPrototype extends Prototype {
|
|
|
9245
9298
|
*/
|
|
9246
9299
|
magnitude?: double;
|
|
9247
9300
|
/**
|
|
9248
|
-
* Angle in relation to the
|
|
9301
|
+
* Angle in relation to the origin.
|
|
9249
9302
|
*/
|
|
9250
9303
|
orientation: RealOrientation;
|
|
9304
|
+
/**
|
|
9305
|
+
* The location that this space location orbits in the space map.
|
|
9306
|
+
*/
|
|
9251
9307
|
origin?: MapPosition;
|
|
9252
9308
|
/**
|
|
9253
9309
|
* The orientation where parked space platforms will be drawn.
|
|
@@ -9275,7 +9331,7 @@ interface SpaceLocationPrototype extends Prototype {
|
|
|
9275
9331
|
*/
|
|
9276
9332
|
starmap_icon?: FileName;
|
|
9277
9333
|
/**
|
|
9278
|
-
* Orientation of the starmap icon, defaults to pointing towards the
|
|
9334
|
+
* Orientation of the starmap icon, defaults to pointing towards the origin.
|
|
9279
9335
|
*/
|
|
9280
9336
|
starmap_icon_orientation?: RealOrientation;
|
|
9281
9337
|
/**
|
|
@@ -9301,6 +9357,7 @@ interface SpacePlatformHubPrototype extends EntityWithOwnerPrototype {
|
|
|
9301
9357
|
*/
|
|
9302
9358
|
circuit_wire_max_distance?: double;
|
|
9303
9359
|
default_damage_taken_signal?: SignalIDConnector;
|
|
9360
|
+
default_empty_slots_signal?: SignalIDConnector;
|
|
9304
9361
|
default_speed_signal?: SignalIDConnector;
|
|
9305
9362
|
draw_circuit_wires?: boolean;
|
|
9306
9363
|
draw_copper_wires?: boolean;
|
|
@@ -10327,7 +10384,9 @@ interface TipsAndTricksItem extends PrototypeBase {
|
|
|
10327
10384
|
player_input_method_filter?: PlayerInputMethodFilter;
|
|
10328
10385
|
simulation?: SimulationDefinition;
|
|
10329
10386
|
/**
|
|
10330
|
-
* Condition for never showing the tip notification to the player.
|
|
10387
|
+
* Condition for never showing the tip notification to the player. If the condition is fulfilled, the tip is considered completed and shown in the tips list.
|
|
10388
|
+
*
|
|
10389
|
+
* If the tip notification is already shown, then fulfilling the skip trigger removes the tip notification icon again.
|
|
10331
10390
|
*/
|
|
10332
10391
|
skip_trigger?: TipTrigger;
|
|
10333
10392
|
starting_status?: TipStatus;
|
|
@@ -10336,7 +10395,7 @@ interface TipsAndTricksItem extends PrototypeBase {
|
|
|
10336
10395
|
*/
|
|
10337
10396
|
tag?: string;
|
|
10338
10397
|
/**
|
|
10339
|
-
* Condition for when the tip notification should be shown to the player.
|
|
10398
|
+
* Condition for when the tip notification should be shown to the player. If the condition is fulfilled, the status of the tip is set to "suggested" or "dependencies-not-met".
|
|
10340
10399
|
*/
|
|
10341
10400
|
trigger?: TipTrigger;
|
|
10342
10401
|
/**
|
|
@@ -12153,6 +12212,8 @@ interface UtilitySprites extends PrototypeBase {
|
|
|
12153
12212
|
side_menu_factoriopedia_icon: Sprite;
|
|
12154
12213
|
side_menu_logistic_networks_icon: Sprite;
|
|
12155
12214
|
side_menu_map_icon: Sprite;
|
|
12215
|
+
side_menu_master_mute_muted_icon: Sprite;
|
|
12216
|
+
side_menu_master_mute_unmuted_icon: Sprite;
|
|
12156
12217
|
side_menu_menu_icon: Sprite;
|
|
12157
12218
|
side_menu_players_icon: Sprite;
|
|
12158
12219
|
side_menu_production_icon: Sprite;
|
package/dist/types.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// Factorio API reference https://lua-api.factorio.com/latest/index.html
|
|
3
3
|
// Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
|
|
4
4
|
// Definition source https://github.com/sguest/factorio-types
|
|
5
|
-
// Factorio version 2.1.
|
|
5
|
+
// Factorio version 2.1.21
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace prototype {
|
|
@@ -7205,7 +7205,7 @@ end
|
|
|
7205
7205
|
```
|
|
7206
7206
|
* @example ```
|
|
7207
7207
|
-- uses a features only available past a certain base mod version
|
|
7208
|
-
if helpers.
|
|
7208
|
+
if helpers.compare_versions(mods["base"], "2.0.56") >= 0 then
|
|
7209
7209
|
use_new_features()
|
|
7210
7210
|
end
|
|
7211
7211
|
```
|
|
@@ -7963,7 +7963,7 @@ interface PlatformBackdrop {
|
|
|
7963
7963
|
*/
|
|
7964
7964
|
hero_clouds_are_emissive?: boolean;
|
|
7965
7965
|
/**
|
|
7966
|
-
* Color of light.
|
|
7966
|
+
* Color of light.
|
|
7967
7967
|
*/
|
|
7968
7968
|
light_color?: Color;
|
|
7969
7969
|
light_direction?: Vector3D;
|
|
@@ -8014,7 +8014,7 @@ interface PlatformBackdrop {
|
|
|
8014
8014
|
*/
|
|
8015
8015
|
rotation_seconds?: float;
|
|
8016
8016
|
/**
|
|
8017
|
-
* Color of specular light.
|
|
8017
|
+
* Color of specular light.
|
|
8018
8018
|
*/
|
|
8019
8019
|
specular_color?: Color;
|
|
8020
8020
|
specular_intensity?: float;
|
|
@@ -13002,7 +13002,7 @@ interface TreeGrowth {
|
|
|
13002
13002
|
trunk_warp: Sprite;
|
|
13003
13003
|
}
|
|
13004
13004
|
/**
|
|
13005
|
-
* Tree has number of "dying" stages, which is deduced from frame count of `shadow` if shadow is defined, otherwise from frame count of `trunk`. Frame count of `leaves` has to be one less than deduced number stages, as last stage is always assumed to be leafless.
|
|
13005
|
+
* Tree has number of "dying" stages, which is deduced from frame count of `shadow` if shadow is defined, otherwise from frame count of `trunk`. Frame count of `leaves` has to be one less than the deduced number of stages, as last the stage is always assumed to be leafless.
|
|
13006
13006
|
*/
|
|
13007
13007
|
interface TreeVariation {
|
|
13008
13008
|
branch_generation: CreateParticleTriggerEffectItem;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "factorio-types",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.70",
|
|
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.
|
|
26
|
+
"factorioVersion": "2.1.21",
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"lua-types": "^2.13.1"
|
|
29
29
|
},
|