factorio-types 1.2.49 → 1.2.51
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 +823 -598
- package/dist/concepts.d.ts +282 -199
- package/dist/datacollection.d.ts +1 -1
- package/dist/defines.d.ts +215 -206
- package/dist/events.d.ts +449 -398
- package/dist/global.d.ts +2 -2
- package/dist/prototypes.d.ts +146 -20
- package/dist/types.d.ts +121 -24
- package/package.json +2 -2
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.0.
|
|
5
|
+
// Factorio version 2.0.69
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace runtime {
|
|
@@ -66,7 +66,7 @@ interface AddRecordData {
|
|
|
66
66
|
allows_unloading?: boolean;
|
|
67
67
|
wait_conditions?: WaitCondition[];
|
|
68
68
|
/**
|
|
69
|
-
* If
|
|
69
|
+
* If record position is not given, the record is appended.
|
|
70
70
|
*/
|
|
71
71
|
index?: ScheduleRecordPosition;
|
|
72
72
|
}
|
|
@@ -97,7 +97,7 @@ interface Alert {
|
|
|
97
97
|
/**
|
|
98
98
|
* The tick this alert was created.
|
|
99
99
|
*/
|
|
100
|
-
tick:
|
|
100
|
+
tick: uint32;
|
|
101
101
|
target?: LuaEntity;
|
|
102
102
|
prototype?: LuaEntityPrototype;
|
|
103
103
|
position?: MapPosition;
|
|
@@ -166,7 +166,7 @@ interface ArithmeticCombinatorParameters {
|
|
|
166
166
|
/**
|
|
167
167
|
* Constant to use as the first argument of the operation. Has no effect when `first_signal` is set. Defaults to `0`.
|
|
168
168
|
*/
|
|
169
|
-
first_constant?:
|
|
169
|
+
first_constant?: int32;
|
|
170
170
|
/**
|
|
171
171
|
* When not specified, defaults to `"*"`.
|
|
172
172
|
*/
|
|
@@ -182,7 +182,7 @@ interface ArithmeticCombinatorParameters {
|
|
|
182
182
|
/**
|
|
183
183
|
* Constant to use as the second argument of the operation. Has no effect when `second_signal` is set. Defaults to `0`.
|
|
184
184
|
*/
|
|
185
|
-
second_constant?:
|
|
185
|
+
second_constant?: int32;
|
|
186
186
|
/**
|
|
187
187
|
* Specifies the signal to output.
|
|
188
188
|
*/
|
|
@@ -301,7 +301,7 @@ interface AsteroidCollectorBlueprintControlBehavior {
|
|
|
301
301
|
}
|
|
302
302
|
interface AsteroidMapSettings {
|
|
303
303
|
spawning_rate: double;
|
|
304
|
-
max_ray_portals_expanded_per_tick:
|
|
304
|
+
max_ray_portals_expanded_per_tick: uint32;
|
|
305
305
|
}
|
|
306
306
|
interface AttackParameterFluid {
|
|
307
307
|
/**
|
|
@@ -365,7 +365,7 @@ interface BaseAttackParameters {
|
|
|
365
365
|
/**
|
|
366
366
|
* Number of ticks it takes for the weapon to actually shoot after it has been ordered to do so.
|
|
367
367
|
*/
|
|
368
|
-
warmup:
|
|
368
|
+
warmup: uint32;
|
|
369
369
|
movement_slow_down_factor: double;
|
|
370
370
|
movement_slow_down_cooldown: float;
|
|
371
371
|
ammo_type?: AmmoType;
|
|
@@ -439,7 +439,7 @@ interface AutoplaceSettings {
|
|
|
439
439
|
* Specifies how probability and richness are calculated when placing something on the map.
|
|
440
440
|
*/
|
|
441
441
|
interface AutoplaceSpecification {
|
|
442
|
-
placement_density:
|
|
442
|
+
placement_density: uint32;
|
|
443
443
|
/**
|
|
444
444
|
* Control prototype name.
|
|
445
445
|
*/
|
|
@@ -479,7 +479,7 @@ interface BaseBlueprintEntity {
|
|
|
479
479
|
/**
|
|
480
480
|
* The entity's unique identifier in the blueprint.
|
|
481
481
|
*/
|
|
482
|
-
entity_number:
|
|
482
|
+
entity_number: uint32;
|
|
483
483
|
/**
|
|
484
484
|
* The prototype name of the entity.
|
|
485
485
|
*/
|
|
@@ -618,7 +618,7 @@ interface BlueprintEntityCar extends BaseBlueprintEntity {
|
|
|
618
618
|
* Applies to variant case `cargo-landing-pad`
|
|
619
619
|
*/
|
|
620
620
|
interface BlueprintEntityCargoLandingPad extends BaseBlueprintEntity {
|
|
621
|
-
'bar'?:
|
|
621
|
+
'bar'?: uint32;
|
|
622
622
|
'control_behavior'?: CargoLandingPadBlueprintControlBehavior;
|
|
623
623
|
'request_filters': BlueprintLogisticSections;
|
|
624
624
|
}
|
|
@@ -647,7 +647,7 @@ interface BlueprintEntityConstantCombinator extends BaseBlueprintEntity {
|
|
|
647
647
|
* Applies to variant case `container`
|
|
648
648
|
*/
|
|
649
649
|
interface BlueprintEntityContainer extends BaseBlueprintEntity {
|
|
650
|
-
'bar'?:
|
|
650
|
+
'bar'?: uint32;
|
|
651
651
|
'control_behavior'?: ContainerBlueprintControlBehavior;
|
|
652
652
|
'filters'?: BlueprintItemFilter[];
|
|
653
653
|
}
|
|
@@ -753,7 +753,7 @@ interface BlueprintEntityInfinityCargoWagon extends BaseBlueprintEntity {
|
|
|
753
753
|
* Applies to variant case `infinity-container`
|
|
754
754
|
*/
|
|
755
755
|
interface BlueprintEntityInfinityContainer extends BaseBlueprintEntity {
|
|
756
|
-
'bar'?:
|
|
756
|
+
'bar'?: uint32;
|
|
757
757
|
'control_behavior'?: LogisticContainerBlueprintControlBehavior;
|
|
758
758
|
'filters'?: BlueprintItemFilter[];
|
|
759
759
|
'infinity_settings': BlueprintInfinityInventorySettings;
|
|
@@ -817,7 +817,7 @@ interface BlueprintEntityLaneSplitter extends BaseBlueprintEntity {
|
|
|
817
817
|
* Applies to variant case `linked-belt`
|
|
818
818
|
*/
|
|
819
819
|
interface BlueprintEntityLinkedBelt extends BaseBlueprintEntity {
|
|
820
|
-
'belt_link'?:
|
|
820
|
+
'belt_link'?: uint32;
|
|
821
821
|
'type': BeltConnectionType;
|
|
822
822
|
}
|
|
823
823
|
/**
|
|
@@ -825,7 +825,7 @@ interface BlueprintEntityLinkedBelt extends BaseBlueprintEntity {
|
|
|
825
825
|
* Applies to variant case `linked-container`
|
|
826
826
|
*/
|
|
827
827
|
interface BlueprintEntityLinkedContainer extends BaseBlueprintEntity {
|
|
828
|
-
'link_id':
|
|
828
|
+
'link_id': uint32;
|
|
829
829
|
}
|
|
830
830
|
/**
|
|
831
831
|
*
|
|
@@ -870,7 +870,7 @@ interface BlueprintEntityLocomotive extends BaseBlueprintEntity {
|
|
|
870
870
|
* Applies to variant case `logistic-container`
|
|
871
871
|
*/
|
|
872
872
|
interface BlueprintEntityLogisticContainer extends BaseBlueprintEntity {
|
|
873
|
-
'bar'?:
|
|
873
|
+
'bar'?: uint32;
|
|
874
874
|
'control_behavior'?: LogisticContainerBlueprintControlBehavior;
|
|
875
875
|
'filters'?: BlueprintItemFilter[];
|
|
876
876
|
'request_filters': BlueprintLogisticSections;
|
|
@@ -968,7 +968,7 @@ interface BlueprintEntitySelectorCombinator extends BaseBlueprintEntity {
|
|
|
968
968
|
* Applies to variant case `space-platform-hub`
|
|
969
969
|
*/
|
|
970
970
|
interface BlueprintEntitySpacePlatformHub extends BaseBlueprintEntity {
|
|
971
|
-
'bar'?:
|
|
971
|
+
'bar'?: uint32;
|
|
972
972
|
'control_behavior'?: SpacePlatformHubBlueprintControlBehavior;
|
|
973
973
|
'request_filters': BlueprintLogisticSections;
|
|
974
974
|
'request_missing_construction_materials': boolean;
|
|
@@ -994,6 +994,7 @@ interface BlueprintEntitySpiderVehicle extends BaseBlueprintEntity {
|
|
|
994
994
|
* Applies to variant case `splitter`
|
|
995
995
|
*/
|
|
996
996
|
interface BlueprintEntitySplitter extends BaseBlueprintEntity {
|
|
997
|
+
'control_behavior'?: SplitterBlueprintControlBehavior;
|
|
997
998
|
'filter'?: ItemFilter;
|
|
998
999
|
'input_priority'?: SplitterPriority;
|
|
999
1000
|
'output_priority'?: SplitterPriority;
|
|
@@ -1012,7 +1013,7 @@ interface BlueprintEntityStorageTank extends BaseBlueprintEntity {
|
|
|
1012
1013
|
interface BlueprintEntityTrainStop extends BaseBlueprintEntity {
|
|
1013
1014
|
'color'?: Color;
|
|
1014
1015
|
'control_behavior'?: TrainStopBlueprintControlBehavior;
|
|
1015
|
-
'manual_trains_limit'?:
|
|
1016
|
+
'manual_trains_limit'?: uint32;
|
|
1016
1017
|
'priority'?: uint8;
|
|
1017
1018
|
'station': string;
|
|
1018
1019
|
}
|
|
@@ -1074,7 +1075,7 @@ interface BlueprintInsertPlan {
|
|
|
1074
1075
|
/**
|
|
1075
1076
|
* The prototype name and quality of the item to request.
|
|
1076
1077
|
*/
|
|
1077
|
-
id:
|
|
1078
|
+
id: BlueprintItemIDAndQualityIDPair;
|
|
1078
1079
|
/**
|
|
1079
1080
|
* Describes the inventories to insert these items into.
|
|
1080
1081
|
*/
|
|
@@ -1086,7 +1087,7 @@ interface BlueprintInventoryWithFilters {
|
|
|
1086
1087
|
filters?: BlueprintItemFilter[];
|
|
1087
1088
|
}
|
|
1088
1089
|
interface BlueprintItemFilter {
|
|
1089
|
-
index:
|
|
1090
|
+
index: uint32;
|
|
1090
1091
|
/**
|
|
1091
1092
|
* The item.
|
|
1092
1093
|
*/
|
|
@@ -1100,6 +1101,19 @@ interface BlueprintItemFilter {
|
|
|
1100
1101
|
*/
|
|
1101
1102
|
comparator?: ComparatorString;
|
|
1102
1103
|
}
|
|
1104
|
+
/**
|
|
1105
|
+
* An item prototype with optional quality specification.
|
|
1106
|
+
*/
|
|
1107
|
+
interface BlueprintItemIDAndQualityIDPair {
|
|
1108
|
+
/**
|
|
1109
|
+
* Item prototype name.
|
|
1110
|
+
*/
|
|
1111
|
+
name: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* Quality prototype name. Defaults to "normal".
|
|
1114
|
+
*/
|
|
1115
|
+
quality?: string;
|
|
1116
|
+
}
|
|
1103
1117
|
interface BlueprintLogisticFilter {
|
|
1104
1118
|
index: LogisticFilterIndex;
|
|
1105
1119
|
/**
|
|
@@ -1118,7 +1132,7 @@ interface BlueprintLogisticFilter {
|
|
|
1118
1132
|
* The comparator for quality. `nil` if any quality.
|
|
1119
1133
|
*/
|
|
1120
1134
|
comparator?: ComparatorString;
|
|
1121
|
-
count:
|
|
1135
|
+
count: int32;
|
|
1122
1136
|
max_count?: ItemCountType;
|
|
1123
1137
|
/**
|
|
1124
1138
|
* Defaults to 0.
|
|
@@ -1179,7 +1193,7 @@ interface BlueprintSignalIcon {
|
|
|
1179
1193
|
/**
|
|
1180
1194
|
* Index of the icon in the blueprint icons slots. An integer in the range [1, 4].
|
|
1181
1195
|
*/
|
|
1182
|
-
index:
|
|
1196
|
+
index: uint32;
|
|
1183
1197
|
}
|
|
1184
1198
|
/**
|
|
1185
1199
|
* Describes a single wire in the blueprint. The members of the tuple are, in order:
|
|
@@ -1193,13 +1207,14 @@ interface BlueprintSignalIcon {
|
|
|
1193
1207
|
* - `target_wire_connector_id`
|
|
1194
1208
|
*/
|
|
1195
1209
|
type BlueprintWire = [
|
|
1196
|
-
|
|
1210
|
+
uint32,
|
|
1197
1211
|
defines.wire_connector_id,
|
|
1198
|
-
|
|
1212
|
+
uint32,
|
|
1199
1213
|
defines.wire_connector_id
|
|
1200
1214
|
];
|
|
1201
1215
|
interface BlueprintWireEnd {
|
|
1202
1216
|
entity: BlueprintEntity;
|
|
1217
|
+
surface_index?: uint32;
|
|
1203
1218
|
connector: defines.wire_connector_id;
|
|
1204
1219
|
}
|
|
1205
1220
|
/**
|
|
@@ -1244,7 +1259,7 @@ interface CapsuleActionDestroyCliffs extends BaseCapsuleAction {
|
|
|
1244
1259
|
'type': 'destroy-cliffs';
|
|
1245
1260
|
'attack_parameters': AttackParameters;
|
|
1246
1261
|
'radius': float;
|
|
1247
|
-
'timeout':
|
|
1262
|
+
'timeout': uint32;
|
|
1248
1263
|
}
|
|
1249
1264
|
/**
|
|
1250
1265
|
*
|
|
@@ -1312,7 +1327,7 @@ interface CargoDestination {
|
|
|
1312
1327
|
/**
|
|
1313
1328
|
* Only used if `type` is {@link space_platform | runtime:defines.cargo_destination.space_platform}. Only used for sending space platform starter packs to a platform that is waiting for a starter pack.
|
|
1314
1329
|
*/
|
|
1315
|
-
space_platform?:
|
|
1330
|
+
space_platform?: LuaSpacePlatform;
|
|
1316
1331
|
}
|
|
1317
1332
|
interface CargoLandingPadBlueprintControlBehavior {
|
|
1318
1333
|
/**
|
|
@@ -1333,18 +1348,18 @@ interface ChartTagSpec {
|
|
|
1333
1348
|
* Coordinates of a chunk in a {@link LuaSurface | runtime:LuaSurface} where each integer `x`/`y` represents a different chunk. This uses the same format as {@link MapPosition | runtime:MapPosition}, meaning it can be specified either with or without explicit keys. A {@link MapPosition | runtime:MapPosition} can be translated to a ChunkPosition by dividing the `x`/`y` values by 32.
|
|
1334
1349
|
*/
|
|
1335
1350
|
type ChunkPosition = {
|
|
1336
|
-
x:
|
|
1337
|
-
y:
|
|
1351
|
+
x: int32;
|
|
1352
|
+
y: int32;
|
|
1338
1353
|
} | [
|
|
1339
|
-
|
|
1340
|
-
|
|
1354
|
+
int32,
|
|
1355
|
+
int32
|
|
1341
1356
|
];
|
|
1342
1357
|
/**
|
|
1343
1358
|
* A {@link ChunkPosition | runtime:ChunkPosition} with an added bounding box for the area of the chunk.
|
|
1344
1359
|
*/
|
|
1345
1360
|
interface ChunkPositionAndArea {
|
|
1346
|
-
x:
|
|
1347
|
-
y:
|
|
1361
|
+
x: int32;
|
|
1362
|
+
y: int32;
|
|
1348
1363
|
area: BoundingBox;
|
|
1349
1364
|
}
|
|
1350
1365
|
interface CircuitCondition {
|
|
@@ -1363,7 +1378,7 @@ interface CircuitCondition {
|
|
|
1363
1378
|
/**
|
|
1364
1379
|
* Constant to compare `first_signal` to. Has no effect when `second_signal` is set. When neither `second_signal` nor `constant` are specified, the effect is as though `constant` were specified with the value `0`.
|
|
1365
1380
|
*/
|
|
1366
|
-
constant?:
|
|
1381
|
+
constant?: int32;
|
|
1367
1382
|
}
|
|
1368
1383
|
interface CircuitConditionDefinition {
|
|
1369
1384
|
/**
|
|
@@ -1381,7 +1396,7 @@ interface CircuitConditionDefinition {
|
|
|
1381
1396
|
/**
|
|
1382
1397
|
* Constant to compare `first_signal` to. Has no effect when `second_signal` is set. When neither `second_signal` nor `constant` are specified, the effect is as though `constant` were specified with the value `0`.
|
|
1383
1398
|
*/
|
|
1384
|
-
constant?:
|
|
1399
|
+
constant?: int32;
|
|
1385
1400
|
/**
|
|
1386
1401
|
* Whether the condition is currently fulfilled.
|
|
1387
1402
|
*/
|
|
@@ -1689,9 +1704,9 @@ interface CommandStop extends BaseCommand {
|
|
|
1689
1704
|
*/
|
|
1690
1705
|
'distraction'?: defines.distraction;
|
|
1691
1706
|
/**
|
|
1692
|
-
* Ticks to wander before successfully completing the command. Default is max
|
|
1707
|
+
* Ticks to wander before successfully completing the command. Default is max uint32, which means stop forever.
|
|
1693
1708
|
*/
|
|
1694
|
-
'ticks_to_wait'?:
|
|
1709
|
+
'ticks_to_wait'?: uint32;
|
|
1695
1710
|
}
|
|
1696
1711
|
/**
|
|
1697
1712
|
*
|
|
@@ -1711,9 +1726,9 @@ interface CommandWander extends BaseCommand {
|
|
|
1711
1726
|
*/
|
|
1712
1727
|
'radius'?: double;
|
|
1713
1728
|
/**
|
|
1714
|
-
* Ticks to wander before successfully completing the command. Default is max
|
|
1729
|
+
* Ticks to wander before successfully completing the command. Default is max uint32, which means wander forever.
|
|
1715
1730
|
*/
|
|
1716
|
-
'ticks_to_wait'?:
|
|
1731
|
+
'ticks_to_wait'?: uint32;
|
|
1717
1732
|
/**
|
|
1718
1733
|
* When commanding a group, defines how the group will wander. When `true`, the units in the group will wander around inside the group's radius, just like gathering biters. When `false`, the units will wander as a group, ie they will all walk together in the same random direction. Default is true for groups. Passing true for a single unit is an error.
|
|
1719
1734
|
*/
|
|
@@ -1770,7 +1785,7 @@ interface CompiledLogisticFilter {
|
|
|
1770
1785
|
* The comparator for quality. `nil` if any quality.
|
|
1771
1786
|
*/
|
|
1772
1787
|
comparator?: ComparatorString;
|
|
1773
|
-
count:
|
|
1788
|
+
count: int32;
|
|
1774
1789
|
max_count?: ItemCountType;
|
|
1775
1790
|
/**
|
|
1776
1791
|
* Defaults to 0.
|
|
@@ -1820,7 +1835,7 @@ interface CraftingQueueItem {
|
|
|
1820
1835
|
/**
|
|
1821
1836
|
* The index of the item in the crafting queue.
|
|
1822
1837
|
*/
|
|
1823
|
-
index:
|
|
1838
|
+
index: uint32;
|
|
1824
1839
|
/**
|
|
1825
1840
|
* The recipe being crafted.
|
|
1826
1841
|
*/
|
|
@@ -1828,7 +1843,7 @@ interface CraftingQueueItem {
|
|
|
1828
1843
|
/**
|
|
1829
1844
|
* The amount of items being crafted.
|
|
1830
1845
|
*/
|
|
1831
|
-
count:
|
|
1846
|
+
count: uint32;
|
|
1832
1847
|
/**
|
|
1833
1848
|
* The item is a prerequisite for another item in the queue.
|
|
1834
1849
|
*/
|
|
@@ -1870,11 +1885,11 @@ interface CustomCommandData {
|
|
|
1870
1885
|
/**
|
|
1871
1886
|
* The tick the command was used in.
|
|
1872
1887
|
*/
|
|
1873
|
-
tick:
|
|
1888
|
+
tick: uint32;
|
|
1874
1889
|
/**
|
|
1875
1890
|
* The player who issued the command, or `nil` if it was issued from the server console.
|
|
1876
1891
|
*/
|
|
1877
|
-
player_index?:
|
|
1892
|
+
player_index?: uint32;
|
|
1878
1893
|
/**
|
|
1879
1894
|
* The parameter passed after the command, if there is one.
|
|
1880
1895
|
*/
|
|
@@ -1884,6 +1899,18 @@ interface CustomEntityStatus {
|
|
|
1884
1899
|
diode: defines.entity_status_diode;
|
|
1885
1900
|
label: LocalisedString;
|
|
1886
1901
|
}
|
|
1902
|
+
interface CustomTooltipField {
|
|
1903
|
+
name: LocalisedString;
|
|
1904
|
+
value: LocalisedString;
|
|
1905
|
+
quality_header: string;
|
|
1906
|
+
/**
|
|
1907
|
+
* Dictionary of quality name to localised string representing the value.
|
|
1908
|
+
*/
|
|
1909
|
+
quality_values: Record<string, LocalisedString>;
|
|
1910
|
+
order: uint8;
|
|
1911
|
+
show_in_factoriopedia: boolean;
|
|
1912
|
+
show_in_tooltip: boolean;
|
|
1913
|
+
}
|
|
1887
1914
|
interface CutsceneWaypoint {
|
|
1888
1915
|
/**
|
|
1889
1916
|
* Position to pan the camera to.
|
|
@@ -1896,11 +1923,11 @@ interface CutsceneWaypoint {
|
|
|
1896
1923
|
/**
|
|
1897
1924
|
* How many ticks it will take to reach this waypoint from the previous one.
|
|
1898
1925
|
*/
|
|
1899
|
-
transition_time:
|
|
1926
|
+
transition_time: uint32;
|
|
1900
1927
|
/**
|
|
1901
1928
|
* Time in ticks to wait before moving to the next waypoint.
|
|
1902
1929
|
*/
|
|
1903
|
-
time_to_wait:
|
|
1930
|
+
time_to_wait: uint32;
|
|
1904
1931
|
/**
|
|
1905
1932
|
* Zoom level to be set when the waypoint is reached. When not specified, the previous waypoint's zoom is used.
|
|
1906
1933
|
*/
|
|
@@ -1927,7 +1954,7 @@ LuaDamagePrototype | /**
|
|
|
1927
1954
|
*/
|
|
1928
1955
|
string;
|
|
1929
1956
|
interface DeciderCombinatorBlueprintControlBehavior {
|
|
1930
|
-
decider_conditions:
|
|
1957
|
+
decider_conditions: DeciderCombinatorParameters;
|
|
1931
1958
|
}
|
|
1932
1959
|
interface DeciderCombinatorCondition {
|
|
1933
1960
|
/**
|
|
@@ -1949,7 +1976,7 @@ interface DeciderCombinatorCondition {
|
|
|
1949
1976
|
/**
|
|
1950
1977
|
* Constant to compare `first_signal` to. Has no effect when `second_signal` is set. When neither `second_signal` nor `constant` are specified, the effect is as though `constant` were specified with the value `0`.
|
|
1951
1978
|
*/
|
|
1952
|
-
constant?:
|
|
1979
|
+
constant?: int32;
|
|
1953
1980
|
/**
|
|
1954
1981
|
* Specifies how the inputs should be compared. If not specified, defaults to `"<"`.
|
|
1955
1982
|
*/
|
|
@@ -1971,7 +1998,7 @@ interface DeciderCombinatorOutput {
|
|
|
1971
1998
|
/**
|
|
1972
1999
|
* The value to output when not copying input. Defaults to `1`.
|
|
1973
2000
|
*/
|
|
1974
|
-
constant?:
|
|
2001
|
+
constant?: int32;
|
|
1975
2002
|
/**
|
|
1976
2003
|
* Sets which input network to read the value of `signal` from if `copy_count_from_input` is `true`. Defaults to both.
|
|
1977
2004
|
*/
|
|
@@ -2041,7 +2068,7 @@ interface DecorativePrototypeFilterCollisionMask extends BaseDecorativePrototype
|
|
|
2041
2068
|
interface DecorativeResult {
|
|
2042
2069
|
position: TilePosition;
|
|
2043
2070
|
decorative: LuaDecorativePrototype;
|
|
2044
|
-
amount:
|
|
2071
|
+
amount: uint32;
|
|
2045
2072
|
}
|
|
2046
2073
|
interface DetailedItemOnLine {
|
|
2047
2074
|
stack: LuaItemStack;
|
|
@@ -2052,7 +2079,7 @@ interface DetailedItemOnLine {
|
|
|
2052
2079
|
/**
|
|
2053
2080
|
* Unique identifier of this item while it is on transport lines.
|
|
2054
2081
|
*/
|
|
2055
|
-
unique_id:
|
|
2082
|
+
unique_id: uint32;
|
|
2056
2083
|
}
|
|
2057
2084
|
/**
|
|
2058
2085
|
* Technology difficulty settings. Updating any of the attributes will immediately take effect in the game engine.
|
|
@@ -2085,8 +2112,8 @@ interface DisplayPanelMessageDefinition {
|
|
|
2085
2112
|
condition: CircuitConditionDefinition;
|
|
2086
2113
|
}
|
|
2087
2114
|
interface DisplayResolution {
|
|
2088
|
-
width:
|
|
2089
|
-
height:
|
|
2115
|
+
width: uint32;
|
|
2116
|
+
height: uint32;
|
|
2090
2117
|
}
|
|
2091
2118
|
interface DragTarget {
|
|
2092
2119
|
target_entity: LuaEntity;
|
|
@@ -2108,7 +2135,7 @@ interface EffectReceiver {
|
|
|
2108
2135
|
* An item thrown overboard on a space platform.
|
|
2109
2136
|
*/
|
|
2110
2137
|
interface EjectedItem {
|
|
2111
|
-
item:
|
|
2138
|
+
item: ItemIDAndQualityIDPair;
|
|
2112
2139
|
position: MapPosition;
|
|
2113
2140
|
movement: Vector;
|
|
2114
2141
|
platform_speed_at_creation: double;
|
|
@@ -2182,15 +2209,15 @@ interface EnemyExpansionMapSettings {
|
|
|
2182
2209
|
/**
|
|
2183
2210
|
* Distance in chunks from the furthest base around to prevent expansions from reaching too far into the player's territory. Defaults to `7`.
|
|
2184
2211
|
*/
|
|
2185
|
-
max_expansion_distance:
|
|
2212
|
+
max_expansion_distance: uint32;
|
|
2186
2213
|
/**
|
|
2187
2214
|
* Defaults to `2`.
|
|
2188
2215
|
*/
|
|
2189
|
-
friendly_base_influence_radius:
|
|
2216
|
+
friendly_base_influence_radius: uint32;
|
|
2190
2217
|
/**
|
|
2191
2218
|
* Defaults to `2`.
|
|
2192
2219
|
*/
|
|
2193
|
-
enemy_building_influence_radius:
|
|
2220
|
+
enemy_building_influence_radius: uint32;
|
|
2194
2221
|
/**
|
|
2195
2222
|
* Defaults to `0.1`.
|
|
2196
2223
|
*/
|
|
@@ -2214,19 +2241,19 @@ interface EnemyExpansionMapSettings {
|
|
|
2214
2241
|
/**
|
|
2215
2242
|
* The minimum size of a biter group that goes to build a new base. This is multiplied by the evolution factor. Defaults to `5`.
|
|
2216
2243
|
*/
|
|
2217
|
-
settler_group_min_size:
|
|
2244
|
+
settler_group_min_size: uint32;
|
|
2218
2245
|
/**
|
|
2219
2246
|
* The maximum size of a biter group that goes to build a new base. This is multiplied by the evolution factor. Defaults to `20`.
|
|
2220
2247
|
*/
|
|
2221
|
-
settler_group_max_size:
|
|
2248
|
+
settler_group_max_size: uint32;
|
|
2222
2249
|
/**
|
|
2223
2250
|
* The minimum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `4*3 600=14 400` ticks.
|
|
2224
2251
|
*/
|
|
2225
|
-
min_expansion_cooldown:
|
|
2252
|
+
min_expansion_cooldown: uint32;
|
|
2226
2253
|
/**
|
|
2227
2254
|
* The maximum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `60*3 600=216 000` ticks.
|
|
2228
2255
|
*/
|
|
2229
|
-
max_expansion_cooldown:
|
|
2256
|
+
max_expansion_cooldown: uint32;
|
|
2230
2257
|
}
|
|
2231
2258
|
/**
|
|
2232
2259
|
* An entity prototype may be specified in one of three ways.
|
|
@@ -2523,7 +2550,7 @@ interface EntitySearchFilters {
|
|
|
2523
2550
|
force?: ForceSet;
|
|
2524
2551
|
to_be_deconstructed?: boolean;
|
|
2525
2552
|
to_be_upgraded?: boolean;
|
|
2526
|
-
limit?:
|
|
2553
|
+
limit?: uint32;
|
|
2527
2554
|
is_military_target?: boolean;
|
|
2528
2555
|
has_item_inside?: ItemWithQualityID;
|
|
2529
2556
|
quality?: QualityCondition;
|
|
@@ -2578,8 +2605,8 @@ interface EquipmentIDAndQualityIDPair {
|
|
|
2578
2605
|
* A table used to define a manual shape for a piece of equipment.
|
|
2579
2606
|
*/
|
|
2580
2607
|
interface EquipmentPoint {
|
|
2581
|
-
x:
|
|
2582
|
-
y:
|
|
2608
|
+
x: uint32;
|
|
2609
|
+
y: uint32;
|
|
2583
2610
|
}
|
|
2584
2611
|
/**
|
|
2585
2612
|
* Position inside an equipment grid. This uses the same format as {@link MapPosition | runtime:MapPosition}, meaning it can be specified either with or without explicit keys.
|
|
@@ -2594,11 +2621,11 @@ interface EquipmentPoint {
|
|
|
2594
2621
|
```
|
|
2595
2622
|
*/
|
|
2596
2623
|
type EquipmentPosition = {
|
|
2597
|
-
x:
|
|
2598
|
-
y:
|
|
2624
|
+
x: int32;
|
|
2625
|
+
y: int32;
|
|
2599
2626
|
} | [
|
|
2600
|
-
|
|
2601
|
-
|
|
2627
|
+
int32,
|
|
2628
|
+
int32
|
|
2602
2629
|
];
|
|
2603
2630
|
interface BaseEquipmentPrototypeFilter {
|
|
2604
2631
|
/**
|
|
@@ -2637,7 +2664,7 @@ interface EquipmentWithQualityCounts {
|
|
|
2637
2664
|
/**
|
|
2638
2665
|
* The number of equipment items.
|
|
2639
2666
|
*/
|
|
2640
|
-
count:
|
|
2667
|
+
count: uint32;
|
|
2641
2668
|
/**
|
|
2642
2669
|
* Name of the equipment's quality prototype.
|
|
2643
2670
|
*/
|
|
@@ -2670,7 +2697,7 @@ interface EventData {
|
|
|
2670
2697
|
/**
|
|
2671
2698
|
* The tick during which the event happened.
|
|
2672
2699
|
*/
|
|
2673
|
-
tick:
|
|
2700
|
+
tick: uint32;
|
|
2674
2701
|
/**
|
|
2675
2702
|
* The name of the mod that raised the event if it was raised using {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event}.
|
|
2676
2703
|
*/
|
|
@@ -2725,9 +2752,9 @@ interface Fluid {
|
|
|
2725
2752
|
*/
|
|
2726
2753
|
type FluidAmount = double;
|
|
2727
2754
|
interface FluidBoxConnectionRecord {
|
|
2728
|
-
this_linked_connection_id:
|
|
2755
|
+
this_linked_connection_id: uint32;
|
|
2729
2756
|
other_entity: LuaEntity;
|
|
2730
|
-
other_linked_connection_id:
|
|
2757
|
+
other_linked_connection_id: uint32;
|
|
2731
2758
|
}
|
|
2732
2759
|
interface FluidBoxFilter {
|
|
2733
2760
|
/**
|
|
@@ -2817,7 +2844,7 @@ interface FluidProduct {
|
|
|
2817
2844
|
* The fluid temperature of this product.
|
|
2818
2845
|
*/
|
|
2819
2846
|
temperature?: float;
|
|
2820
|
-
fluidbox_index?:
|
|
2847
|
+
fluidbox_index?: uint32;
|
|
2821
2848
|
}
|
|
2822
2849
|
interface BaseFluidPrototypeFilter {
|
|
2823
2850
|
/**
|
|
@@ -3130,7 +3157,7 @@ interface GuiAnchor {
|
|
|
3130
3157
|
* Used for specifying where a GUI arrow should point to.
|
|
3131
3158
|
*/
|
|
3132
3159
|
interface BaseGuiArrowSpecification {
|
|
3133
|
-
margin:
|
|
3160
|
+
margin: uint32;
|
|
3134
3161
|
/**
|
|
3135
3162
|
* This determines which of the following fields will be required.
|
|
3136
3163
|
*/
|
|
@@ -3152,7 +3179,7 @@ interface GuiArrowSpecificationCraftingQueue extends BaseGuiArrowSpecification {
|
|
|
3152
3179
|
/**
|
|
3153
3180
|
* Index in the crafting queue to point to.
|
|
3154
3181
|
*/
|
|
3155
|
-
'crafting_queueindex':
|
|
3182
|
+
'crafting_queueindex': uint32;
|
|
3156
3183
|
}
|
|
3157
3184
|
/**
|
|
3158
3185
|
*
|
|
@@ -3181,7 +3208,7 @@ interface GuiArrowSpecificationItemStack extends BaseGuiArrowSpecification {
|
|
|
3181
3208
|
/**
|
|
3182
3209
|
* Which stack to point to.
|
|
3183
3210
|
*/
|
|
3184
|
-
'item_stack_index':
|
|
3211
|
+
'item_stack_index': uint32;
|
|
3185
3212
|
'source': 'player' | 'target' | 'player-quickbar';
|
|
3186
3213
|
}
|
|
3187
3214
|
/**
|
|
@@ -3292,11 +3319,11 @@ type GuiElementType = /**
|
|
|
3292
3319
|
* Screen coordinates of a GUI element in a {@link LuaGui | runtime:LuaGui}. This uses the same format as {@link TilePosition | runtime:TilePosition}, meaning it can be specified either with or without explicit keys.
|
|
3293
3320
|
*/
|
|
3294
3321
|
type GuiLocation = {
|
|
3295
|
-
x:
|
|
3296
|
-
y:
|
|
3322
|
+
x: int32;
|
|
3323
|
+
y: int32;
|
|
3297
3324
|
} | [
|
|
3298
|
-
|
|
3299
|
-
|
|
3325
|
+
int32,
|
|
3326
|
+
int32
|
|
3300
3327
|
];
|
|
3301
3328
|
interface GunShift4Way {
|
|
3302
3329
|
north: Vector;
|
|
@@ -3330,7 +3357,7 @@ interface IconDrawSpecification {
|
|
|
3330
3357
|
shift: Vector;
|
|
3331
3358
|
scale: float;
|
|
3332
3359
|
scale_for_many: float;
|
|
3333
|
-
render_layer
|
|
3360
|
+
render_layer: 'entity-info-icon' | 'entity-info-icon-above' | 'air-entity-info-icon';
|
|
3334
3361
|
}
|
|
3335
3362
|
interface IconSequencePositioning {
|
|
3336
3363
|
inventory_index: defines.inventory;
|
|
@@ -3364,7 +3391,7 @@ interface InfinityInventoryFilter {
|
|
|
3364
3391
|
/**
|
|
3365
3392
|
* The index of this filter in the filters list. Not required when writing a filter.
|
|
3366
3393
|
*/
|
|
3367
|
-
index?:
|
|
3394
|
+
index?: uint32;
|
|
3368
3395
|
}
|
|
3369
3396
|
/**
|
|
3370
3397
|
* A single filter used by an infinity-pipe type entity.
|
|
@@ -3400,7 +3427,7 @@ interface BaseIngredient {
|
|
|
3400
3427
|
/**
|
|
3401
3428
|
* How much of this ingredient is ignored by statistics.
|
|
3402
3429
|
*/
|
|
3403
|
-
ignored_by_stats?:
|
|
3430
|
+
ignored_by_stats?: uint32 | double;
|
|
3404
3431
|
}
|
|
3405
3432
|
type Ingredient = BaseIngredient | IngredientFluid;
|
|
3406
3433
|
/**
|
|
@@ -3409,7 +3436,7 @@ type Ingredient = BaseIngredient | IngredientFluid;
|
|
|
3409
3436
|
*/
|
|
3410
3437
|
interface IngredientFluid extends BaseIngredient {
|
|
3411
3438
|
'type': 'fluid';
|
|
3412
|
-
'fluidbox_index'?:
|
|
3439
|
+
'fluidbox_index'?: uint32;
|
|
3413
3440
|
'fluidbox_multiplier'?: uint8;
|
|
3414
3441
|
/**
|
|
3415
3442
|
* The maximum fluid temperature allowed.
|
|
@@ -3475,7 +3502,7 @@ interface InventoryWithCustomStackSizeSpecification {
|
|
|
3475
3502
|
stack_size_override: Record<string, ItemCountType>;
|
|
3476
3503
|
with_bar: boolean;
|
|
3477
3504
|
}
|
|
3478
|
-
type ItemCountType =
|
|
3505
|
+
type ItemCountType = uint32;
|
|
3479
3506
|
/**
|
|
3480
3507
|
* An item filter may be specified in two ways, either as a string which is an item prototype name or as a table.
|
|
3481
3508
|
*/
|
|
@@ -3817,7 +3844,7 @@ interface ItemPrototypeFilterStackSize extends BaseItemPrototypeFilter {
|
|
|
3817
3844
|
/**
|
|
3818
3845
|
* The value to compare against.
|
|
3819
3846
|
*/
|
|
3820
|
-
'value':
|
|
3847
|
+
'value': uint32;
|
|
3821
3848
|
}
|
|
3822
3849
|
/**
|
|
3823
3850
|
*
|
|
@@ -3959,7 +3986,7 @@ ItemStackDefinition | LuaItemStack;
|
|
|
3959
3986
|
type ItemStackIndex = uint16;
|
|
3960
3987
|
interface ItemStackLocation {
|
|
3961
3988
|
inventory: defines.inventory;
|
|
3962
|
-
slot:
|
|
3989
|
+
slot: uint32;
|
|
3963
3990
|
}
|
|
3964
3991
|
interface ItemToPlace {
|
|
3965
3992
|
/**
|
|
@@ -4059,9 +4086,9 @@ interface LogisticFilter {
|
|
|
4059
4086
|
*/
|
|
4060
4087
|
value?: SignalFilter;
|
|
4061
4088
|
/**
|
|
4062
|
-
* The minimum amount to satisfy.
|
|
4089
|
+
* The minimum amount to satisfy. If `min` is non-zero, and `value` is present, then the quality condition inside `value` does not allow quality ranges.
|
|
4063
4090
|
*/
|
|
4064
|
-
min?:
|
|
4091
|
+
min?: int32;
|
|
4065
4092
|
/**
|
|
4066
4093
|
* The maximum amount to keep in inventory. `nil` for infinite.
|
|
4067
4094
|
*/
|
|
@@ -4104,19 +4131,19 @@ interface LogisticsNetworkSupplyCounts {
|
|
|
4104
4131
|
/**
|
|
4105
4132
|
* Number of available items in the storage members.
|
|
4106
4133
|
*/
|
|
4107
|
-
storage:
|
|
4134
|
+
storage: uint32;
|
|
4108
4135
|
/**
|
|
4109
4136
|
* Number of available items in the passive provider members.
|
|
4110
4137
|
*/
|
|
4111
|
-
'passive-provider':
|
|
4138
|
+
'passive-provider': uint32;
|
|
4112
4139
|
/**
|
|
4113
4140
|
* Number of available items in the buffer members.
|
|
4114
4141
|
*/
|
|
4115
|
-
buffer:
|
|
4142
|
+
buffer: uint32;
|
|
4116
4143
|
/**
|
|
4117
4144
|
* Number of available items in the active provider members.
|
|
4118
4145
|
*/
|
|
4119
|
-
'active-provider':
|
|
4146
|
+
'active-provider': uint32;
|
|
4120
4147
|
}
|
|
4121
4148
|
interface LogisticsNetworkSupplyPoints {
|
|
4122
4149
|
storage: LuaLogisticPoint[];
|
|
@@ -6227,7 +6254,7 @@ interface MapAndDifficultySettings {
|
|
|
6227
6254
|
/**
|
|
6228
6255
|
* If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck within their own base.
|
|
6229
6256
|
*/
|
|
6230
|
-
max_failed_behavior_count:
|
|
6257
|
+
max_failed_behavior_count: uint32;
|
|
6231
6258
|
difficulty_settings: MapDifficultySettings;
|
|
6232
6259
|
}
|
|
6233
6260
|
interface MapDifficultySettings {
|
|
@@ -6294,15 +6321,15 @@ interface MapGenSettings {
|
|
|
6294
6321
|
/**
|
|
6295
6322
|
* The random seed used to generated this map.
|
|
6296
6323
|
*/
|
|
6297
|
-
seed:
|
|
6324
|
+
seed: uint32;
|
|
6298
6325
|
/**
|
|
6299
6326
|
* Width in tiles. If `0`, the map has 'infinite' width, with the actual limitation being one million tiles in each direction from the center.
|
|
6300
6327
|
*/
|
|
6301
|
-
width:
|
|
6328
|
+
width: uint32;
|
|
6302
6329
|
/**
|
|
6303
6330
|
* Height in tiles. If `0`, the map has 'infinite' height, with the actual limitation being one million tiles in each direction from the center.
|
|
6304
6331
|
*/
|
|
6305
|
-
height:
|
|
6332
|
+
height: uint32;
|
|
6306
6333
|
/**
|
|
6307
6334
|
* Size of the starting area.
|
|
6308
6335
|
*/
|
|
@@ -6427,7 +6454,7 @@ interface MapSettings {
|
|
|
6427
6454
|
/**
|
|
6428
6455
|
* If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck within their own base.
|
|
6429
6456
|
*/
|
|
6430
|
-
max_failed_behavior_count:
|
|
6457
|
+
max_failed_behavior_count: uint32;
|
|
6431
6458
|
path_finder: PathFinderMapSettings;
|
|
6432
6459
|
pollution: PollutionMapSettings;
|
|
6433
6460
|
steering: SteeringMapSetting;
|
|
@@ -6562,7 +6589,7 @@ interface ModSetting {
|
|
|
6562
6589
|
/**
|
|
6563
6590
|
* The value of the mod setting. The type depends on the kind of setting.
|
|
6564
6591
|
*/
|
|
6565
|
-
value:
|
|
6592
|
+
value: int32 | double | boolean | string | Color;
|
|
6566
6593
|
}
|
|
6567
6594
|
interface BaseModSettingPrototypeFilter {
|
|
6568
6595
|
/**
|
|
@@ -6668,11 +6695,11 @@ interface NthTickEventData {
|
|
|
6668
6695
|
/**
|
|
6669
6696
|
* The tick during which the event happened.
|
|
6670
6697
|
*/
|
|
6671
|
-
tick:
|
|
6698
|
+
tick: uint32;
|
|
6672
6699
|
/**
|
|
6673
6700
|
* The nth tick this handler was registered to.
|
|
6674
6701
|
*/
|
|
6675
|
-
nth_tick:
|
|
6702
|
+
nth_tick: uint32;
|
|
6676
6703
|
}
|
|
6677
6704
|
/**
|
|
6678
6705
|
* A single offer on a market entity.
|
|
@@ -6705,7 +6732,7 @@ interface PathFinderMapSettings {
|
|
|
6705
6732
|
/**
|
|
6706
6733
|
* The pathfinder performs a step of the backward search every `fwd2bwd_ratio`'th step. The minimum allowed value is `2`, which means symmetric search. The default value is `5`.
|
|
6707
6734
|
*/
|
|
6708
|
-
fwd2bwd_ratio:
|
|
6735
|
+
fwd2bwd_ratio: uint32;
|
|
6709
6736
|
/**
|
|
6710
6737
|
* When looking at which node to check next, their heuristic value is multiplied by this ratio. The higher it is, the more the search is directed straight at the goal. Defaults to `2`.
|
|
6711
6738
|
*/
|
|
@@ -6721,15 +6748,15 @@ interface PathFinderMapSettings {
|
|
|
6721
6748
|
/**
|
|
6722
6749
|
* The maximum amount of work each pathfinding job is allowed to do per tick. Defaults to `8 000`.
|
|
6723
6750
|
*/
|
|
6724
|
-
max_work_done_per_tick:
|
|
6751
|
+
max_work_done_per_tick: uint32;
|
|
6725
6752
|
/**
|
|
6726
6753
|
* Number of elements in the short cache. Defaults to `5`.
|
|
6727
6754
|
*/
|
|
6728
|
-
short_cache_size:
|
|
6755
|
+
short_cache_size: uint32;
|
|
6729
6756
|
/**
|
|
6730
6757
|
* Number of elements in the long cache. Defaults to `25`.
|
|
6731
6758
|
*/
|
|
6732
|
-
long_cache_size:
|
|
6759
|
+
long_cache_size: uint32;
|
|
6733
6760
|
/**
|
|
6734
6761
|
* The minimal distance to the goal in tiles required to be searched in the short path cache. Defaults to `10`.
|
|
6735
6762
|
*/
|
|
@@ -6737,7 +6764,7 @@ interface PathFinderMapSettings {
|
|
|
6737
6764
|
/**
|
|
6738
6765
|
* The minimal number of nodes required to be searched in the short path cache. Defaults to `50`.
|
|
6739
6766
|
*/
|
|
6740
|
-
short_cache_min_algo_steps_to_cache:
|
|
6767
|
+
short_cache_min_algo_steps_to_cache: uint32;
|
|
6741
6768
|
/**
|
|
6742
6769
|
* The minimal distance to the goal in tiles required to be searched in the long path cache. Defaults to `30`.
|
|
6743
6770
|
*/
|
|
@@ -6745,7 +6772,7 @@ interface PathFinderMapSettings {
|
|
|
6745
6772
|
/**
|
|
6746
6773
|
* When looking for a connection to a cached path, search at most for this number of steps times the original estimate. Defaults to `100`.
|
|
6747
6774
|
*/
|
|
6748
|
-
cache_max_connect_to_cache_steps_multiplier:
|
|
6775
|
+
cache_max_connect_to_cache_steps_multiplier: uint32;
|
|
6749
6776
|
/**
|
|
6750
6777
|
* When looking for a path from cache, make sure it doesn't start too far from the requested start in relative terms. Defaults to `0.2`.
|
|
6751
6778
|
*/
|
|
@@ -6797,19 +6824,19 @@ interface PathFinderMapSettings {
|
|
|
6797
6824
|
/**
|
|
6798
6825
|
* The amount of path finder requests accepted per tick regardless of the requested path's length. Defaults to `10`.
|
|
6799
6826
|
*/
|
|
6800
|
-
max_clients_to_accept_any_new_request:
|
|
6827
|
+
max_clients_to_accept_any_new_request: uint32;
|
|
6801
6828
|
/**
|
|
6802
6829
|
* When the `max_clients_to_accept_any_new_request` amount is exhausted, only path finder requests with a short estimate will be accepted until this amount (per tick) is reached. Defaults to `100`.
|
|
6803
6830
|
*/
|
|
6804
|
-
max_clients_to_accept_short_new_request:
|
|
6831
|
+
max_clients_to_accept_short_new_request: uint32;
|
|
6805
6832
|
/**
|
|
6806
6833
|
* The maximum direct distance in tiles before a request is no longer considered short. Defaults to `100`.
|
|
6807
6834
|
*/
|
|
6808
|
-
direct_distance_to_consider_short_request:
|
|
6835
|
+
direct_distance_to_consider_short_request: uint32;
|
|
6809
6836
|
/**
|
|
6810
6837
|
* The maximum amount of nodes a short request will traverse before being rescheduled as a long request. Defaults to `1000`.
|
|
6811
6838
|
*/
|
|
6812
|
-
short_request_max_steps:
|
|
6839
|
+
short_request_max_steps: uint32;
|
|
6813
6840
|
/**
|
|
6814
6841
|
* The amount of steps that are allocated to short requests each tick, as a percentage of all available steps. Defaults to `0.5`, or 50%.
|
|
6815
6842
|
*/
|
|
@@ -6817,7 +6844,7 @@ interface PathFinderMapSettings {
|
|
|
6817
6844
|
/**
|
|
6818
6845
|
* The minimum amount of steps that are guaranteed to be performed for every request. Defaults to `2000`.
|
|
6819
6846
|
*/
|
|
6820
|
-
min_steps_to_check_path_find_termination:
|
|
6847
|
+
min_steps_to_check_path_find_termination: uint32;
|
|
6821
6848
|
/**
|
|
6822
6849
|
* If the actual amount of steps is higher than the initial estimate by this factor, pathfinding is terminated. Defaults to `2000.0`.
|
|
6823
6850
|
*/
|
|
@@ -6825,7 +6852,7 @@ interface PathFinderMapSettings {
|
|
|
6825
6852
|
/**
|
|
6826
6853
|
* The thresholds of waiting clients after each of which the per-tick work limit will be increased by the corresponding value in `overload_multipliers`. This is to avoid clients having to wait too long. Must have the same number of elements as `overload_multipliers`. Defaults to `{0, 100, 500}`.
|
|
6827
6854
|
*/
|
|
6828
|
-
overload_levels:
|
|
6855
|
+
overload_levels: uint32[];
|
|
6829
6856
|
/**
|
|
6830
6857
|
* The multipliers to the amount of per-tick work applied after the corresponding thresholds in `overload_levels` have been reached. Must have the same number of elements as `overload_multipliers`. Defaults to `{2, 3, 4}`.
|
|
6831
6858
|
*/
|
|
@@ -6833,7 +6860,7 @@ interface PathFinderMapSettings {
|
|
|
6833
6860
|
/**
|
|
6834
6861
|
* The delay in ticks between decrementing the score of all paths in the negative cache by one. Defaults to `20`.
|
|
6835
6862
|
*/
|
|
6836
|
-
negative_path_cache_delay_interval:
|
|
6863
|
+
negative_path_cache_delay_interval: uint32;
|
|
6837
6864
|
}
|
|
6838
6865
|
interface PathfinderFlags {
|
|
6839
6866
|
/**
|
|
@@ -6897,11 +6924,11 @@ interface PipeConnection {
|
|
|
6897
6924
|
/**
|
|
6898
6925
|
* The index of the target fluidbox, if any.
|
|
6899
6926
|
*/
|
|
6900
|
-
target_fluidbox_index?:
|
|
6927
|
+
target_fluidbox_index?: uint32;
|
|
6901
6928
|
/**
|
|
6902
6929
|
* The index of the target fluidbox pipe connection, if any.
|
|
6903
6930
|
*/
|
|
6904
|
-
target_pipe_connection_index?:
|
|
6931
|
+
target_pipe_connection_index?: uint32;
|
|
6905
6932
|
}
|
|
6906
6933
|
interface PipeConnectionDefinition {
|
|
6907
6934
|
connection_type: PipeConnectionType;
|
|
@@ -6912,14 +6939,14 @@ interface PipeConnectionDefinition {
|
|
|
6912
6939
|
/**
|
|
6913
6940
|
* The maximum tile distance this underground connection can connect.
|
|
6914
6941
|
*/
|
|
6915
|
-
max_underground_distance?:
|
|
6942
|
+
max_underground_distance?: uint32;
|
|
6916
6943
|
flow_direction: FluidFlowDirection;
|
|
6917
6944
|
direction: defines.direction;
|
|
6918
6945
|
connection_category: string[];
|
|
6919
6946
|
/**
|
|
6920
6947
|
* Only supplied if `connection_type` is `"linked"`.
|
|
6921
6948
|
*/
|
|
6922
|
-
linked_connection_id?:
|
|
6949
|
+
linked_connection_id?: uint32;
|
|
6923
6950
|
}
|
|
6924
6951
|
type PipeConnectionType = /**
|
|
6925
6952
|
* 2 connections are required to be adjacent tiles next to each other on their respective directions.
|
|
@@ -6937,7 +6964,7 @@ interface PlaceAsTileResult {
|
|
|
6937
6964
|
* The tile prototype.
|
|
6938
6965
|
*/
|
|
6939
6966
|
result: LuaTilePrototype;
|
|
6940
|
-
condition_size:
|
|
6967
|
+
condition_size: uint32;
|
|
6941
6968
|
condition: CollisionMask;
|
|
6942
6969
|
invert: boolean;
|
|
6943
6970
|
tile_condition: LuaTilePrototype[];
|
|
@@ -6946,7 +6973,7 @@ interface PlatformSchedule {
|
|
|
6946
6973
|
/**
|
|
6947
6974
|
* Index of the currently active record
|
|
6948
6975
|
*/
|
|
6949
|
-
current:
|
|
6976
|
+
current: uint32;
|
|
6950
6977
|
records: ScheduleRecord[];
|
|
6951
6978
|
}
|
|
6952
6979
|
interface PlaySoundSpecification {
|
|
@@ -6973,7 +7000,7 @@ interface PlaySoundSpecification {
|
|
|
6973
7000
|
type PlayerIdentification = /**
|
|
6974
7001
|
* The player index.
|
|
6975
7002
|
*/
|
|
6976
|
-
|
|
7003
|
+
uint32 | /**
|
|
6977
7004
|
* The player name.
|
|
6978
7005
|
*/
|
|
6979
7006
|
string | /**
|
|
@@ -7108,10 +7135,7 @@ type Product = /**
|
|
|
7108
7135
|
ItemProduct | /**
|
|
7109
7136
|
* Returned when the `type` is `"fluid"`.
|
|
7110
7137
|
*/
|
|
7111
|
-
FluidProduct
|
|
7112
|
-
* Returned when the `type` is `"research-progress"`.
|
|
7113
|
-
*/
|
|
7114
|
-
ResearchProgressProduct;
|
|
7138
|
+
FluidProduct;
|
|
7115
7139
|
/**
|
|
7116
7140
|
* Specifies how the entity will utilize this fluidbox. `input-output` should only be used for boilers in fluid heating mode.
|
|
7117
7141
|
*/
|
|
@@ -7124,13 +7148,13 @@ interface ProgrammableSpeakerAlertParameters {
|
|
|
7124
7148
|
}
|
|
7125
7149
|
interface ProgrammableSpeakerBlueprintControlBehavior {
|
|
7126
7150
|
circuit_condition: CircuitCondition;
|
|
7127
|
-
|
|
7151
|
+
circuit_parameters: ProgrammableSpeakerCircuitParameters;
|
|
7128
7152
|
}
|
|
7129
7153
|
interface ProgrammableSpeakerCircuitParameters {
|
|
7130
7154
|
signal_value_is_pitch: boolean;
|
|
7131
7155
|
stop_playing_sounds: boolean;
|
|
7132
|
-
instrument_id:
|
|
7133
|
-
note_id:
|
|
7156
|
+
instrument_id: uint32;
|
|
7157
|
+
note_id: uint32;
|
|
7134
7158
|
}
|
|
7135
7159
|
interface ProgrammableSpeakerInstrument {
|
|
7136
7160
|
name: string;
|
|
@@ -7506,7 +7530,7 @@ interface RecipePrototypeFilterOverloadMultiplier extends BaseRecipePrototypeFil
|
|
|
7506
7530
|
/**
|
|
7507
7531
|
* The value to compare against.
|
|
7508
7532
|
*/
|
|
7509
|
-
'value':
|
|
7533
|
+
'value': uint32;
|
|
7510
7534
|
}
|
|
7511
7535
|
/**
|
|
7512
7536
|
*
|
|
@@ -7521,7 +7545,7 @@ interface RecipePrototypeFilterRequestPasteMultiplier extends BaseRecipePrototyp
|
|
|
7521
7545
|
/**
|
|
7522
7546
|
* The value to compare against.
|
|
7523
7547
|
*/
|
|
7524
|
-
'value':
|
|
7548
|
+
'value': uint32;
|
|
7525
7549
|
}
|
|
7526
7550
|
/**
|
|
7527
7551
|
*
|
|
@@ -7837,18 +7861,10 @@ interface ResearchIngredient {
|
|
|
7837
7861
|
*/
|
|
7838
7862
|
amount: uint16;
|
|
7839
7863
|
}
|
|
7840
|
-
interface ResearchProgressProduct {
|
|
7841
|
-
type: 'research-progress';
|
|
7842
|
-
/**
|
|
7843
|
-
* Prototype name of the research item.
|
|
7844
|
-
*/
|
|
7845
|
-
research_item: string;
|
|
7846
|
-
amount: double;
|
|
7847
|
-
}
|
|
7848
7864
|
interface BaseResearchTrigger {
|
|
7849
|
-
type: 'craft-item' | 'mine-entity' | 'craft-fluid' | 'send-item-to-orbit' | 'capture-spawner' | 'build-entity' | 'create-space-platform';
|
|
7865
|
+
type: 'craft-item' | 'mine-entity' | 'craft-fluid' | 'send-item-to-orbit' | 'capture-spawner' | 'build-entity' | 'create-space-platform' | 'scripted';
|
|
7850
7866
|
}
|
|
7851
|
-
type ResearchTrigger = BaseResearchTrigger | ResearchTriggerBuildEntity | ResearchTriggerCaptureSpawner | ResearchTriggerCraftFluid | ResearchTriggerCraftItem | ResearchTriggerMineEntity | ResearchTriggerSendItemToOrbit;
|
|
7867
|
+
type ResearchTrigger = BaseResearchTrigger | ResearchTriggerBuildEntity | ResearchTriggerCaptureSpawner | ResearchTriggerCraftFluid | ResearchTriggerCraftItem | ResearchTriggerMineEntity | ResearchTriggerScripted | ResearchTriggerSendItemToOrbit;
|
|
7852
7868
|
/**
|
|
7853
7869
|
*
|
|
7854
7870
|
* Applies to variant case `build-entity`
|
|
@@ -7891,6 +7907,14 @@ interface ResearchTriggerMineEntity extends BaseResearchTrigger {
|
|
|
7891
7907
|
'type': 'mine-entity';
|
|
7892
7908
|
'entity': string;
|
|
7893
7909
|
}
|
|
7910
|
+
/**
|
|
7911
|
+
*
|
|
7912
|
+
* Applies to variant case `scripted`
|
|
7913
|
+
*/
|
|
7914
|
+
interface ResearchTriggerScripted extends BaseResearchTrigger {
|
|
7915
|
+
'type': 'scripted';
|
|
7916
|
+
'trigger_description': LocalisedString;
|
|
7917
|
+
}
|
|
7894
7918
|
/**
|
|
7895
7919
|
*
|
|
7896
7920
|
* Applies to variant case `send-item-to-orbit`
|
|
@@ -7965,11 +7989,11 @@ interface ScheduleRecordPosition {
|
|
|
7965
7989
|
/**
|
|
7966
7990
|
* The schedule index
|
|
7967
7991
|
*/
|
|
7968
|
-
schedule_index?:
|
|
7992
|
+
schedule_index?: uint32;
|
|
7969
7993
|
/**
|
|
7970
7994
|
* The interrupt index
|
|
7971
7995
|
*/
|
|
7972
|
-
interrupt_index?:
|
|
7996
|
+
interrupt_index?: uint32;
|
|
7973
7997
|
}
|
|
7974
7998
|
/**
|
|
7975
7999
|
* An area defined using the map editor.
|
|
@@ -7978,7 +8002,7 @@ interface ScriptArea {
|
|
|
7978
8002
|
area: BoundingBox;
|
|
7979
8003
|
name: string;
|
|
7980
8004
|
color: Color;
|
|
7981
|
-
id:
|
|
8005
|
+
id: uint32;
|
|
7982
8006
|
}
|
|
7983
8007
|
/**
|
|
7984
8008
|
* A position defined using the map editor.
|
|
@@ -7987,7 +8011,7 @@ interface ScriptPosition {
|
|
|
7987
8011
|
position: MapPosition;
|
|
7988
8012
|
name: string;
|
|
7989
8013
|
color: Color;
|
|
7990
|
-
id:
|
|
8014
|
+
id: uint32;
|
|
7991
8015
|
}
|
|
7992
8016
|
type ScriptRenderMode = 'game' | 'chart';
|
|
7993
8017
|
/**
|
|
@@ -8020,7 +8044,7 @@ interface SegmentEngineSpecification {
|
|
|
8020
8044
|
/**
|
|
8021
8045
|
* The maximum number of body nodes that a segmented unit instance can have.
|
|
8022
8046
|
*/
|
|
8023
|
-
max_body_nodes:
|
|
8047
|
+
max_body_nodes: uint32;
|
|
8024
8048
|
}
|
|
8025
8049
|
/**
|
|
8026
8050
|
* A runtime representation of {@link SegmentSpecification | prototype:SegmentSpecification}.
|
|
@@ -8148,7 +8172,7 @@ interface SegmentedUnitAIStatePatrolling extends BaseSegmentedUnitAIState {
|
|
|
8148
8172
|
/**
|
|
8149
8173
|
* Index into the unit's territory's {@link LuaTerritory::get_patrol_path | runtime:LuaTerritory::get_patrol_path} array. If the unit is not assigned to a territory, then this value is an index into a patrol path that the engine internally uses to guide the segmented unit and cannot be directly accessed. See {@link SegmentedUnitPrototype::territory_radius | prototype:SegmentedUnitPrototype::territory_radius}.
|
|
8150
8174
|
*/
|
|
8151
|
-
'waypoint':
|
|
8175
|
+
'waypoint': uint32;
|
|
8152
8176
|
}
|
|
8153
8177
|
interface SelectedPrototypeData {
|
|
8154
8178
|
/**
|
|
@@ -8309,7 +8333,7 @@ interface SelectorCombinatorParametersRandom extends BaseSelectorCombinatorParam
|
|
|
8309
8333
|
/**
|
|
8310
8334
|
* Defaults to `0`.
|
|
8311
8335
|
*/
|
|
8312
|
-
'random_update_interval'?:
|
|
8336
|
+
'random_update_interval'?: uint32;
|
|
8313
8337
|
}
|
|
8314
8338
|
/**
|
|
8315
8339
|
*
|
|
@@ -8323,7 +8347,7 @@ interface SelectorCombinatorParametersSelect extends BaseSelectorCombinatorParam
|
|
|
8323
8347
|
/**
|
|
8324
8348
|
* The signal index to use if not using a specific `index_signal`. Defaults to `0`.
|
|
8325
8349
|
*/
|
|
8326
|
-
'index_constant'?:
|
|
8350
|
+
'index_constant'?: int32;
|
|
8327
8351
|
/**
|
|
8328
8352
|
* The signal to use, if any.
|
|
8329
8353
|
*/
|
|
@@ -8344,10 +8368,12 @@ interface Signal {
|
|
|
8344
8368
|
/**
|
|
8345
8369
|
* Value of the signal.
|
|
8346
8370
|
*/
|
|
8347
|
-
count:
|
|
8371
|
+
count: int32;
|
|
8348
8372
|
}
|
|
8349
8373
|
/**
|
|
8350
8374
|
* A signal filter may be specified in two ways, either as a string which is a virtual signal name or item prototype name or as a table.
|
|
8375
|
+
*
|
|
8376
|
+
* When the LogisticFilter that this is used in has a non-zero `min` value then `comparator` must be `"="` (the default when writing) and `quality` is mandatory.
|
|
8351
8377
|
*/
|
|
8352
8378
|
type SignalFilter = {
|
|
8353
8379
|
/**
|
|
@@ -8359,11 +8385,11 @@ type SignalFilter = {
|
|
|
8359
8385
|
*/
|
|
8360
8386
|
name: string;
|
|
8361
8387
|
/**
|
|
8362
|
-
* The prototype name of the signal's quality. `nil` for any quality.
|
|
8388
|
+
* The prototype name of the signal's quality. `nil` for any quality. Mandatory if the LogisticFilter that this SignalFilter is being used in has a non-zero `min` value.
|
|
8363
8389
|
*/
|
|
8364
8390
|
quality?: QualityID;
|
|
8365
8391
|
/**
|
|
8366
|
-
* The comparator for quality. `nil`
|
|
8392
|
+
* The comparator for quality. When reading, this will be `nil` for any quality. When writing it defaults to `"="`.
|
|
8367
8393
|
*/
|
|
8368
8394
|
comparator?: ComparatorString;
|
|
8369
8395
|
} | string;
|
|
@@ -8397,7 +8423,7 @@ interface SlotFilter {
|
|
|
8397
8423
|
/**
|
|
8398
8424
|
* Position of the corresponding filter slot.
|
|
8399
8425
|
*/
|
|
8400
|
-
index:
|
|
8426
|
+
index: uint32;
|
|
8401
8427
|
/**
|
|
8402
8428
|
* Name of the prototype to filter for.
|
|
8403
8429
|
*/
|
|
@@ -8577,7 +8603,6 @@ interface SpacePlatformHubBlueprintControlBehavior {
|
|
|
8577
8603
|
read_speed?: boolean;
|
|
8578
8604
|
speed_signal?: SignalID;
|
|
8579
8605
|
}
|
|
8580
|
-
type SpacePlatformIdentification = LuaSpacePlatform;
|
|
8581
8606
|
interface SpacePlatformTileDefinition {
|
|
8582
8607
|
tile: LuaTilePrototype;
|
|
8583
8608
|
position: TilePosition;
|
|
@@ -8592,6 +8617,39 @@ interface SpawnPointDefinition {
|
|
|
8592
8617
|
*/
|
|
8593
8618
|
weight: double;
|
|
8594
8619
|
}
|
|
8620
|
+
interface SpiderEngineSpecification {
|
|
8621
|
+
legs: SpiderLegSpecification[];
|
|
8622
|
+
walking_group_overlap: float;
|
|
8623
|
+
}
|
|
8624
|
+
interface SpiderLegSpecification {
|
|
8625
|
+
/**
|
|
8626
|
+
* Name of the spider leg prototype.
|
|
8627
|
+
*/
|
|
8628
|
+
leg: string;
|
|
8629
|
+
mount_position: Vector;
|
|
8630
|
+
ground_position: Vector;
|
|
8631
|
+
leg_hit_the_ground_trigger?: TriggerEffectItem[];
|
|
8632
|
+
leg_hit_the_ground_when_attacking_trigger?: TriggerEffectItem[];
|
|
8633
|
+
walking_group: uint8;
|
|
8634
|
+
}
|
|
8635
|
+
interface SplitterBlueprintControlBehavior {
|
|
8636
|
+
/**
|
|
8637
|
+
* Defaults to `false`.
|
|
8638
|
+
*/
|
|
8639
|
+
set_input_side?: boolean;
|
|
8640
|
+
input_left_condition?: CircuitCondition;
|
|
8641
|
+
input_right_condition?: CircuitCondition;
|
|
8642
|
+
/**
|
|
8643
|
+
* Defaults to `false`.
|
|
8644
|
+
*/
|
|
8645
|
+
set_output_side?: boolean;
|
|
8646
|
+
output_left_condition?: CircuitCondition;
|
|
8647
|
+
output_right_condition?: CircuitCondition;
|
|
8648
|
+
/**
|
|
8649
|
+
* Defaults to `false`.
|
|
8650
|
+
*/
|
|
8651
|
+
set_filter?: boolean;
|
|
8652
|
+
}
|
|
8595
8653
|
type SplitterPriority = 'left' | 'none' | 'right';
|
|
8596
8654
|
type SpoilPriority = 'fresh_first' | 'none' | 'spoiled_first';
|
|
8597
8655
|
interface SpoilToTriggerResult {
|
|
@@ -8602,7 +8660,7 @@ interface SpoilToTriggerResult {
|
|
|
8602
8660
|
/**
|
|
8603
8661
|
* The trigger runs (count-in-stack / items_per_trigger) times; rounded up.
|
|
8604
8662
|
*/
|
|
8605
|
-
items_per_trigger:
|
|
8663
|
+
items_per_trigger: uint32;
|
|
8606
8664
|
}
|
|
8607
8665
|
/**
|
|
8608
8666
|
* It can be either the name of a {@link SpritePrototype | prototype:SpritePrototype} defined in the data stage, or a path in form "type/name" or "type.name".
|
|
@@ -8666,7 +8724,7 @@ interface SurfaceCondition {
|
|
|
8666
8724
|
type SurfaceIdentification = /**
|
|
8667
8725
|
* It will be the index of the surface. `nauvis` has index `1`, the first surface-created surface will have index `2` and so on.
|
|
8668
8726
|
*/
|
|
8669
|
-
|
|
8727
|
+
uint32 | /**
|
|
8670
8728
|
* It will be the surface name. E.g. `"nauvis"`.
|
|
8671
8729
|
*/
|
|
8672
8730
|
string | /**
|
|
@@ -8695,6 +8753,8 @@ interface TabAndContent {
|
|
|
8695
8753
|
* A dictionary of string to the four basic Lua types: `string`, `boolean`, `number`, `table`.
|
|
8696
8754
|
*
|
|
8697
8755
|
* Note that the API returns tags as a simple table, meaning any modifications to it will not propagate back to the game. Thus, to modify a set of tags, the whole table needs to be written back to the respective property.
|
|
8756
|
+
*
|
|
8757
|
+
* Tables inside Tags that have numeric keys but are not sequences (e.g. `tags = {foo = {nil, "something"}}` or `tags = {bar = {[4] = "cat"}}`) will have their keys converted to strings when read back from the game (e.g. `{foo = {["2"] = "something"}}` or `{bar = {["4"] = "cat"}}`). Only sequences without gaps will have their keys maintained as numeric.
|
|
8698
8758
|
* @example ```
|
|
8699
8759
|
{a = 1, b = true, c = "three", d = {e = "f"}}
|
|
8700
8760
|
```
|
|
@@ -9095,7 +9155,7 @@ interface TechnologyModifierGiveItem extends BaseTechnologyModifier {
|
|
|
9095
9155
|
/**
|
|
9096
9156
|
* The amount of the item that is given upon researching.
|
|
9097
9157
|
*/
|
|
9098
|
-
'count':
|
|
9158
|
+
'count': uint32;
|
|
9099
9159
|
/**
|
|
9100
9160
|
* The prototype name of the item that is given.
|
|
9101
9161
|
*/
|
|
@@ -9463,7 +9523,7 @@ interface TechnologyPrototypeFilterLevel extends BaseTechnologyPrototypeFilter {
|
|
|
9463
9523
|
/**
|
|
9464
9524
|
* The value to compare against.
|
|
9465
9525
|
*/
|
|
9466
|
-
'value':
|
|
9526
|
+
'value': uint32;
|
|
9467
9527
|
}
|
|
9468
9528
|
/**
|
|
9469
9529
|
*
|
|
@@ -9478,7 +9538,7 @@ interface TechnologyPrototypeFilterMaxLevel extends BaseTechnologyPrototypeFilte
|
|
|
9478
9538
|
/**
|
|
9479
9539
|
* The value to compare against.
|
|
9480
9540
|
*/
|
|
9481
|
-
'value':
|
|
9541
|
+
'value': uint32;
|
|
9482
9542
|
}
|
|
9483
9543
|
/**
|
|
9484
9544
|
*
|
|
@@ -9507,7 +9567,7 @@ interface TechnologyPrototypeFilterTime extends BaseTechnologyPrototypeFilter {
|
|
|
9507
9567
|
/**
|
|
9508
9568
|
* The value to compare against.
|
|
9509
9569
|
*/
|
|
9510
|
-
'value':
|
|
9570
|
+
'value': uint32;
|
|
9511
9571
|
}
|
|
9512
9572
|
/**
|
|
9513
9573
|
*
|
|
@@ -9527,7 +9587,7 @@ interface TerritorySettings {
|
|
|
9527
9587
|
units: string[];
|
|
9528
9588
|
territory_index_expression: string;
|
|
9529
9589
|
territory_variation_expression: string;
|
|
9530
|
-
minimum_territory_size:
|
|
9590
|
+
minimum_territory_size: uint32;
|
|
9531
9591
|
}
|
|
9532
9592
|
/**
|
|
9533
9593
|
* The text is aligned so that the target position is at the given side of the text.
|
|
@@ -9588,11 +9648,11 @@ string;
|
|
|
9588
9648
|
* Coordinates of a tile on a {@link LuaSurface | runtime:LuaSurface} where each integer `x`/`y` represents a different tile. This uses the same format as {@link MapPosition | runtime:MapPosition}, except it rounds any non-integer `x`/`y` down to whole numbers. It can be specified either with or without explicit keys.
|
|
9589
9649
|
*/
|
|
9590
9650
|
type TilePosition = {
|
|
9591
|
-
x:
|
|
9592
|
-
y:
|
|
9651
|
+
x: int32;
|
|
9652
|
+
y: int32;
|
|
9593
9653
|
} | [
|
|
9594
|
-
|
|
9595
|
-
|
|
9654
|
+
int32,
|
|
9655
|
+
int32
|
|
9596
9656
|
];
|
|
9597
9657
|
interface BaseTilePrototypeFilter {
|
|
9598
9658
|
/**
|
|
@@ -9705,7 +9765,7 @@ interface TileSearchFilters {
|
|
|
9705
9765
|
* An empty array means nothing matches the name filter.
|
|
9706
9766
|
*/
|
|
9707
9767
|
name?: TileID | TileID[];
|
|
9708
|
-
limit?:
|
|
9768
|
+
limit?: uint32;
|
|
9709
9769
|
has_hidden_tile?: boolean;
|
|
9710
9770
|
/**
|
|
9711
9771
|
* Can be further filtered by supplying a `force` filter.
|
|
@@ -9730,7 +9790,7 @@ interface TrainFilter {
|
|
|
9730
9790
|
/**
|
|
9731
9791
|
* Train ID filter
|
|
9732
9792
|
*/
|
|
9733
|
-
train_id?:
|
|
9793
|
+
train_id?: uint32;
|
|
9734
9794
|
/**
|
|
9735
9795
|
* Surface the train must be on in order to pass
|
|
9736
9796
|
*/
|
|
@@ -9746,11 +9806,11 @@ interface TrainFilter {
|
|
|
9746
9806
|
/**
|
|
9747
9807
|
* Train must have at least that many stocks to pass
|
|
9748
9808
|
*/
|
|
9749
|
-
min_stocks?:
|
|
9809
|
+
min_stocks?: uint32;
|
|
9750
9810
|
/**
|
|
9751
9811
|
* Train must have at most that many stocks to pass
|
|
9752
9812
|
*/
|
|
9753
|
-
max_stocks?:
|
|
9813
|
+
max_stocks?: uint32;
|
|
9754
9814
|
/**
|
|
9755
9815
|
* Checks if train is moving (has speed != 0) or not moving.
|
|
9756
9816
|
*/
|
|
@@ -9772,7 +9832,7 @@ interface TrainPathAllGoalsResult {
|
|
|
9772
9832
|
/**
|
|
9773
9833
|
* Amount of goals that are accessible.
|
|
9774
9834
|
*/
|
|
9775
|
-
amount_accessible:
|
|
9835
|
+
amount_accessible: uint32;
|
|
9776
9836
|
/**
|
|
9777
9837
|
* Array of the same length as requested goals: each field will tell if related goal is accessible for the train.
|
|
9778
9838
|
*/
|
|
@@ -9784,7 +9844,7 @@ interface TrainPathAllGoalsResult {
|
|
|
9784
9844
|
/**
|
|
9785
9845
|
* Amount of steps pathfinder performed. This is a measure of how expensive this search was.
|
|
9786
9846
|
*/
|
|
9787
|
-
steps_count:
|
|
9847
|
+
steps_count: uint32;
|
|
9788
9848
|
}
|
|
9789
9849
|
type TrainPathFinderGoal = TrainStopGoal | RailEndGoal | LuaRailEnd | /**
|
|
9790
9850
|
* Only if it points at train-stop that is connected to a rail.
|
|
@@ -9798,11 +9858,11 @@ interface TrainPathFinderOneGoalResult {
|
|
|
9798
9858
|
/**
|
|
9799
9859
|
* If path was found, provides index of the specific goal to which the path goes to.
|
|
9800
9860
|
*/
|
|
9801
|
-
goal_index?:
|
|
9861
|
+
goal_index?: uint32;
|
|
9802
9862
|
/**
|
|
9803
9863
|
* If path was found, provides index of the specific start from which the path to target goes from
|
|
9804
9864
|
*/
|
|
9805
|
-
start_index?:
|
|
9865
|
+
start_index?: uint32;
|
|
9806
9866
|
/**
|
|
9807
9867
|
* Penalty of the path to goal if path was found.
|
|
9808
9868
|
*/
|
|
@@ -9822,7 +9882,7 @@ interface TrainPathFinderOneGoalResult {
|
|
|
9822
9882
|
/**
|
|
9823
9883
|
* Amount of steps pathfinder performed. This is a measure of how expensive this search was.
|
|
9824
9884
|
*/
|
|
9825
|
-
steps_count:
|
|
9885
|
+
steps_count: uint32;
|
|
9826
9886
|
}
|
|
9827
9887
|
/**
|
|
9828
9888
|
* A {@link string | runtime:string} specifying the type of request for {@link LuaTrainManager::request_train_path | runtime:LuaTrainManager::request_train_path}.
|
|
@@ -9844,7 +9904,7 @@ interface TrainSchedule {
|
|
|
9844
9904
|
/**
|
|
9845
9905
|
* Index of the currently active record
|
|
9846
9906
|
*/
|
|
9847
|
-
current:
|
|
9907
|
+
current: uint32;
|
|
9848
9908
|
records: ScheduleRecord[];
|
|
9849
9909
|
}
|
|
9850
9910
|
interface TrainStopBlueprintControlBehavior {
|
|
@@ -9999,7 +10059,7 @@ interface TriggerItem {
|
|
|
9999
10059
|
* If `"enemy"`, the trigger will only affect entities whose force is different from the attacker's and for which there is no cease-fire set. `"ally"` is the opposite of `"enemy"`.
|
|
10000
10060
|
*/
|
|
10001
10061
|
force: ForceCondition;
|
|
10002
|
-
repeat_count:
|
|
10062
|
+
repeat_count: uint32;
|
|
10003
10063
|
probability: float;
|
|
10004
10064
|
}
|
|
10005
10065
|
interface TriggerModifierData {
|
|
@@ -10066,6 +10126,10 @@ interface UndoRedoActionBuiltEntity extends BaseUndoRedoAction {
|
|
|
10066
10126
|
* The type of action that was undone or redone.
|
|
10067
10127
|
*/
|
|
10068
10128
|
'type': 'built-entity';
|
|
10129
|
+
/**
|
|
10130
|
+
* The surface of the built entity.
|
|
10131
|
+
*/
|
|
10132
|
+
'surface_index'?: uint32;
|
|
10069
10133
|
/**
|
|
10070
10134
|
* The specification of the built entity.
|
|
10071
10135
|
*/
|
|
@@ -10095,7 +10159,7 @@ interface UndoRedoActionBuiltTile extends BaseUndoRedoAction {
|
|
|
10095
10159
|
/**
|
|
10096
10160
|
* The surface on which the tile was built.
|
|
10097
10161
|
*/
|
|
10098
|
-
'surface_index':
|
|
10162
|
+
'surface_index': uint32;
|
|
10099
10163
|
}
|
|
10100
10164
|
/**
|
|
10101
10165
|
*
|
|
@@ -10107,6 +10171,13 @@ interface UndoRedoActionCopyEntitySettings extends BaseUndoRedoAction {
|
|
|
10107
10171
|
*/
|
|
10108
10172
|
'type': 'copy-entity-settings';
|
|
10109
10173
|
'entity_with_previous_settings'?: BlueprintEntity;
|
|
10174
|
+
/**
|
|
10175
|
+
* The surface of the entity the settings were pasted onto.
|
|
10176
|
+
*/
|
|
10177
|
+
'surface_index'?: uint32;
|
|
10178
|
+
/**
|
|
10179
|
+
* The specification of the entity the settings were pasted onto.
|
|
10180
|
+
*/
|
|
10110
10181
|
'target'?: BlueprintEntity;
|
|
10111
10182
|
}
|
|
10112
10183
|
/**
|
|
@@ -10129,7 +10200,7 @@ interface UndoRedoActionRemovedEntity extends BaseUndoRedoAction {
|
|
|
10129
10200
|
/**
|
|
10130
10201
|
* The surface from which the entity was removed. Not present for entities the game can't restore, like trees or rocks.
|
|
10131
10202
|
*/
|
|
10132
|
-
'surface_index'?:
|
|
10203
|
+
'surface_index'?: uint32;
|
|
10133
10204
|
/**
|
|
10134
10205
|
* The specification of the removed entity.
|
|
10135
10206
|
*/
|
|
@@ -10155,7 +10226,7 @@ interface UndoRedoActionRemovedTile extends BaseUndoRedoAction {
|
|
|
10155
10226
|
/**
|
|
10156
10227
|
* The surface from which the tile was removed.
|
|
10157
10228
|
*/
|
|
10158
|
-
'surface_index':
|
|
10229
|
+
'surface_index': uint32;
|
|
10159
10230
|
}
|
|
10160
10231
|
/**
|
|
10161
10232
|
*
|
|
@@ -10171,6 +10242,10 @@ interface UndoRedoActionRotatedEntity extends BaseUndoRedoAction {
|
|
|
10171
10242
|
*/
|
|
10172
10243
|
'original_direction': defines.direction;
|
|
10173
10244
|
'original_mirroring': boolean;
|
|
10245
|
+
/**
|
|
10246
|
+
* The surface of the rotated entity.
|
|
10247
|
+
*/
|
|
10248
|
+
'surface_index'?: uint32;
|
|
10174
10249
|
/**
|
|
10175
10250
|
* The specification of the rotated entity.
|
|
10176
10251
|
*/
|
|
@@ -10193,6 +10268,10 @@ interface UndoRedoActionUpgradedEntity extends BaseUndoRedoAction {
|
|
|
10193
10268
|
* The quality prototype name of the entity before upgrading.
|
|
10194
10269
|
*/
|
|
10195
10270
|
'original_quality_name': string;
|
|
10271
|
+
/**
|
|
10272
|
+
* The surface of the upgraded entity.
|
|
10273
|
+
*/
|
|
10274
|
+
'surface_index'?: uint32;
|
|
10196
10275
|
/**
|
|
10197
10276
|
* The specification of the upgraded entity.
|
|
10198
10277
|
*/
|
|
@@ -10211,6 +10290,10 @@ interface UndoRedoActionUpgradedModules extends BaseUndoRedoAction {
|
|
|
10211
10290
|
* The modules present in the target before the upgrade.
|
|
10212
10291
|
*/
|
|
10213
10292
|
'modules_before': BlueprintInsertPlan;
|
|
10293
|
+
/**
|
|
10294
|
+
* The surface of the upgraded entity.
|
|
10295
|
+
*/
|
|
10296
|
+
'surface_index'?: uint32;
|
|
10214
10297
|
/**
|
|
10215
10298
|
* The specification of the upgraded entity.
|
|
10216
10299
|
*/
|
|
@@ -10244,15 +10327,15 @@ interface UnitGroupMapSettings {
|
|
|
10244
10327
|
/**
|
|
10245
10328
|
* The minimum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `3 600` ticks.
|
|
10246
10329
|
*/
|
|
10247
|
-
min_group_gathering_time:
|
|
10330
|
+
min_group_gathering_time: uint32;
|
|
10248
10331
|
/**
|
|
10249
10332
|
* The maximum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `10*3 600=36 000` ticks.
|
|
10250
10333
|
*/
|
|
10251
|
-
max_group_gathering_time:
|
|
10334
|
+
max_group_gathering_time: uint32;
|
|
10252
10335
|
/**
|
|
10253
10336
|
* After gathering has finished, the group is allowed to wait this long in ticks for delayed members. New members are not accepted anymore however. Defaults to `2*3 600=7 200` ticks.
|
|
10254
10337
|
*/
|
|
10255
|
-
max_wait_time_for_late_members:
|
|
10338
|
+
max_wait_time_for_late_members: uint32;
|
|
10256
10339
|
/**
|
|
10257
10340
|
* The minimum group radius in tiles. The actual radius is adjusted based on the number of members. Defaults to `5.0`.
|
|
10258
10341
|
*/
|
|
@@ -10281,15 +10364,15 @@ interface UnitGroupMapSettings {
|
|
|
10281
10364
|
* When a member of a group falls back more than this factor times the group radius, it will be dropped from the group. Defaults to `10`.
|
|
10282
10365
|
*/
|
|
10283
10366
|
member_disown_distance: double;
|
|
10284
|
-
tick_tolerance_when_member_arrives:
|
|
10367
|
+
tick_tolerance_when_member_arrives: uint32;
|
|
10285
10368
|
/**
|
|
10286
10369
|
* The maximum number of automatically created unit groups gathering for attack at any time. Defaults to `30`.
|
|
10287
10370
|
*/
|
|
10288
|
-
max_gathering_unit_groups:
|
|
10371
|
+
max_gathering_unit_groups: uint32;
|
|
10289
10372
|
/**
|
|
10290
10373
|
* The maximum number of members for an attack unit group. This only affects automatically created unit groups, manual groups created through the API are unaffected. Defaults to `200`.
|
|
10291
10374
|
*/
|
|
10292
|
-
max_unit_group_size:
|
|
10375
|
+
max_unit_group_size: uint32;
|
|
10293
10376
|
}
|
|
10294
10377
|
interface UnitSpawnDefinition {
|
|
10295
10378
|
/**
|
|
@@ -10318,7 +10401,7 @@ interface UpgradeMapperDestination {
|
|
|
10318
10401
|
/**
|
|
10319
10402
|
* When upgrading entities, this defines explicit modules to be installed in the destination entity. Lists empty slots as `{}`.
|
|
10320
10403
|
*/
|
|
10321
|
-
module_slots?:
|
|
10404
|
+
module_slots?: BlueprintItemIDAndQualityIDPair[];
|
|
10322
10405
|
}
|
|
10323
10406
|
interface UpgradeMapperSource {
|
|
10324
10407
|
type: 'item' | 'entity';
|
|
@@ -10408,11 +10491,11 @@ interface WaitCondition {
|
|
|
10408
10491
|
/**
|
|
10409
10492
|
* Number of ticks to wait when `type` is `"time"`, or number of ticks of inactivity when `type` is `"inactivity"`.
|
|
10410
10493
|
*/
|
|
10411
|
-
ticks?:
|
|
10494
|
+
ticks?: uint32;
|
|
10412
10495
|
/**
|
|
10413
|
-
* This is a CircuitCondition and only present when `type` is `"item_count"`, `"circuit"`, `"fluid_count"`, `"fuel_item_count_all"`, or `"fuel_item_count_any"`, and a circuit condition is configured. This is a
|
|
10496
|
+
* This is a CircuitCondition and only present when `type` is `"item_count"`, `"circuit"`, `"fluid_count"`, `"fuel_item_count_all"`, or `"fuel_item_count_any"`, and a circuit condition is configured. This is a BlueprintItemIDAndQualityIDPair and only present when `type` is `"request_satisfied"` or `"request_not_satisfied"`
|
|
10414
10497
|
*/
|
|
10415
|
-
condition?: CircuitCondition |
|
|
10498
|
+
condition?: CircuitCondition | BlueprintItemIDAndQualityIDPair;
|
|
10416
10499
|
/**
|
|
10417
10500
|
* Name of the space location. Only present when `type` is "`any_planet_import_zero`" and a planet is configured.
|
|
10418
10501
|
*/
|
|
@@ -10424,7 +10507,7 @@ interface WaitCondition {
|
|
|
10424
10507
|
/**
|
|
10425
10508
|
* Amount of damage to take when `type` is `"damage_taken"`.
|
|
10426
10509
|
*/
|
|
10427
|
-
damage?:
|
|
10510
|
+
damage?: uint32;
|
|
10428
10511
|
}
|
|
10429
10512
|
/**
|
|
10430
10513
|
* Type of a {@link WaitCondition | runtime:WaitCondition}.
|
|
@@ -10539,18 +10622,18 @@ type double = number;
|
|
|
10539
10622
|
* A floating-point number. This is a single-precision floating point number. Whilst Lua only uses double-precision numbers, when a function takes a float, the game engine will immediately convert the double-precision number to single-precision.
|
|
10540
10623
|
*/
|
|
10541
10624
|
type float = number;
|
|
10542
|
-
/**
|
|
10543
|
-
* 32-bit signed integer. Possible values are `-2 147 483 648` to `2 147 483 647`.
|
|
10544
|
-
*
|
|
10545
|
-
* Since Lua 5.2 only uses doubles, any API that asks for `int` will floor the given double.
|
|
10546
|
-
*/
|
|
10547
|
-
type int = number;
|
|
10548
10625
|
/**
|
|
10549
10626
|
* 16 bit signed integer. Possible values are `-32 768` to `32 767`.
|
|
10550
10627
|
*
|
|
10551
10628
|
* Since Lua 5.2 only uses doubles, any API that asks for `int16` will floor the given double.
|
|
10552
10629
|
*/
|
|
10553
10630
|
type int16 = number;
|
|
10631
|
+
/**
|
|
10632
|
+
* 32-bit signed integer. Possible values are `-2 147 483 648` to `2 147 483 647`.
|
|
10633
|
+
*
|
|
10634
|
+
* Since Lua 5.2 only uses doubles, any API that asks for `int` will floor the given double.
|
|
10635
|
+
*/
|
|
10636
|
+
type int32 = number;
|
|
10554
10637
|
/**
|
|
10555
10638
|
* 8-bit signed integer. Possible values are `-128` to `127`.
|
|
10556
10639
|
*
|
|
@@ -10567,18 +10650,18 @@ type nil = null;
|
|
|
10567
10650
|
* Throughout the API docs, the terms "array" and "dictionary" are used. These are fundamentally just {@link Lua tables | http://www.lua.org/pil/2.5.html}, but have a limitation on which kind of table keys can be used. 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.
|
|
10568
10651
|
*/
|
|
10569
10652
|
type table = Table;
|
|
10570
|
-
/**
|
|
10571
|
-
* 32-bit unsigned integer. Possible values are `0` to `4 294 967 295`.
|
|
10572
|
-
*
|
|
10573
|
-
* Since Lua 5.2 only uses doubles, any API that asks for `uint` will floor the given double.
|
|
10574
|
-
*/
|
|
10575
|
-
type uint = number;
|
|
10576
10653
|
/**
|
|
10577
10654
|
* 16-bit unsigned integer. Possible values are `0` to `65 535`.
|
|
10578
10655
|
*
|
|
10579
10656
|
* Since Lua 5.2 only uses doubles, any API that asks for `uint16` will floor the given double.
|
|
10580
10657
|
*/
|
|
10581
10658
|
type uint16 = number;
|
|
10659
|
+
/**
|
|
10660
|
+
* 32-bit unsigned integer. Possible values are `0` to `4 294 967 295`.
|
|
10661
|
+
*
|
|
10662
|
+
* Since Lua 5.2 only uses doubles, any API that asks for `uint` will floor the given double.
|
|
10663
|
+
*/
|
|
10664
|
+
type uint32 = number;
|
|
10582
10665
|
/**
|
|
10583
10666
|
* 64-bit unsigned integer. Possible values are `0` to `18 446 744 073 709 551 615`.
|
|
10584
10667
|
*
|