factorio-types 1.2.56 → 1.2.58
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 +88 -47
- package/dist/concepts.d.ts +497 -31
- package/dist/datacollection.d.ts +1 -1
- package/dist/defines.d.ts +5 -5
- package/dist/events.d.ts +443 -443
- package/dist/global.d.ts +1 -1
- package/dist/prototypes.d.ts +263 -17
- package/dist/types.d.ts +78 -29
- package/package.json +2 -2
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.0.
|
|
5
|
+
// Factorio version 2.0.77
|
|
6
6
|
// API version 6
|
|
7
7
|
|
|
8
8
|
declare namespace runtime {
|
|
@@ -41,7 +41,7 @@ interface CustomInputEvent {
|
|
|
41
41
|
*/
|
|
42
42
|
input_name: string;
|
|
43
43
|
/**
|
|
44
|
-
* Identifier of the event
|
|
44
|
+
* Identifier of the event.
|
|
45
45
|
*/
|
|
46
46
|
name: defines.events;
|
|
47
47
|
/**
|
|
@@ -55,7 +55,7 @@ interface CustomInputEvent {
|
|
|
55
55
|
/**
|
|
56
56
|
* Tick the event was generated.
|
|
57
57
|
*/
|
|
58
|
-
tick:
|
|
58
|
+
tick: MapTick;
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
* Called when an achievement is gained.
|
|
@@ -63,7 +63,7 @@ interface CustomInputEvent {
|
|
|
63
63
|
interface on_achievement_gained {
|
|
64
64
|
achievement: LuaAchievementPrototype;
|
|
65
65
|
/**
|
|
66
|
-
* Identifier of the event
|
|
66
|
+
* Identifier of the event.
|
|
67
67
|
*/
|
|
68
68
|
name: defines.events;
|
|
69
69
|
/**
|
|
@@ -73,21 +73,21 @@ interface on_achievement_gained {
|
|
|
73
73
|
/**
|
|
74
74
|
* Tick the event was generated.
|
|
75
75
|
*/
|
|
76
|
-
tick:
|
|
76
|
+
tick: MapTick;
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
79
|
* Called when a unit/group completes a command.
|
|
80
80
|
*/
|
|
81
81
|
interface on_ai_command_completed {
|
|
82
82
|
/**
|
|
83
|
-
* Identifier of the event
|
|
83
|
+
* Identifier of the event.
|
|
84
84
|
*/
|
|
85
85
|
name: defines.events;
|
|
86
86
|
result: defines.behavior_result;
|
|
87
87
|
/**
|
|
88
88
|
* Tick the event was generated.
|
|
89
89
|
*/
|
|
90
|
-
tick:
|
|
90
|
+
tick: MapTick;
|
|
91
91
|
/**
|
|
92
92
|
* unit_number/group_number of the unit/group which just completed a command.
|
|
93
93
|
*/
|
|
@@ -110,7 +110,7 @@ interface on_area_cloned {
|
|
|
110
110
|
destination_force?: LuaForce;
|
|
111
111
|
destination_surface: LuaSurface;
|
|
112
112
|
/**
|
|
113
|
-
* Identifier of the event
|
|
113
|
+
* Identifier of the event.
|
|
114
114
|
*/
|
|
115
115
|
name: defines.events;
|
|
116
116
|
source_area: BoundingBox;
|
|
@@ -118,7 +118,7 @@ interface on_area_cloned {
|
|
|
118
118
|
/**
|
|
119
119
|
* Tick the event was generated.
|
|
120
120
|
*/
|
|
121
|
-
tick:
|
|
121
|
+
tick: MapTick;
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
124
|
* Called when a biter migration builds a base.
|
|
@@ -131,13 +131,13 @@ interface on_biter_base_built {
|
|
|
131
131
|
*/
|
|
132
132
|
entity: LuaEntity;
|
|
133
133
|
/**
|
|
134
|
-
* Identifier of the event
|
|
134
|
+
* Identifier of the event.
|
|
135
135
|
*/
|
|
136
136
|
name: defines.events;
|
|
137
137
|
/**
|
|
138
138
|
* Tick the event was generated.
|
|
139
139
|
*/
|
|
140
|
-
tick:
|
|
140
|
+
tick: MapTick;
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
143
|
* Called when a set of positions on the map is cloned.
|
|
@@ -152,7 +152,7 @@ interface on_brush_cloned {
|
|
|
152
152
|
destination_offset: TilePosition;
|
|
153
153
|
destination_surface: LuaSurface;
|
|
154
154
|
/**
|
|
155
|
-
* Identifier of the event
|
|
155
|
+
* Identifier of the event.
|
|
156
156
|
*/
|
|
157
157
|
name: defines.events;
|
|
158
158
|
source_offset: TilePosition;
|
|
@@ -161,7 +161,7 @@ interface on_brush_cloned {
|
|
|
161
161
|
/**
|
|
162
162
|
* Tick the event was generated.
|
|
163
163
|
*/
|
|
164
|
-
tick:
|
|
164
|
+
tick: MapTick;
|
|
165
165
|
}
|
|
166
166
|
/**
|
|
167
167
|
* Called when a {@link defines.command.build_base | runtime:defines.command.build_base} command reaches its destination, and before building starts.
|
|
@@ -172,13 +172,13 @@ interface on_build_base_arrived {
|
|
|
172
172
|
*/
|
|
173
173
|
group?: LuaCommandable;
|
|
174
174
|
/**
|
|
175
|
-
* Identifier of the event
|
|
175
|
+
* Identifier of the event.
|
|
176
176
|
*/
|
|
177
177
|
name: defines.events;
|
|
178
178
|
/**
|
|
179
179
|
* Tick the event was generated.
|
|
180
180
|
*/
|
|
181
|
-
tick:
|
|
181
|
+
tick: MapTick;
|
|
182
182
|
/**
|
|
183
183
|
* The unit the command was assigned to.
|
|
184
184
|
*/
|
|
@@ -197,7 +197,7 @@ interface on_built_entity {
|
|
|
197
197
|
*/
|
|
198
198
|
entity: LuaEntity;
|
|
199
199
|
/**
|
|
200
|
-
* Identifier of the event
|
|
200
|
+
* Identifier of the event.
|
|
201
201
|
*/
|
|
202
202
|
name: defines.events;
|
|
203
203
|
/**
|
|
@@ -211,7 +211,7 @@ interface on_built_entity {
|
|
|
211
211
|
/**
|
|
212
212
|
* Tick the event was generated.
|
|
213
213
|
*/
|
|
214
|
-
tick:
|
|
214
|
+
tick: MapTick;
|
|
215
215
|
}
|
|
216
216
|
/**
|
|
217
217
|
* Called when the deconstruction of an entity is canceled.
|
|
@@ -219,14 +219,14 @@ interface on_built_entity {
|
|
|
219
219
|
interface on_cancelled_deconstruction {
|
|
220
220
|
entity: LuaEntity;
|
|
221
221
|
/**
|
|
222
|
-
* Identifier of the event
|
|
222
|
+
* Identifier of the event.
|
|
223
223
|
*/
|
|
224
224
|
name: defines.events;
|
|
225
225
|
player_index?: uint32;
|
|
226
226
|
/**
|
|
227
227
|
* Tick the event was generated.
|
|
228
228
|
*/
|
|
229
|
-
tick:
|
|
229
|
+
tick: MapTick;
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
232
|
* Called when the upgrade of an entity is canceled.
|
|
@@ -234,7 +234,7 @@ interface on_cancelled_deconstruction {
|
|
|
234
234
|
interface on_cancelled_upgrade {
|
|
235
235
|
entity: LuaEntity;
|
|
236
236
|
/**
|
|
237
|
-
* Identifier of the event
|
|
237
|
+
* Identifier of the event.
|
|
238
238
|
*/
|
|
239
239
|
name: defines.events;
|
|
240
240
|
player_index?: uint32;
|
|
@@ -243,7 +243,7 @@ interface on_cancelled_upgrade {
|
|
|
243
243
|
/**
|
|
244
244
|
* Tick the event was generated.
|
|
245
245
|
*/
|
|
246
|
-
tick:
|
|
246
|
+
tick: MapTick;
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
249
|
* Called after a cargo pod has delivered its cargo.
|
|
@@ -251,7 +251,7 @@ interface on_cancelled_upgrade {
|
|
|
251
251
|
interface on_cargo_pod_delivered_cargo {
|
|
252
252
|
cargo_pod: LuaEntity;
|
|
253
253
|
/**
|
|
254
|
-
* Identifier of the event
|
|
254
|
+
* Identifier of the event.
|
|
255
255
|
*/
|
|
256
256
|
name: defines.events;
|
|
257
257
|
/**
|
|
@@ -261,7 +261,7 @@ interface on_cargo_pod_delivered_cargo {
|
|
|
261
261
|
/**
|
|
262
262
|
* Tick the event was generated.
|
|
263
263
|
*/
|
|
264
|
-
tick:
|
|
264
|
+
tick: MapTick;
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
267
|
* Called when a cargo pod departs a surface.
|
|
@@ -273,7 +273,7 @@ interface on_cargo_pod_finished_ascending {
|
|
|
273
273
|
*/
|
|
274
274
|
launched_by_rocket: boolean;
|
|
275
275
|
/**
|
|
276
|
-
* Identifier of the event
|
|
276
|
+
* Identifier of the event.
|
|
277
277
|
*/
|
|
278
278
|
name: defines.events;
|
|
279
279
|
/**
|
|
@@ -283,7 +283,7 @@ interface on_cargo_pod_finished_ascending {
|
|
|
283
283
|
/**
|
|
284
284
|
* Tick the event was generated.
|
|
285
285
|
*/
|
|
286
|
-
tick:
|
|
286
|
+
tick: MapTick;
|
|
287
287
|
}
|
|
288
288
|
/**
|
|
289
289
|
* Called when a cargo pods lands on a surface, either at a station or on the ground.
|
|
@@ -295,7 +295,7 @@ interface on_cargo_pod_finished_descending {
|
|
|
295
295
|
*/
|
|
296
296
|
launched_by_rocket: boolean;
|
|
297
297
|
/**
|
|
298
|
-
* Identifier of the event
|
|
298
|
+
* Identifier of the event.
|
|
299
299
|
*/
|
|
300
300
|
name: defines.events;
|
|
301
301
|
/**
|
|
@@ -305,7 +305,7 @@ interface on_cargo_pod_finished_descending {
|
|
|
305
305
|
/**
|
|
306
306
|
* Tick the event was generated.
|
|
307
307
|
*/
|
|
308
|
-
tick:
|
|
308
|
+
tick: MapTick;
|
|
309
309
|
}
|
|
310
310
|
/**
|
|
311
311
|
* Called when a cargo pod departs from a space platform hub or by another method not attached to a rocket.
|
|
@@ -313,7 +313,7 @@ interface on_cargo_pod_finished_descending {
|
|
|
313
313
|
interface on_cargo_pod_started_ascending {
|
|
314
314
|
cargo_pod: LuaEntity;
|
|
315
315
|
/**
|
|
316
|
-
* Identifier of the event
|
|
316
|
+
* Identifier of the event.
|
|
317
317
|
*/
|
|
318
318
|
name: defines.events;
|
|
319
319
|
/**
|
|
@@ -323,7 +323,7 @@ interface on_cargo_pod_started_ascending {
|
|
|
323
323
|
/**
|
|
324
324
|
* Tick the event was generated.
|
|
325
325
|
*/
|
|
326
|
-
tick:
|
|
326
|
+
tick: MapTick;
|
|
327
327
|
}
|
|
328
328
|
/**
|
|
329
329
|
* Called when a character corpse expires due to timeout or all of the items being removed from it.
|
|
@@ -336,13 +336,13 @@ interface on_character_corpse_expired {
|
|
|
336
336
|
*/
|
|
337
337
|
corpse: LuaEntity;
|
|
338
338
|
/**
|
|
339
|
-
* Identifier of the event
|
|
339
|
+
* Identifier of the event.
|
|
340
340
|
*/
|
|
341
341
|
name: defines.events;
|
|
342
342
|
/**
|
|
343
343
|
* Tick the event was generated.
|
|
344
344
|
*/
|
|
345
|
-
tick:
|
|
345
|
+
tick: MapTick;
|
|
346
346
|
}
|
|
347
347
|
/**
|
|
348
348
|
* Called when a chart tag is created.
|
|
@@ -350,7 +350,7 @@ interface on_character_corpse_expired {
|
|
|
350
350
|
interface on_chart_tag_added {
|
|
351
351
|
force: LuaForce;
|
|
352
352
|
/**
|
|
353
|
-
* Identifier of the event
|
|
353
|
+
* Identifier of the event.
|
|
354
354
|
*/
|
|
355
355
|
name: defines.events;
|
|
356
356
|
player_index?: uint32;
|
|
@@ -358,7 +358,7 @@ interface on_chart_tag_added {
|
|
|
358
358
|
/**
|
|
359
359
|
* Tick the event was generated.
|
|
360
360
|
*/
|
|
361
|
-
tick:
|
|
361
|
+
tick: MapTick;
|
|
362
362
|
}
|
|
363
363
|
/**
|
|
364
364
|
* Called when a chart tag is modified by a player or by script.
|
|
@@ -366,7 +366,7 @@ interface on_chart_tag_added {
|
|
|
366
366
|
interface on_chart_tag_modified {
|
|
367
367
|
force: LuaForce;
|
|
368
368
|
/**
|
|
369
|
-
* Identifier of the event
|
|
369
|
+
* Identifier of the event.
|
|
370
370
|
*/
|
|
371
371
|
name: defines.events;
|
|
372
372
|
old_icon: SignalID;
|
|
@@ -379,7 +379,7 @@ interface on_chart_tag_modified {
|
|
|
379
379
|
/**
|
|
380
380
|
* Tick the event was generated.
|
|
381
381
|
*/
|
|
382
|
-
tick:
|
|
382
|
+
tick: MapTick;
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
385
|
* Called just before a chart tag is deleted.
|
|
@@ -387,7 +387,7 @@ interface on_chart_tag_modified {
|
|
|
387
387
|
interface on_chart_tag_removed {
|
|
388
388
|
force: LuaForce;
|
|
389
389
|
/**
|
|
390
|
-
* Identifier of the event
|
|
390
|
+
* Identifier of the event.
|
|
391
391
|
*/
|
|
392
392
|
name: defines.events;
|
|
393
393
|
player_index?: uint32;
|
|
@@ -395,7 +395,7 @@ interface on_chart_tag_removed {
|
|
|
395
395
|
/**
|
|
396
396
|
* Tick the event was generated.
|
|
397
397
|
*/
|
|
398
|
-
tick:
|
|
398
|
+
tick: MapTick;
|
|
399
399
|
}
|
|
400
400
|
/**
|
|
401
401
|
* Called when a chunk is charted or re-charted.
|
|
@@ -407,7 +407,7 @@ interface on_chunk_charted {
|
|
|
407
407
|
area: BoundingBox;
|
|
408
408
|
force: LuaForce;
|
|
409
409
|
/**
|
|
410
|
-
* Identifier of the event
|
|
410
|
+
* Identifier of the event.
|
|
411
411
|
*/
|
|
412
412
|
name: defines.events;
|
|
413
413
|
position: ChunkPosition;
|
|
@@ -415,14 +415,14 @@ interface on_chunk_charted {
|
|
|
415
415
|
/**
|
|
416
416
|
* Tick the event was generated.
|
|
417
417
|
*/
|
|
418
|
-
tick:
|
|
418
|
+
tick: MapTick;
|
|
419
419
|
}
|
|
420
420
|
/**
|
|
421
421
|
* Called when one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
|
|
422
422
|
*/
|
|
423
423
|
interface on_chunk_deleted {
|
|
424
424
|
/**
|
|
425
|
-
* Identifier of the event
|
|
425
|
+
* Identifier of the event.
|
|
426
426
|
*/
|
|
427
427
|
name: defines.events;
|
|
428
428
|
/**
|
|
@@ -433,7 +433,7 @@ interface on_chunk_deleted {
|
|
|
433
433
|
/**
|
|
434
434
|
* Tick the event was generated.
|
|
435
435
|
*/
|
|
436
|
-
tick:
|
|
436
|
+
tick: MapTick;
|
|
437
437
|
}
|
|
438
438
|
/**
|
|
439
439
|
* Called when a chunk is generated.
|
|
@@ -444,7 +444,7 @@ interface on_chunk_generated {
|
|
|
444
444
|
*/
|
|
445
445
|
area: BoundingBox;
|
|
446
446
|
/**
|
|
447
|
-
* Identifier of the event
|
|
447
|
+
* Identifier of the event.
|
|
448
448
|
*/
|
|
449
449
|
name: defines.events;
|
|
450
450
|
/**
|
|
@@ -458,14 +458,14 @@ interface on_chunk_generated {
|
|
|
458
458
|
/**
|
|
459
459
|
* Tick the event was generated.
|
|
460
460
|
*/
|
|
461
|
-
tick:
|
|
461
|
+
tick: MapTick;
|
|
462
462
|
}
|
|
463
463
|
/**
|
|
464
464
|
* Called when a combat robot expires through a lack of energy, or timeout.
|
|
465
465
|
*/
|
|
466
466
|
interface on_combat_robot_expired {
|
|
467
467
|
/**
|
|
468
|
-
* Identifier of the event
|
|
468
|
+
* Identifier of the event.
|
|
469
469
|
*/
|
|
470
470
|
name: defines.events;
|
|
471
471
|
/**
|
|
@@ -476,7 +476,7 @@ interface on_combat_robot_expired {
|
|
|
476
476
|
/**
|
|
477
477
|
* Tick the event was generated.
|
|
478
478
|
*/
|
|
479
|
-
tick:
|
|
479
|
+
tick: MapTick;
|
|
480
480
|
}
|
|
481
481
|
/**
|
|
482
482
|
* Called when a message is sent to the in-game console, either by a player or through the server interface.
|
|
@@ -489,7 +489,7 @@ interface on_console_chat {
|
|
|
489
489
|
*/
|
|
490
490
|
message: string;
|
|
491
491
|
/**
|
|
492
|
-
* Identifier of the event
|
|
492
|
+
* Identifier of the event.
|
|
493
493
|
*/
|
|
494
494
|
name: defines.events;
|
|
495
495
|
/**
|
|
@@ -499,7 +499,7 @@ interface on_console_chat {
|
|
|
499
499
|
/**
|
|
500
500
|
* Tick the event was generated.
|
|
501
501
|
*/
|
|
502
|
-
tick:
|
|
502
|
+
tick: MapTick;
|
|
503
503
|
}
|
|
504
504
|
/**
|
|
505
505
|
* Called when someone enters a command-like message regardless of it being a valid command.
|
|
@@ -510,7 +510,7 @@ interface on_console_command {
|
|
|
510
510
|
*/
|
|
511
511
|
command: string;
|
|
512
512
|
/**
|
|
513
|
-
* Identifier of the event
|
|
513
|
+
* Identifier of the event.
|
|
514
514
|
*/
|
|
515
515
|
name: defines.events;
|
|
516
516
|
/**
|
|
@@ -524,14 +524,14 @@ interface on_console_command {
|
|
|
524
524
|
/**
|
|
525
525
|
* Tick the event was generated.
|
|
526
526
|
*/
|
|
527
|
-
tick:
|
|
527
|
+
tick: MapTick;
|
|
528
528
|
}
|
|
529
529
|
/**
|
|
530
530
|
* Called when a cutscene is cancelled by the player or by script.
|
|
531
531
|
*/
|
|
532
532
|
interface on_cutscene_cancelled {
|
|
533
533
|
/**
|
|
534
|
-
* Identifier of the event
|
|
534
|
+
* Identifier of the event.
|
|
535
535
|
*/
|
|
536
536
|
name: defines.events;
|
|
537
537
|
/**
|
|
@@ -541,14 +541,14 @@ interface on_cutscene_cancelled {
|
|
|
541
541
|
/**
|
|
542
542
|
* Tick the event was generated.
|
|
543
543
|
*/
|
|
544
|
-
tick:
|
|
544
|
+
tick: MapTick;
|
|
545
545
|
}
|
|
546
546
|
/**
|
|
547
547
|
* Called when a cutscene finishes naturally (was not cancelled).
|
|
548
548
|
*/
|
|
549
549
|
interface on_cutscene_finished {
|
|
550
550
|
/**
|
|
551
|
-
* Identifier of the event
|
|
551
|
+
* Identifier of the event.
|
|
552
552
|
*/
|
|
553
553
|
name: defines.events;
|
|
554
554
|
/**
|
|
@@ -558,14 +558,14 @@ interface on_cutscene_finished {
|
|
|
558
558
|
/**
|
|
559
559
|
* Tick the event was generated.
|
|
560
560
|
*/
|
|
561
|
-
tick:
|
|
561
|
+
tick: MapTick;
|
|
562
562
|
}
|
|
563
563
|
/**
|
|
564
564
|
* Called when a cutscene starts.
|
|
565
565
|
*/
|
|
566
566
|
interface on_cutscene_started {
|
|
567
567
|
/**
|
|
568
|
-
* Identifier of the event
|
|
568
|
+
* Identifier of the event.
|
|
569
569
|
*/
|
|
570
570
|
name: defines.events;
|
|
571
571
|
/**
|
|
@@ -575,7 +575,7 @@ interface on_cutscene_started {
|
|
|
575
575
|
/**
|
|
576
576
|
* Tick the event was generated.
|
|
577
577
|
*/
|
|
578
|
-
tick:
|
|
578
|
+
tick: MapTick;
|
|
579
579
|
}
|
|
580
580
|
/**
|
|
581
581
|
* Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.
|
|
@@ -584,7 +584,7 @@ interface on_cutscene_started {
|
|
|
584
584
|
*/
|
|
585
585
|
interface on_cutscene_waypoint_reached {
|
|
586
586
|
/**
|
|
587
|
-
* Identifier of the event
|
|
587
|
+
* Identifier of the event.
|
|
588
588
|
*/
|
|
589
589
|
name: defines.events;
|
|
590
590
|
/**
|
|
@@ -594,7 +594,7 @@ interface on_cutscene_waypoint_reached {
|
|
|
594
594
|
/**
|
|
595
595
|
* Tick the event was generated.
|
|
596
596
|
*/
|
|
597
|
-
tick:
|
|
597
|
+
tick: MapTick;
|
|
598
598
|
/**
|
|
599
599
|
* The index of the waypoint we just completed.
|
|
600
600
|
*/
|
|
@@ -606,14 +606,14 @@ interface on_cutscene_waypoint_reached {
|
|
|
606
606
|
interface on_entity_cloned {
|
|
607
607
|
destination: LuaEntity;
|
|
608
608
|
/**
|
|
609
|
-
* Identifier of the event
|
|
609
|
+
* Identifier of the event.
|
|
610
610
|
*/
|
|
611
611
|
name: defines.events;
|
|
612
612
|
source: LuaEntity;
|
|
613
613
|
/**
|
|
614
614
|
* Tick the event was generated.
|
|
615
615
|
*/
|
|
616
|
-
tick:
|
|
616
|
+
tick: MapTick;
|
|
617
617
|
}
|
|
618
618
|
/**
|
|
619
619
|
* Called after an entity has been recolored either by the player or through script.
|
|
@@ -626,13 +626,13 @@ interface on_entity_color_changed {
|
|
|
626
626
|
*/
|
|
627
627
|
entity: LuaEntity;
|
|
628
628
|
/**
|
|
629
|
-
* Identifier of the event
|
|
629
|
+
* Identifier of the event.
|
|
630
630
|
*/
|
|
631
631
|
name: defines.events;
|
|
632
632
|
/**
|
|
633
633
|
* Tick the event was generated.
|
|
634
634
|
*/
|
|
635
|
-
tick:
|
|
635
|
+
tick: MapTick;
|
|
636
636
|
}
|
|
637
637
|
/**
|
|
638
638
|
* Called when an entity is damaged. This is not called when an entities health is set directly by another mod.
|
|
@@ -657,7 +657,7 @@ interface on_entity_damaged {
|
|
|
657
657
|
*/
|
|
658
658
|
force?: LuaForce;
|
|
659
659
|
/**
|
|
660
|
-
* Identifier of the event
|
|
660
|
+
* Identifier of the event.
|
|
661
661
|
*/
|
|
662
662
|
name: defines.events;
|
|
663
663
|
/**
|
|
@@ -671,7 +671,7 @@ interface on_entity_damaged {
|
|
|
671
671
|
/**
|
|
672
672
|
* Tick the event was generated.
|
|
673
673
|
*/
|
|
674
|
-
tick:
|
|
674
|
+
tick: MapTick;
|
|
675
675
|
}
|
|
676
676
|
/**
|
|
677
677
|
* Called when an entity dies.
|
|
@@ -698,13 +698,13 @@ interface on_entity_died {
|
|
|
698
698
|
*/
|
|
699
699
|
loot: LuaInventory;
|
|
700
700
|
/**
|
|
701
|
-
* Identifier of the event
|
|
701
|
+
* Identifier of the event.
|
|
702
702
|
*/
|
|
703
703
|
name: defines.events;
|
|
704
704
|
/**
|
|
705
705
|
* Tick the event was generated.
|
|
706
706
|
*/
|
|
707
|
-
tick:
|
|
707
|
+
tick: MapTick;
|
|
708
708
|
}
|
|
709
709
|
/**
|
|
710
710
|
* Called when one of an entity's logistic slots changes.
|
|
@@ -715,7 +715,7 @@ interface on_entity_logistic_slot_changed {
|
|
|
715
715
|
*/
|
|
716
716
|
entity: LuaEntity;
|
|
717
717
|
/**
|
|
718
|
-
* Identifier of the event
|
|
718
|
+
* Identifier of the event.
|
|
719
719
|
*/
|
|
720
720
|
name: defines.events;
|
|
721
721
|
/**
|
|
@@ -733,7 +733,7 @@ interface on_entity_logistic_slot_changed {
|
|
|
733
733
|
/**
|
|
734
734
|
* Tick the event was generated.
|
|
735
735
|
*/
|
|
736
|
-
tick:
|
|
736
|
+
tick: MapTick;
|
|
737
737
|
}
|
|
738
738
|
/**
|
|
739
739
|
* Called after an entity has been renamed either by the player or through script.
|
|
@@ -742,7 +742,7 @@ interface on_entity_renamed {
|
|
|
742
742
|
by_script: boolean;
|
|
743
743
|
entity: LuaEntity;
|
|
744
744
|
/**
|
|
745
|
-
* Identifier of the event
|
|
745
|
+
* Identifier of the event.
|
|
746
746
|
*/
|
|
747
747
|
name: defines.events;
|
|
748
748
|
old_name: string;
|
|
@@ -753,7 +753,7 @@ interface on_entity_renamed {
|
|
|
753
753
|
/**
|
|
754
754
|
* Tick the event was generated.
|
|
755
755
|
*/
|
|
756
|
-
tick:
|
|
756
|
+
tick: MapTick;
|
|
757
757
|
}
|
|
758
758
|
/**
|
|
759
759
|
* Called after entity copy-paste is done.
|
|
@@ -764,7 +764,7 @@ interface on_entity_settings_pasted {
|
|
|
764
764
|
*/
|
|
765
765
|
destination: LuaEntity;
|
|
766
766
|
/**
|
|
767
|
-
* Identifier of the event
|
|
767
|
+
* Identifier of the event.
|
|
768
768
|
*/
|
|
769
769
|
name: defines.events;
|
|
770
770
|
player_index: uint32;
|
|
@@ -775,7 +775,7 @@ interface on_entity_settings_pasted {
|
|
|
775
775
|
/**
|
|
776
776
|
* Tick the event was generated.
|
|
777
777
|
*/
|
|
778
|
-
tick:
|
|
778
|
+
tick: MapTick;
|
|
779
779
|
}
|
|
780
780
|
/**
|
|
781
781
|
* Called when an entity is spawned by a EnemySpawner
|
|
@@ -783,14 +783,14 @@ interface on_entity_settings_pasted {
|
|
|
783
783
|
interface on_entity_spawned {
|
|
784
784
|
entity: LuaEntity;
|
|
785
785
|
/**
|
|
786
|
-
* Identifier of the event
|
|
786
|
+
* Identifier of the event.
|
|
787
787
|
*/
|
|
788
788
|
name: defines.events;
|
|
789
789
|
spawner: LuaEntity;
|
|
790
790
|
/**
|
|
791
791
|
* Tick the event was generated.
|
|
792
792
|
*/
|
|
793
|
-
tick:
|
|
793
|
+
tick: MapTick;
|
|
794
794
|
}
|
|
795
795
|
/**
|
|
796
796
|
* Called after equipment is inserted into an equipment grid.
|
|
@@ -805,13 +805,13 @@ interface on_equipment_inserted {
|
|
|
805
805
|
*/
|
|
806
806
|
grid: LuaEquipmentGrid;
|
|
807
807
|
/**
|
|
808
|
-
* Identifier of the event
|
|
808
|
+
* Identifier of the event.
|
|
809
809
|
*/
|
|
810
810
|
name: defines.events;
|
|
811
811
|
/**
|
|
812
812
|
* Tick the event was generated.
|
|
813
813
|
*/
|
|
814
|
-
tick:
|
|
814
|
+
tick: MapTick;
|
|
815
815
|
}
|
|
816
816
|
/**
|
|
817
817
|
* Called after equipment is removed from an equipment grid.
|
|
@@ -830,7 +830,7 @@ interface on_equipment_removed {
|
|
|
830
830
|
*/
|
|
831
831
|
grid: LuaEquipmentGrid;
|
|
832
832
|
/**
|
|
833
|
-
* Identifier of the event
|
|
833
|
+
* Identifier of the event.
|
|
834
834
|
*/
|
|
835
835
|
name: defines.events;
|
|
836
836
|
/**
|
|
@@ -840,7 +840,7 @@ interface on_equipment_removed {
|
|
|
840
840
|
/**
|
|
841
841
|
* Tick the event was generated.
|
|
842
842
|
*/
|
|
843
|
-
tick:
|
|
843
|
+
tick: MapTick;
|
|
844
844
|
}
|
|
845
845
|
/**
|
|
846
846
|
* Called when the a forces cease fire values change.
|
|
@@ -855,7 +855,7 @@ interface on_force_cease_fire_changed {
|
|
|
855
855
|
*/
|
|
856
856
|
force: LuaForce;
|
|
857
857
|
/**
|
|
858
|
-
* Identifier of the event
|
|
858
|
+
* Identifier of the event.
|
|
859
859
|
*/
|
|
860
860
|
name: defines.events;
|
|
861
861
|
/**
|
|
@@ -865,7 +865,7 @@ interface on_force_cease_fire_changed {
|
|
|
865
865
|
/**
|
|
866
866
|
* Tick the event was generated.
|
|
867
867
|
*/
|
|
868
|
-
tick:
|
|
868
|
+
tick: MapTick;
|
|
869
869
|
}
|
|
870
870
|
/**
|
|
871
871
|
* Called when a new force is created using `game.create_force()`
|
|
@@ -878,13 +878,13 @@ interface on_force_created {
|
|
|
878
878
|
*/
|
|
879
879
|
force: LuaForce;
|
|
880
880
|
/**
|
|
881
|
-
* Identifier of the event
|
|
881
|
+
* Identifier of the event.
|
|
882
882
|
*/
|
|
883
883
|
name: defines.events;
|
|
884
884
|
/**
|
|
885
885
|
* Tick the event was generated.
|
|
886
886
|
*/
|
|
887
|
-
tick:
|
|
887
|
+
tick: MapTick;
|
|
888
888
|
}
|
|
889
889
|
/**
|
|
890
890
|
* Called when the a forces friends change.
|
|
@@ -899,7 +899,7 @@ interface on_force_friends_changed {
|
|
|
899
899
|
*/
|
|
900
900
|
force: LuaForce;
|
|
901
901
|
/**
|
|
902
|
-
* Identifier of the event
|
|
902
|
+
* Identifier of the event.
|
|
903
903
|
*/
|
|
904
904
|
name: defines.events;
|
|
905
905
|
/**
|
|
@@ -909,7 +909,7 @@ interface on_force_friends_changed {
|
|
|
909
909
|
/**
|
|
910
910
|
* Tick the event was generated.
|
|
911
911
|
*/
|
|
912
|
-
tick:
|
|
912
|
+
tick: MapTick;
|
|
913
913
|
}
|
|
914
914
|
/**
|
|
915
915
|
* Called when {@link LuaForce::reset | runtime:LuaForce::reset} is finished.
|
|
@@ -917,13 +917,13 @@ interface on_force_friends_changed {
|
|
|
917
917
|
interface on_force_reset {
|
|
918
918
|
force: LuaForce;
|
|
919
919
|
/**
|
|
920
|
-
* Identifier of the event
|
|
920
|
+
* Identifier of the event.
|
|
921
921
|
*/
|
|
922
922
|
name: defines.events;
|
|
923
923
|
/**
|
|
924
924
|
* Tick the event was generated.
|
|
925
925
|
*/
|
|
926
|
-
tick:
|
|
926
|
+
tick: MapTick;
|
|
927
927
|
}
|
|
928
928
|
/**
|
|
929
929
|
* Called after two forces have been merged using `game.merge_forces()`.
|
|
@@ -936,7 +936,7 @@ interface on_forces_merged {
|
|
|
936
936
|
*/
|
|
937
937
|
destination: LuaForce;
|
|
938
938
|
/**
|
|
939
|
-
* Identifier of the event
|
|
939
|
+
* Identifier of the event.
|
|
940
940
|
*/
|
|
941
941
|
name: defines.events;
|
|
942
942
|
/**
|
|
@@ -950,7 +950,7 @@ interface on_forces_merged {
|
|
|
950
950
|
/**
|
|
951
951
|
* Tick the event was generated.
|
|
952
952
|
*/
|
|
953
|
-
tick:
|
|
953
|
+
tick: MapTick;
|
|
954
954
|
}
|
|
955
955
|
/**
|
|
956
956
|
* Called when two forces are about to be merged using `game.merge_forces()`.
|
|
@@ -961,7 +961,7 @@ interface on_forces_merging {
|
|
|
961
961
|
*/
|
|
962
962
|
destination: LuaForce;
|
|
963
963
|
/**
|
|
964
|
-
* Identifier of the event
|
|
964
|
+
* Identifier of the event.
|
|
965
965
|
*/
|
|
966
966
|
name: defines.events;
|
|
967
967
|
/**
|
|
@@ -971,7 +971,7 @@ interface on_forces_merging {
|
|
|
971
971
|
/**
|
|
972
972
|
* Tick the event was generated.
|
|
973
973
|
*/
|
|
974
|
-
tick:
|
|
974
|
+
tick: MapTick;
|
|
975
975
|
}
|
|
976
976
|
/**
|
|
977
977
|
* Called when a game is created from a scenario. This is fired for every mod, even when the scenario's save data already includes it. In those cases however, {@link LuaBootstrap::on_init | runtime:LuaBootstrap::on_init} is not fired.
|
|
@@ -980,13 +980,13 @@ interface on_forces_merging {
|
|
|
980
980
|
*/
|
|
981
981
|
interface on_game_created_from_scenario {
|
|
982
982
|
/**
|
|
983
|
-
* Identifier of the event
|
|
983
|
+
* Identifier of the event.
|
|
984
984
|
*/
|
|
985
985
|
name: defines.events;
|
|
986
986
|
/**
|
|
987
987
|
* Tick the event was generated.
|
|
988
988
|
*/
|
|
989
|
-
tick:
|
|
989
|
+
tick: MapTick;
|
|
990
990
|
}
|
|
991
991
|
/**
|
|
992
992
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
|
|
@@ -997,7 +997,7 @@ interface on_gui_checked_state_changed {
|
|
|
997
997
|
*/
|
|
998
998
|
element: LuaGuiElement;
|
|
999
999
|
/**
|
|
1000
|
-
* Identifier of the event
|
|
1000
|
+
* Identifier of the event.
|
|
1001
1001
|
*/
|
|
1002
1002
|
name: defines.events;
|
|
1003
1003
|
/**
|
|
@@ -1007,7 +1007,7 @@ interface on_gui_checked_state_changed {
|
|
|
1007
1007
|
/**
|
|
1008
1008
|
* Tick the event was generated.
|
|
1009
1009
|
*/
|
|
1010
|
-
tick:
|
|
1010
|
+
tick: MapTick;
|
|
1011
1011
|
}
|
|
1012
1012
|
/**
|
|
1013
1013
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} is clicked.
|
|
@@ -1034,7 +1034,7 @@ interface on_gui_click {
|
|
|
1034
1034
|
*/
|
|
1035
1035
|
element: LuaGuiElement;
|
|
1036
1036
|
/**
|
|
1037
|
-
* Identifier of the event
|
|
1037
|
+
* Identifier of the event.
|
|
1038
1038
|
*/
|
|
1039
1039
|
name: defines.events;
|
|
1040
1040
|
/**
|
|
@@ -1048,7 +1048,7 @@ interface on_gui_click {
|
|
|
1048
1048
|
/**
|
|
1049
1049
|
* Tick the event was generated.
|
|
1050
1050
|
*/
|
|
1051
|
-
tick:
|
|
1051
|
+
tick: MapTick;
|
|
1052
1052
|
}
|
|
1053
1053
|
/**
|
|
1054
1054
|
* Called when the player closes the GUI they have open.
|
|
@@ -1083,7 +1083,7 @@ interface on_gui_closed {
|
|
|
1083
1083
|
*/
|
|
1084
1084
|
item?: LuaItemStack;
|
|
1085
1085
|
/**
|
|
1086
|
-
* Identifier of the event
|
|
1086
|
+
* Identifier of the event.
|
|
1087
1087
|
*/
|
|
1088
1088
|
name: defines.events;
|
|
1089
1089
|
/**
|
|
@@ -1101,7 +1101,7 @@ interface on_gui_closed {
|
|
|
1101
1101
|
/**
|
|
1102
1102
|
* Tick the event was generated.
|
|
1103
1103
|
*/
|
|
1104
|
-
tick:
|
|
1104
|
+
tick: MapTick;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* The position of the tile whose GUI was closed.
|
|
1107
1107
|
*/
|
|
@@ -1124,7 +1124,7 @@ interface on_gui_confirmed {
|
|
|
1124
1124
|
*/
|
|
1125
1125
|
element: LuaGuiElement;
|
|
1126
1126
|
/**
|
|
1127
|
-
* Identifier of the event
|
|
1127
|
+
* Identifier of the event.
|
|
1128
1128
|
*/
|
|
1129
1129
|
name: defines.events;
|
|
1130
1130
|
/**
|
|
@@ -1138,7 +1138,7 @@ interface on_gui_confirmed {
|
|
|
1138
1138
|
/**
|
|
1139
1139
|
* Tick the event was generated.
|
|
1140
1140
|
*/
|
|
1141
|
-
tick:
|
|
1141
|
+
tick: MapTick;
|
|
1142
1142
|
}
|
|
1143
1143
|
/**
|
|
1144
1144
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} element value is changed (related to choose element buttons).
|
|
@@ -1149,7 +1149,7 @@ interface on_gui_elem_changed {
|
|
|
1149
1149
|
*/
|
|
1150
1150
|
element: LuaGuiElement;
|
|
1151
1151
|
/**
|
|
1152
|
-
* Identifier of the event
|
|
1152
|
+
* Identifier of the event.
|
|
1153
1153
|
*/
|
|
1154
1154
|
name: defines.events;
|
|
1155
1155
|
/**
|
|
@@ -1159,7 +1159,7 @@ interface on_gui_elem_changed {
|
|
|
1159
1159
|
/**
|
|
1160
1160
|
* Tick the event was generated.
|
|
1161
1161
|
*/
|
|
1162
|
-
tick:
|
|
1162
|
+
tick: MapTick;
|
|
1163
1163
|
}
|
|
1164
1164
|
/**
|
|
1165
1165
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} is hovered by the mouse.
|
|
@@ -1172,7 +1172,7 @@ interface on_gui_hover {
|
|
|
1172
1172
|
*/
|
|
1173
1173
|
element: LuaGuiElement;
|
|
1174
1174
|
/**
|
|
1175
|
-
* Identifier of the event
|
|
1175
|
+
* Identifier of the event.
|
|
1176
1176
|
*/
|
|
1177
1177
|
name: defines.events;
|
|
1178
1178
|
/**
|
|
@@ -1182,7 +1182,7 @@ interface on_gui_hover {
|
|
|
1182
1182
|
/**
|
|
1183
1183
|
* Tick the event was generated.
|
|
1184
1184
|
*/
|
|
1185
|
-
tick:
|
|
1185
|
+
tick: MapTick;
|
|
1186
1186
|
}
|
|
1187
1187
|
/**
|
|
1188
1188
|
* Called when the player's cursor leaves a {@link LuaGuiElement | runtime:LuaGuiElement} that was previously hovered.
|
|
@@ -1195,7 +1195,7 @@ interface on_gui_leave {
|
|
|
1195
1195
|
*/
|
|
1196
1196
|
element: LuaGuiElement;
|
|
1197
1197
|
/**
|
|
1198
|
-
* Identifier of the event
|
|
1198
|
+
* Identifier of the event.
|
|
1199
1199
|
*/
|
|
1200
1200
|
name: defines.events;
|
|
1201
1201
|
/**
|
|
@@ -1205,7 +1205,7 @@ interface on_gui_leave {
|
|
|
1205
1205
|
/**
|
|
1206
1206
|
* Tick the event was generated.
|
|
1207
1207
|
*/
|
|
1208
|
-
tick:
|
|
1208
|
+
tick: MapTick;
|
|
1209
1209
|
}
|
|
1210
1210
|
/**
|
|
1211
1211
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
|
|
@@ -1216,7 +1216,7 @@ interface on_gui_location_changed {
|
|
|
1216
1216
|
*/
|
|
1217
1217
|
element: LuaGuiElement;
|
|
1218
1218
|
/**
|
|
1219
|
-
* Identifier of the event
|
|
1219
|
+
* Identifier of the event.
|
|
1220
1220
|
*/
|
|
1221
1221
|
name: defines.events;
|
|
1222
1222
|
/**
|
|
@@ -1226,7 +1226,7 @@ interface on_gui_location_changed {
|
|
|
1226
1226
|
/**
|
|
1227
1227
|
* Tick the event was generated.
|
|
1228
1228
|
*/
|
|
1229
|
-
tick:
|
|
1229
|
+
tick: MapTick;
|
|
1230
1230
|
}
|
|
1231
1231
|
/**
|
|
1232
1232
|
* Called when the player opens a GUI.
|
|
@@ -1257,7 +1257,7 @@ interface on_gui_opened {
|
|
|
1257
1257
|
*/
|
|
1258
1258
|
item?: LuaItemStack;
|
|
1259
1259
|
/**
|
|
1260
|
-
* Identifier of the event
|
|
1260
|
+
* Identifier of the event.
|
|
1261
1261
|
*/
|
|
1262
1262
|
name: defines.events;
|
|
1263
1263
|
/**
|
|
@@ -1265,7 +1265,7 @@ interface on_gui_opened {
|
|
|
1265
1265
|
*/
|
|
1266
1266
|
other_player?: LuaPlayer;
|
|
1267
1267
|
/**
|
|
1268
|
-
* The player
|
|
1268
|
+
* The player opening the GUI.
|
|
1269
1269
|
*/
|
|
1270
1270
|
player_index: uint32;
|
|
1271
1271
|
/**
|
|
@@ -1275,7 +1275,7 @@ interface on_gui_opened {
|
|
|
1275
1275
|
/**
|
|
1276
1276
|
* Tick the event was generated.
|
|
1277
1277
|
*/
|
|
1278
|
-
tick:
|
|
1278
|
+
tick: MapTick;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* The position of the tile whose GUI was opened.
|
|
1281
1281
|
*/
|
|
@@ -1290,7 +1290,7 @@ interface on_gui_selected_tab_changed {
|
|
|
1290
1290
|
*/
|
|
1291
1291
|
element: LuaGuiElement;
|
|
1292
1292
|
/**
|
|
1293
|
-
* Identifier of the event
|
|
1293
|
+
* Identifier of the event.
|
|
1294
1294
|
*/
|
|
1295
1295
|
name: defines.events;
|
|
1296
1296
|
/**
|
|
@@ -1300,7 +1300,7 @@ interface on_gui_selected_tab_changed {
|
|
|
1300
1300
|
/**
|
|
1301
1301
|
* Tick the event was generated.
|
|
1302
1302
|
*/
|
|
1303
|
-
tick:
|
|
1303
|
+
tick: MapTick;
|
|
1304
1304
|
}
|
|
1305
1305
|
/**
|
|
1306
1306
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
|
|
@@ -1311,7 +1311,7 @@ interface on_gui_selection_state_changed {
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
element: LuaGuiElement;
|
|
1313
1313
|
/**
|
|
1314
|
-
* Identifier of the event
|
|
1314
|
+
* Identifier of the event.
|
|
1315
1315
|
*/
|
|
1316
1316
|
name: defines.events;
|
|
1317
1317
|
/**
|
|
@@ -1321,7 +1321,7 @@ interface on_gui_selection_state_changed {
|
|
|
1321
1321
|
/**
|
|
1322
1322
|
* Tick the event was generated.
|
|
1323
1323
|
*/
|
|
1324
|
-
tick:
|
|
1324
|
+
tick: MapTick;
|
|
1325
1325
|
}
|
|
1326
1326
|
/**
|
|
1327
1327
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} switch state is changed (related to switches).
|
|
@@ -1332,7 +1332,7 @@ interface on_gui_switch_state_changed {
|
|
|
1332
1332
|
*/
|
|
1333
1333
|
element: LuaGuiElement;
|
|
1334
1334
|
/**
|
|
1335
|
-
* Identifier of the event
|
|
1335
|
+
* Identifier of the event.
|
|
1336
1336
|
*/
|
|
1337
1337
|
name: defines.events;
|
|
1338
1338
|
/**
|
|
@@ -1342,7 +1342,7 @@ interface on_gui_switch_state_changed {
|
|
|
1342
1342
|
/**
|
|
1343
1343
|
* Tick the event was generated.
|
|
1344
1344
|
*/
|
|
1345
|
-
tick:
|
|
1345
|
+
tick: MapTick;
|
|
1346
1346
|
}
|
|
1347
1347
|
/**
|
|
1348
1348
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} text is changed by the player.
|
|
@@ -1353,7 +1353,7 @@ interface on_gui_text_changed {
|
|
|
1353
1353
|
*/
|
|
1354
1354
|
element: LuaGuiElement;
|
|
1355
1355
|
/**
|
|
1356
|
-
* Identifier of the event
|
|
1356
|
+
* Identifier of the event.
|
|
1357
1357
|
*/
|
|
1358
1358
|
name: defines.events;
|
|
1359
1359
|
/**
|
|
@@ -1367,7 +1367,7 @@ interface on_gui_text_changed {
|
|
|
1367
1367
|
/**
|
|
1368
1368
|
* Tick the event was generated.
|
|
1369
1369
|
*/
|
|
1370
|
-
tick:
|
|
1370
|
+
tick: MapTick;
|
|
1371
1371
|
}
|
|
1372
1372
|
/**
|
|
1373
1373
|
* Called when {@link LuaGuiElement | runtime:LuaGuiElement} slider value is changed (related to the slider element).
|
|
@@ -1378,7 +1378,7 @@ interface on_gui_value_changed {
|
|
|
1378
1378
|
*/
|
|
1379
1379
|
element: LuaGuiElement;
|
|
1380
1380
|
/**
|
|
1381
|
-
* Identifier of the event
|
|
1381
|
+
* Identifier of the event.
|
|
1382
1382
|
*/
|
|
1383
1383
|
name: defines.events;
|
|
1384
1384
|
/**
|
|
@@ -1388,7 +1388,7 @@ interface on_gui_value_changed {
|
|
|
1388
1388
|
/**
|
|
1389
1389
|
* Tick the event was generated.
|
|
1390
1390
|
*/
|
|
1391
|
-
tick:
|
|
1391
|
+
tick: MapTick;
|
|
1392
1392
|
}
|
|
1393
1393
|
/**
|
|
1394
1394
|
* Called when a land mine is armed.
|
|
@@ -1396,20 +1396,20 @@ interface on_gui_value_changed {
|
|
|
1396
1396
|
interface on_land_mine_armed {
|
|
1397
1397
|
mine: LuaEntity;
|
|
1398
1398
|
/**
|
|
1399
|
-
* Identifier of the event
|
|
1399
|
+
* Identifier of the event.
|
|
1400
1400
|
*/
|
|
1401
1401
|
name: defines.events;
|
|
1402
1402
|
/**
|
|
1403
1403
|
* Tick the event was generated.
|
|
1404
1404
|
*/
|
|
1405
|
-
tick:
|
|
1405
|
+
tick: MapTick;
|
|
1406
1406
|
}
|
|
1407
1407
|
/**
|
|
1408
1408
|
* Called when a custom {@link Lua shortcut | prototype:ShortcutPrototype} is pressed.
|
|
1409
1409
|
*/
|
|
1410
1410
|
interface on_lua_shortcut {
|
|
1411
1411
|
/**
|
|
1412
|
-
* Identifier of the event
|
|
1412
|
+
* Identifier of the event.
|
|
1413
1413
|
*/
|
|
1414
1414
|
name: defines.events;
|
|
1415
1415
|
player_index: uint32;
|
|
@@ -1420,7 +1420,7 @@ interface on_lua_shortcut {
|
|
|
1420
1420
|
/**
|
|
1421
1421
|
* Tick the event was generated.
|
|
1422
1422
|
*/
|
|
1423
|
-
tick:
|
|
1423
|
+
tick: MapTick;
|
|
1424
1424
|
}
|
|
1425
1425
|
/**
|
|
1426
1426
|
* Called when an entity is marked for deconstruction with the Deconstruction planner or via script.
|
|
@@ -1428,14 +1428,14 @@ interface on_lua_shortcut {
|
|
|
1428
1428
|
interface on_marked_for_deconstruction {
|
|
1429
1429
|
entity: LuaEntity;
|
|
1430
1430
|
/**
|
|
1431
|
-
* Identifier of the event
|
|
1431
|
+
* Identifier of the event.
|
|
1432
1432
|
*/
|
|
1433
1433
|
name: defines.events;
|
|
1434
1434
|
player_index?: uint32;
|
|
1435
1435
|
/**
|
|
1436
1436
|
* Tick the event was generated.
|
|
1437
1437
|
*/
|
|
1438
|
-
tick:
|
|
1438
|
+
tick: MapTick;
|
|
1439
1439
|
}
|
|
1440
1440
|
/**
|
|
1441
1441
|
* Called when an entity is marked for upgrade with the upgrade planner or via script.
|
|
@@ -1443,7 +1443,7 @@ interface on_marked_for_deconstruction {
|
|
|
1443
1443
|
interface on_marked_for_upgrade {
|
|
1444
1444
|
entity: LuaEntity;
|
|
1445
1445
|
/**
|
|
1446
|
-
* Identifier of the event
|
|
1446
|
+
* Identifier of the event.
|
|
1447
1447
|
*/
|
|
1448
1448
|
name: defines.events;
|
|
1449
1449
|
player_index?: uint32;
|
|
@@ -1463,7 +1463,7 @@ interface on_marked_for_upgrade {
|
|
|
1463
1463
|
/**
|
|
1464
1464
|
* Tick the event was generated.
|
|
1465
1465
|
*/
|
|
1466
|
-
tick:
|
|
1466
|
+
tick: MapTick;
|
|
1467
1467
|
}
|
|
1468
1468
|
/**
|
|
1469
1469
|
* Called after a player purchases some offer from a `market` entity.
|
|
@@ -1478,7 +1478,7 @@ interface on_market_item_purchased {
|
|
|
1478
1478
|
*/
|
|
1479
1479
|
market: LuaEntity;
|
|
1480
1480
|
/**
|
|
1481
|
-
* Identifier of the event
|
|
1481
|
+
* Identifier of the event.
|
|
1482
1482
|
*/
|
|
1483
1483
|
name: defines.events;
|
|
1484
1484
|
/**
|
|
@@ -1492,7 +1492,7 @@ interface on_market_item_purchased {
|
|
|
1492
1492
|
/**
|
|
1493
1493
|
* Tick the event was generated.
|
|
1494
1494
|
*/
|
|
1495
|
-
tick:
|
|
1495
|
+
tick: MapTick;
|
|
1496
1496
|
}
|
|
1497
1497
|
/**
|
|
1498
1498
|
* Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
|
|
@@ -1503,7 +1503,7 @@ interface on_mod_item_opened {
|
|
|
1503
1503
|
*/
|
|
1504
1504
|
item: LuaItemPrototype;
|
|
1505
1505
|
/**
|
|
1506
|
-
* Identifier of the event
|
|
1506
|
+
* Identifier of the event.
|
|
1507
1507
|
*/
|
|
1508
1508
|
name: defines.events;
|
|
1509
1509
|
/**
|
|
@@ -1517,20 +1517,20 @@ interface on_mod_item_opened {
|
|
|
1517
1517
|
/**
|
|
1518
1518
|
* Tick the event was generated.
|
|
1519
1519
|
*/
|
|
1520
|
-
tick:
|
|
1520
|
+
tick: MapTick;
|
|
1521
1521
|
}
|
|
1522
1522
|
/**
|
|
1523
1523
|
* Called when {@link LuaGameScript::is_multiplayer | runtime:LuaGameScript::is_multiplayer} changes to true. May also be raised when it was already true but a game was loaded from a save file and with hosting.
|
|
1524
1524
|
*/
|
|
1525
1525
|
interface on_multiplayer_init {
|
|
1526
1526
|
/**
|
|
1527
|
-
* Identifier of the event
|
|
1527
|
+
* Identifier of the event.
|
|
1528
1528
|
*/
|
|
1529
1529
|
name: defines.events;
|
|
1530
1530
|
/**
|
|
1531
1531
|
* Tick the event was generated.
|
|
1532
1532
|
*/
|
|
1533
|
-
tick:
|
|
1533
|
+
tick: MapTick;
|
|
1534
1534
|
}
|
|
1535
1535
|
/**
|
|
1536
1536
|
* Called after an object is destroyed which was registered with {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed} previously.
|
|
@@ -1539,7 +1539,7 @@ interface on_multiplayer_init {
|
|
|
1539
1539
|
*/
|
|
1540
1540
|
interface on_object_destroyed {
|
|
1541
1541
|
/**
|
|
1542
|
-
* Identifier of the event
|
|
1542
|
+
* Identifier of the event.
|
|
1543
1543
|
*/
|
|
1544
1544
|
name: defines.events;
|
|
1545
1545
|
/**
|
|
@@ -1549,13 +1549,13 @@ interface on_object_destroyed {
|
|
|
1549
1549
|
/**
|
|
1550
1550
|
* Tick the event was generated.
|
|
1551
1551
|
*/
|
|
1552
|
-
tick:
|
|
1552
|
+
tick: MapTick;
|
|
1553
1553
|
/**
|
|
1554
|
-
* Type of the object that was destroyed. Same as third value returned by {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}
|
|
1554
|
+
* Type of the object that was destroyed. Same as third value returned by {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}.
|
|
1555
1555
|
*/
|
|
1556
1556
|
type: defines.target_type;
|
|
1557
1557
|
/**
|
|
1558
|
-
* The {@link useful identifier | runtime:RegistrationTarget} of the object. Same as second value returned by {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}
|
|
1558
|
+
* The {@link useful identifier | runtime:RegistrationTarget} of the object or `0` if the object does not have a useful id. Same as second value returned by {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}.
|
|
1559
1559
|
*/
|
|
1560
1560
|
useful_id: uint64;
|
|
1561
1561
|
}
|
|
@@ -1568,7 +1568,7 @@ interface on_permission_group_added {
|
|
|
1568
1568
|
*/
|
|
1569
1569
|
group: LuaPermissionGroup;
|
|
1570
1570
|
/**
|
|
1571
|
-
* Identifier of the event
|
|
1571
|
+
* Identifier of the event.
|
|
1572
1572
|
*/
|
|
1573
1573
|
name: defines.events;
|
|
1574
1574
|
/**
|
|
@@ -1578,7 +1578,7 @@ interface on_permission_group_added {
|
|
|
1578
1578
|
/**
|
|
1579
1579
|
* Tick the event was generated.
|
|
1580
1580
|
*/
|
|
1581
|
-
tick:
|
|
1581
|
+
tick: MapTick;
|
|
1582
1582
|
}
|
|
1583
1583
|
/**
|
|
1584
1584
|
* Called directly after a permission group is deleted.
|
|
@@ -1593,7 +1593,7 @@ interface on_permission_group_deleted {
|
|
|
1593
1593
|
*/
|
|
1594
1594
|
id: uint32;
|
|
1595
1595
|
/**
|
|
1596
|
-
* Identifier of the event
|
|
1596
|
+
* Identifier of the event.
|
|
1597
1597
|
*/
|
|
1598
1598
|
name: defines.events;
|
|
1599
1599
|
/**
|
|
@@ -1603,7 +1603,7 @@ interface on_permission_group_deleted {
|
|
|
1603
1603
|
/**
|
|
1604
1604
|
* Tick the event was generated.
|
|
1605
1605
|
*/
|
|
1606
|
-
tick:
|
|
1606
|
+
tick: MapTick;
|
|
1607
1607
|
}
|
|
1608
1608
|
/**
|
|
1609
1609
|
* Called directly after a permission group is edited in some way.
|
|
@@ -1618,7 +1618,7 @@ interface on_permission_group_edited {
|
|
|
1618
1618
|
*/
|
|
1619
1619
|
group: LuaPermissionGroup;
|
|
1620
1620
|
/**
|
|
1621
|
-
* Identifier of the event
|
|
1621
|
+
* Identifier of the event.
|
|
1622
1622
|
*/
|
|
1623
1623
|
name: defines.events;
|
|
1624
1624
|
/**
|
|
@@ -1640,7 +1640,7 @@ interface on_permission_group_edited {
|
|
|
1640
1640
|
/**
|
|
1641
1641
|
* Tick the event was generated.
|
|
1642
1642
|
*/
|
|
1643
|
-
tick:
|
|
1643
|
+
tick: MapTick;
|
|
1644
1644
|
/**
|
|
1645
1645
|
* The edit type.
|
|
1646
1646
|
*/
|
|
@@ -1651,7 +1651,7 @@ interface on_permission_group_edited {
|
|
|
1651
1651
|
*/
|
|
1652
1652
|
interface on_permission_string_imported {
|
|
1653
1653
|
/**
|
|
1654
|
-
* Identifier of the event
|
|
1654
|
+
* Identifier of the event.
|
|
1655
1655
|
*/
|
|
1656
1656
|
name: defines.events;
|
|
1657
1657
|
/**
|
|
@@ -1661,7 +1661,7 @@ interface on_permission_string_imported {
|
|
|
1661
1661
|
/**
|
|
1662
1662
|
* Tick the event was generated.
|
|
1663
1663
|
*/
|
|
1664
|
-
tick:
|
|
1664
|
+
tick: MapTick;
|
|
1665
1665
|
}
|
|
1666
1666
|
/**
|
|
1667
1667
|
* Called when a player picks up an item.
|
|
@@ -1669,14 +1669,14 @@ interface on_permission_string_imported {
|
|
|
1669
1669
|
interface on_picked_up_item {
|
|
1670
1670
|
item_stack: ItemWithQualityCount;
|
|
1671
1671
|
/**
|
|
1672
|
-
* Identifier of the event
|
|
1672
|
+
* Identifier of the event.
|
|
1673
1673
|
*/
|
|
1674
1674
|
name: defines.events;
|
|
1675
1675
|
player_index: uint32;
|
|
1676
1676
|
/**
|
|
1677
1677
|
* Tick the event was generated.
|
|
1678
1678
|
*/
|
|
1679
|
-
tick:
|
|
1679
|
+
tick: MapTick;
|
|
1680
1680
|
}
|
|
1681
1681
|
/**
|
|
1682
1682
|
* Called after a player alt-reverse-selects an area with a selection-tool item.
|
|
@@ -1695,7 +1695,7 @@ interface on_player_alt_reverse_selected_area {
|
|
|
1695
1695
|
*/
|
|
1696
1696
|
item: string;
|
|
1697
1697
|
/**
|
|
1698
|
-
* Identifier of the event
|
|
1698
|
+
* Identifier of the event.
|
|
1699
1699
|
*/
|
|
1700
1700
|
name: defines.events;
|
|
1701
1701
|
/**
|
|
@@ -1709,7 +1709,7 @@ interface on_player_alt_reverse_selected_area {
|
|
|
1709
1709
|
/**
|
|
1710
1710
|
* Tick the event was generated.
|
|
1711
1711
|
*/
|
|
1712
|
-
tick:
|
|
1712
|
+
tick: MapTick;
|
|
1713
1713
|
/**
|
|
1714
1714
|
* The tiles selected.
|
|
1715
1715
|
*/
|
|
@@ -1732,7 +1732,7 @@ interface on_player_alt_selected_area {
|
|
|
1732
1732
|
*/
|
|
1733
1733
|
item: string;
|
|
1734
1734
|
/**
|
|
1735
|
-
* Identifier of the event
|
|
1735
|
+
* Identifier of the event.
|
|
1736
1736
|
*/
|
|
1737
1737
|
name: defines.events;
|
|
1738
1738
|
/**
|
|
@@ -1750,7 +1750,7 @@ interface on_player_alt_selected_area {
|
|
|
1750
1750
|
/**
|
|
1751
1751
|
* Tick the event was generated.
|
|
1752
1752
|
*/
|
|
1753
|
-
tick:
|
|
1753
|
+
tick: MapTick;
|
|
1754
1754
|
/**
|
|
1755
1755
|
* The tiles selected.
|
|
1756
1756
|
*/
|
|
@@ -1761,28 +1761,28 @@ interface on_player_alt_selected_area {
|
|
|
1761
1761
|
*/
|
|
1762
1762
|
interface on_player_ammo_inventory_changed {
|
|
1763
1763
|
/**
|
|
1764
|
-
* Identifier of the event
|
|
1764
|
+
* Identifier of the event.
|
|
1765
1765
|
*/
|
|
1766
1766
|
name: defines.events;
|
|
1767
1767
|
player_index: uint32;
|
|
1768
1768
|
/**
|
|
1769
1769
|
* Tick the event was generated.
|
|
1770
1770
|
*/
|
|
1771
|
-
tick:
|
|
1771
|
+
tick: MapTick;
|
|
1772
1772
|
}
|
|
1773
1773
|
/**
|
|
1774
1774
|
* Called after a players armor inventory changed in some way.
|
|
1775
1775
|
*/
|
|
1776
1776
|
interface on_player_armor_inventory_changed {
|
|
1777
1777
|
/**
|
|
1778
|
-
* Identifier of the event
|
|
1778
|
+
* Identifier of the event.
|
|
1779
1779
|
*/
|
|
1780
1780
|
name: defines.events;
|
|
1781
1781
|
player_index: uint32;
|
|
1782
1782
|
/**
|
|
1783
1783
|
* Tick the event was generated.
|
|
1784
1784
|
*/
|
|
1785
|
-
tick:
|
|
1785
|
+
tick: MapTick;
|
|
1786
1786
|
}
|
|
1787
1787
|
/**
|
|
1788
1788
|
* Called when a player is banned.
|
|
@@ -1793,7 +1793,7 @@ interface on_player_banned {
|
|
|
1793
1793
|
*/
|
|
1794
1794
|
by_player?: uint32;
|
|
1795
1795
|
/**
|
|
1796
|
-
* Identifier of the event
|
|
1796
|
+
* Identifier of the event.
|
|
1797
1797
|
*/
|
|
1798
1798
|
name: defines.events;
|
|
1799
1799
|
/**
|
|
@@ -1811,7 +1811,7 @@ interface on_player_banned {
|
|
|
1811
1811
|
/**
|
|
1812
1812
|
* Tick the event was generated.
|
|
1813
1813
|
*/
|
|
1814
|
-
tick:
|
|
1814
|
+
tick: MapTick;
|
|
1815
1815
|
}
|
|
1816
1816
|
/**
|
|
1817
1817
|
* Called after a player builds tiles.
|
|
@@ -1826,7 +1826,7 @@ interface on_player_built_tile {
|
|
|
1826
1826
|
*/
|
|
1827
1827
|
item?: LuaItemPrototype;
|
|
1828
1828
|
/**
|
|
1829
|
-
* Identifier of the event
|
|
1829
|
+
* Identifier of the event.
|
|
1830
1830
|
*/
|
|
1831
1831
|
name: defines.events;
|
|
1832
1832
|
player_index: uint32;
|
|
@@ -1841,7 +1841,7 @@ interface on_player_built_tile {
|
|
|
1841
1841
|
/**
|
|
1842
1842
|
* Tick the event was generated.
|
|
1843
1843
|
*/
|
|
1844
|
-
tick:
|
|
1844
|
+
tick: MapTick;
|
|
1845
1845
|
/**
|
|
1846
1846
|
* The tile prototype that was placed.
|
|
1847
1847
|
*/
|
|
@@ -1864,7 +1864,7 @@ interface on_player_cancelled_crafting {
|
|
|
1864
1864
|
*/
|
|
1865
1865
|
items: LuaInventory;
|
|
1866
1866
|
/**
|
|
1867
|
-
* Identifier of the event
|
|
1867
|
+
* Identifier of the event.
|
|
1868
1868
|
*/
|
|
1869
1869
|
name: defines.events;
|
|
1870
1870
|
/**
|
|
@@ -1878,7 +1878,7 @@ interface on_player_cancelled_crafting {
|
|
|
1878
1878
|
/**
|
|
1879
1879
|
* Tick the event was generated.
|
|
1880
1880
|
*/
|
|
1881
|
-
tick:
|
|
1881
|
+
tick: MapTick;
|
|
1882
1882
|
}
|
|
1883
1883
|
/**
|
|
1884
1884
|
* Called after a player changes forces.
|
|
@@ -1889,7 +1889,7 @@ interface on_player_changed_force {
|
|
|
1889
1889
|
*/
|
|
1890
1890
|
force: LuaForce;
|
|
1891
1891
|
/**
|
|
1892
|
-
* Identifier of the event
|
|
1892
|
+
* Identifier of the event.
|
|
1893
1893
|
*/
|
|
1894
1894
|
name: defines.events;
|
|
1895
1895
|
/**
|
|
@@ -1899,14 +1899,14 @@ interface on_player_changed_force {
|
|
|
1899
1899
|
/**
|
|
1900
1900
|
* Tick the event was generated.
|
|
1901
1901
|
*/
|
|
1902
|
-
tick:
|
|
1902
|
+
tick: MapTick;
|
|
1903
1903
|
}
|
|
1904
1904
|
/**
|
|
1905
1905
|
* Called when the tile position a player is located at changes.
|
|
1906
1906
|
*/
|
|
1907
1907
|
interface on_player_changed_position {
|
|
1908
1908
|
/**
|
|
1909
|
-
* Identifier of the event
|
|
1909
|
+
* Identifier of the event.
|
|
1910
1910
|
*/
|
|
1911
1911
|
name: defines.events;
|
|
1912
1912
|
/**
|
|
@@ -1916,14 +1916,14 @@ interface on_player_changed_position {
|
|
|
1916
1916
|
/**
|
|
1917
1917
|
* Tick the event was generated.
|
|
1918
1918
|
*/
|
|
1919
|
-
tick:
|
|
1919
|
+
tick: MapTick;
|
|
1920
1920
|
}
|
|
1921
1921
|
/**
|
|
1922
1922
|
* Called after a player changes surfaces.
|
|
1923
1923
|
*/
|
|
1924
1924
|
interface on_player_changed_surface {
|
|
1925
1925
|
/**
|
|
1926
|
-
* Identifier of the event
|
|
1926
|
+
* Identifier of the event.
|
|
1927
1927
|
*/
|
|
1928
1928
|
name: defines.events;
|
|
1929
1929
|
/**
|
|
@@ -1937,14 +1937,14 @@ interface on_player_changed_surface {
|
|
|
1937
1937
|
/**
|
|
1938
1938
|
* Tick the event was generated.
|
|
1939
1939
|
*/
|
|
1940
|
-
tick:
|
|
1940
|
+
tick: MapTick;
|
|
1941
1941
|
}
|
|
1942
1942
|
/**
|
|
1943
1943
|
* Called when cheat mode is disabled on a player.
|
|
1944
1944
|
*/
|
|
1945
1945
|
interface on_player_cheat_mode_disabled {
|
|
1946
1946
|
/**
|
|
1947
|
-
* Identifier of the event
|
|
1947
|
+
* Identifier of the event.
|
|
1948
1948
|
*/
|
|
1949
1949
|
name: defines.events;
|
|
1950
1950
|
/**
|
|
@@ -1954,14 +1954,14 @@ interface on_player_cheat_mode_disabled {
|
|
|
1954
1954
|
/**
|
|
1955
1955
|
* Tick the event was generated.
|
|
1956
1956
|
*/
|
|
1957
|
-
tick:
|
|
1957
|
+
tick: MapTick;
|
|
1958
1958
|
}
|
|
1959
1959
|
/**
|
|
1960
1960
|
* Called when cheat mode is enabled on a player.
|
|
1961
1961
|
*/
|
|
1962
1962
|
interface on_player_cheat_mode_enabled {
|
|
1963
1963
|
/**
|
|
1964
|
-
* Identifier of the event
|
|
1964
|
+
* Identifier of the event.
|
|
1965
1965
|
*/
|
|
1966
1966
|
name: defines.events;
|
|
1967
1967
|
/**
|
|
@@ -1971,14 +1971,14 @@ interface on_player_cheat_mode_enabled {
|
|
|
1971
1971
|
/**
|
|
1972
1972
|
* Tick the event was generated.
|
|
1973
1973
|
*/
|
|
1974
|
-
tick:
|
|
1974
|
+
tick: MapTick;
|
|
1975
1975
|
}
|
|
1976
1976
|
/**
|
|
1977
1977
|
* Called when a player clicks a gps tag
|
|
1978
1978
|
*/
|
|
1979
1979
|
interface on_player_clicked_gps_tag {
|
|
1980
1980
|
/**
|
|
1981
|
-
* Identifier of the event
|
|
1981
|
+
* Identifier of the event.
|
|
1982
1982
|
*/
|
|
1983
1983
|
name: defines.events;
|
|
1984
1984
|
/**
|
|
@@ -1996,14 +1996,14 @@ interface on_player_clicked_gps_tag {
|
|
|
1996
1996
|
/**
|
|
1997
1997
|
* Tick the event was generated.
|
|
1998
1998
|
*/
|
|
1999
|
-
tick:
|
|
1999
|
+
tick: MapTick;
|
|
2000
2000
|
}
|
|
2001
2001
|
/**
|
|
2002
2002
|
* Called when a player clicks the "confirm" button in the configure Blueprint GUI.
|
|
2003
2003
|
*/
|
|
2004
2004
|
interface on_player_configured_blueprint {
|
|
2005
2005
|
/**
|
|
2006
|
-
* Identifier of the event
|
|
2006
|
+
* Identifier of the event.
|
|
2007
2007
|
*/
|
|
2008
2008
|
name: defines.events;
|
|
2009
2009
|
/**
|
|
@@ -2013,14 +2013,14 @@ interface on_player_configured_blueprint {
|
|
|
2013
2013
|
/**
|
|
2014
2014
|
* Tick the event was generated.
|
|
2015
2015
|
*/
|
|
2016
|
-
tick:
|
|
2016
|
+
tick: MapTick;
|
|
2017
2017
|
}
|
|
2018
2018
|
/**
|
|
2019
2019
|
* Called after a player changes controller types.
|
|
2020
2020
|
*/
|
|
2021
2021
|
interface on_player_controller_changed {
|
|
2022
2022
|
/**
|
|
2023
|
-
* Identifier of the event
|
|
2023
|
+
* Identifier of the event.
|
|
2024
2024
|
*/
|
|
2025
2025
|
name: defines.events;
|
|
2026
2026
|
/**
|
|
@@ -2034,7 +2034,7 @@ interface on_player_controller_changed {
|
|
|
2034
2034
|
/**
|
|
2035
2035
|
* Tick the event was generated.
|
|
2036
2036
|
*/
|
|
2037
|
-
tick:
|
|
2037
|
+
tick: MapTick;
|
|
2038
2038
|
}
|
|
2039
2039
|
/**
|
|
2040
2040
|
* Called when the player finishes crafting an item. This event fires just before the results are inserted into the player's inventory, not when the crafting is queued (see {@link on_pre_player_crafted_item | runtime:on_pre_player_crafted_item}).
|
|
@@ -2045,7 +2045,7 @@ interface on_player_crafted_item {
|
|
|
2045
2045
|
*/
|
|
2046
2046
|
item_stack: LuaItemStack;
|
|
2047
2047
|
/**
|
|
2048
|
-
* Identifier of the event
|
|
2048
|
+
* Identifier of the event.
|
|
2049
2049
|
*/
|
|
2050
2050
|
name: defines.events;
|
|
2051
2051
|
/**
|
|
@@ -2059,21 +2059,21 @@ interface on_player_crafted_item {
|
|
|
2059
2059
|
/**
|
|
2060
2060
|
* Tick the event was generated.
|
|
2061
2061
|
*/
|
|
2062
|
-
tick:
|
|
2062
|
+
tick: MapTick;
|
|
2063
2063
|
}
|
|
2064
2064
|
/**
|
|
2065
2065
|
* Called after the player was created.
|
|
2066
2066
|
*/
|
|
2067
2067
|
interface on_player_created {
|
|
2068
2068
|
/**
|
|
2069
|
-
* Identifier of the event
|
|
2069
|
+
* Identifier of the event.
|
|
2070
2070
|
*/
|
|
2071
2071
|
name: defines.events;
|
|
2072
2072
|
player_index: uint32;
|
|
2073
2073
|
/**
|
|
2074
2074
|
* Tick the event was generated.
|
|
2075
2075
|
*/
|
|
2076
|
-
tick:
|
|
2076
|
+
tick: MapTick;
|
|
2077
2077
|
}
|
|
2078
2078
|
/**
|
|
2079
2079
|
* Called after a player's {@link cursor stack | runtime:LuaControl::cursor_stack} changed in some way.
|
|
@@ -2082,14 +2082,14 @@ interface on_player_created {
|
|
|
2082
2082
|
*/
|
|
2083
2083
|
interface on_player_cursor_stack_changed {
|
|
2084
2084
|
/**
|
|
2085
|
-
* Identifier of the event
|
|
2085
|
+
* Identifier of the event.
|
|
2086
2086
|
*/
|
|
2087
2087
|
name: defines.events;
|
|
2088
2088
|
player_index: uint32;
|
|
2089
2089
|
/**
|
|
2090
2090
|
* Tick the event was generated.
|
|
2091
2091
|
*/
|
|
2092
|
-
tick:
|
|
2092
|
+
tick: MapTick;
|
|
2093
2093
|
}
|
|
2094
2094
|
/**
|
|
2095
2095
|
* Called when a player selects an area with a deconstruction planner.
|
|
@@ -2108,7 +2108,7 @@ interface on_player_deconstructed_area {
|
|
|
2108
2108
|
*/
|
|
2109
2109
|
item: string;
|
|
2110
2110
|
/**
|
|
2111
|
-
* Identifier of the event
|
|
2111
|
+
* Identifier of the event.
|
|
2112
2112
|
*/
|
|
2113
2113
|
name: defines.events;
|
|
2114
2114
|
/**
|
|
@@ -2134,14 +2134,14 @@ interface on_player_deconstructed_area {
|
|
|
2134
2134
|
/**
|
|
2135
2135
|
* Tick the event was generated.
|
|
2136
2136
|
*/
|
|
2137
|
-
tick:
|
|
2137
|
+
tick: MapTick;
|
|
2138
2138
|
}
|
|
2139
2139
|
/**
|
|
2140
2140
|
* Called when a player is demoted.
|
|
2141
2141
|
*/
|
|
2142
2142
|
interface on_player_demoted {
|
|
2143
2143
|
/**
|
|
2144
|
-
* Identifier of the event
|
|
2144
|
+
* Identifier of the event.
|
|
2145
2145
|
*/
|
|
2146
2146
|
name: defines.events;
|
|
2147
2147
|
/**
|
|
@@ -2151,7 +2151,7 @@ interface on_player_demoted {
|
|
|
2151
2151
|
/**
|
|
2152
2152
|
* Tick the event was generated.
|
|
2153
2153
|
*/
|
|
2154
|
-
tick:
|
|
2154
|
+
tick: MapTick;
|
|
2155
2155
|
}
|
|
2156
2156
|
/**
|
|
2157
2157
|
* Called after a player dies.
|
|
@@ -2159,21 +2159,21 @@ interface on_player_demoted {
|
|
|
2159
2159
|
interface on_player_died {
|
|
2160
2160
|
cause?: LuaEntity;
|
|
2161
2161
|
/**
|
|
2162
|
-
* Identifier of the event
|
|
2162
|
+
* Identifier of the event.
|
|
2163
2163
|
*/
|
|
2164
2164
|
name: defines.events;
|
|
2165
2165
|
player_index: uint32;
|
|
2166
2166
|
/**
|
|
2167
2167
|
* Tick the event was generated.
|
|
2168
2168
|
*/
|
|
2169
|
-
tick:
|
|
2169
|
+
tick: MapTick;
|
|
2170
2170
|
}
|
|
2171
2171
|
/**
|
|
2172
2172
|
* Called when the display density scale changes for a given player. The display density scale is the scale value automatically applied based on the player's display DPI. This is only relevant on platforms that support high-density displays.
|
|
2173
2173
|
*/
|
|
2174
2174
|
interface on_player_display_density_scale_changed {
|
|
2175
2175
|
/**
|
|
2176
|
-
* Identifier of the event
|
|
2176
|
+
* Identifier of the event.
|
|
2177
2177
|
*/
|
|
2178
2178
|
name: defines.events;
|
|
2179
2179
|
/**
|
|
@@ -2187,14 +2187,14 @@ interface on_player_display_density_scale_changed {
|
|
|
2187
2187
|
/**
|
|
2188
2188
|
* Tick the event was generated.
|
|
2189
2189
|
*/
|
|
2190
|
-
tick:
|
|
2190
|
+
tick: MapTick;
|
|
2191
2191
|
}
|
|
2192
2192
|
/**
|
|
2193
2193
|
* Called when the display resolution changes for a given player.
|
|
2194
2194
|
*/
|
|
2195
2195
|
interface on_player_display_resolution_changed {
|
|
2196
2196
|
/**
|
|
2197
|
-
* Identifier of the event
|
|
2197
|
+
* Identifier of the event.
|
|
2198
2198
|
*/
|
|
2199
2199
|
name: defines.events;
|
|
2200
2200
|
/**
|
|
@@ -2208,14 +2208,14 @@ interface on_player_display_resolution_changed {
|
|
|
2208
2208
|
/**
|
|
2209
2209
|
* Tick the event was generated.
|
|
2210
2210
|
*/
|
|
2211
|
-
tick:
|
|
2211
|
+
tick: MapTick;
|
|
2212
2212
|
}
|
|
2213
2213
|
/**
|
|
2214
2214
|
* Called when the display scale changes for a given player.
|
|
2215
2215
|
*/
|
|
2216
2216
|
interface on_player_display_scale_changed {
|
|
2217
2217
|
/**
|
|
2218
|
-
* Identifier of the event
|
|
2218
|
+
* Identifier of the event.
|
|
2219
2219
|
*/
|
|
2220
2220
|
name: defines.events;
|
|
2221
2221
|
/**
|
|
@@ -2229,7 +2229,7 @@ interface on_player_display_scale_changed {
|
|
|
2229
2229
|
/**
|
|
2230
2230
|
* Tick the event was generated.
|
|
2231
2231
|
*/
|
|
2232
|
-
tick:
|
|
2232
|
+
tick: MapTick;
|
|
2233
2233
|
}
|
|
2234
2234
|
/**
|
|
2235
2235
|
* Called when the player's driving state has changed, meaning a player has either entered or left a vehicle.
|
|
@@ -2242,14 +2242,14 @@ interface on_player_driving_changed_state {
|
|
|
2242
2242
|
*/
|
|
2243
2243
|
entity?: LuaEntity;
|
|
2244
2244
|
/**
|
|
2245
|
-
* Identifier of the event
|
|
2245
|
+
* Identifier of the event.
|
|
2246
2246
|
*/
|
|
2247
2247
|
name: defines.events;
|
|
2248
2248
|
player_index: uint32;
|
|
2249
2249
|
/**
|
|
2250
2250
|
* Tick the event was generated.
|
|
2251
2251
|
*/
|
|
2252
|
-
tick:
|
|
2252
|
+
tick: MapTick;
|
|
2253
2253
|
}
|
|
2254
2254
|
/**
|
|
2255
2255
|
* Called when a player drops an item on the ground.
|
|
@@ -2260,14 +2260,14 @@ interface on_player_dropped_item {
|
|
|
2260
2260
|
*/
|
|
2261
2261
|
entity: LuaEntity;
|
|
2262
2262
|
/**
|
|
2263
|
-
* Identifier of the event
|
|
2263
|
+
* Identifier of the event.
|
|
2264
2264
|
*/
|
|
2265
2265
|
name: defines.events;
|
|
2266
2266
|
player_index: uint32;
|
|
2267
2267
|
/**
|
|
2268
2268
|
* Tick the event was generated.
|
|
2269
2269
|
*/
|
|
2270
|
-
tick:
|
|
2270
|
+
tick: MapTick;
|
|
2271
2271
|
}
|
|
2272
2272
|
/**
|
|
2273
2273
|
* Called when a player drops a single item into an entity.
|
|
@@ -2278,14 +2278,14 @@ interface on_player_dropped_item_into_entity {
|
|
|
2278
2278
|
*/
|
|
2279
2279
|
entity: LuaEntity;
|
|
2280
2280
|
/**
|
|
2281
|
-
* Identifier of the event
|
|
2281
|
+
* Identifier of the event.
|
|
2282
2282
|
*/
|
|
2283
2283
|
name: defines.events;
|
|
2284
2284
|
player_index: uint32;
|
|
2285
2285
|
/**
|
|
2286
2286
|
* Tick the event was generated.
|
|
2287
2287
|
*/
|
|
2288
|
-
tick:
|
|
2288
|
+
tick: MapTick;
|
|
2289
2289
|
}
|
|
2290
2290
|
/**
|
|
2291
2291
|
* Called when a player fast-transfers something to or from an entity.
|
|
@@ -2304,7 +2304,7 @@ interface on_player_fast_transferred {
|
|
|
2304
2304
|
*/
|
|
2305
2305
|
is_split: boolean;
|
|
2306
2306
|
/**
|
|
2307
|
-
* Identifier of the event
|
|
2307
|
+
* Identifier of the event.
|
|
2308
2308
|
*/
|
|
2309
2309
|
name: defines.events;
|
|
2310
2310
|
/**
|
|
@@ -2314,7 +2314,7 @@ interface on_player_fast_transferred {
|
|
|
2314
2314
|
/**
|
|
2315
2315
|
* Tick the event was generated.
|
|
2316
2316
|
*/
|
|
2317
|
-
tick:
|
|
2317
|
+
tick: MapTick;
|
|
2318
2318
|
}
|
|
2319
2319
|
/**
|
|
2320
2320
|
* Called when the player flips an entity. This event is only fired when the entity actually changes its orientation or mirroring, so it won't be triggered when pressing the flip keys on an entity that can't be flipped.
|
|
@@ -2331,14 +2331,14 @@ interface on_player_flipped_entity {
|
|
|
2331
2331
|
*/
|
|
2332
2332
|
horizontal: boolean;
|
|
2333
2333
|
/**
|
|
2334
|
-
* Identifier of the event
|
|
2334
|
+
* Identifier of the event.
|
|
2335
2335
|
*/
|
|
2336
2336
|
name: defines.events;
|
|
2337
2337
|
player_index: uint32;
|
|
2338
2338
|
/**
|
|
2339
2339
|
* Tick the event was generated.
|
|
2340
2340
|
*/
|
|
2341
|
-
tick:
|
|
2341
|
+
tick: MapTick;
|
|
2342
2342
|
}
|
|
2343
2343
|
/**
|
|
2344
2344
|
* Called after player flushed fluid
|
|
@@ -2357,7 +2357,7 @@ interface on_player_flushed_fluid {
|
|
|
2357
2357
|
*/
|
|
2358
2358
|
fluid: string;
|
|
2359
2359
|
/**
|
|
2360
|
-
* Identifier of the event
|
|
2360
|
+
* Identifier of the event.
|
|
2361
2361
|
*/
|
|
2362
2362
|
name: defines.events;
|
|
2363
2363
|
/**
|
|
@@ -2371,28 +2371,28 @@ interface on_player_flushed_fluid {
|
|
|
2371
2371
|
/**
|
|
2372
2372
|
* Tick the event was generated.
|
|
2373
2373
|
*/
|
|
2374
|
-
tick:
|
|
2374
|
+
tick: MapTick;
|
|
2375
2375
|
}
|
|
2376
2376
|
/**
|
|
2377
2377
|
* Called after a players gun inventory changed in some way.
|
|
2378
2378
|
*/
|
|
2379
2379
|
interface on_player_gun_inventory_changed {
|
|
2380
2380
|
/**
|
|
2381
|
-
* Identifier of the event
|
|
2381
|
+
* Identifier of the event.
|
|
2382
2382
|
*/
|
|
2383
2383
|
name: defines.events;
|
|
2384
2384
|
player_index: uint32;
|
|
2385
2385
|
/**
|
|
2386
2386
|
* Tick the event was generated.
|
|
2387
2387
|
*/
|
|
2388
|
-
tick:
|
|
2388
|
+
tick: MapTick;
|
|
2389
2389
|
}
|
|
2390
2390
|
/**
|
|
2391
2391
|
* Called when a player's input method changes. See {@link LuaPlayer::input_method | runtime:LuaPlayer::input_method}.
|
|
2392
2392
|
*/
|
|
2393
2393
|
interface on_player_input_method_changed {
|
|
2394
2394
|
/**
|
|
2395
|
-
* Identifier of the event
|
|
2395
|
+
* Identifier of the event.
|
|
2396
2396
|
*/
|
|
2397
2397
|
name: defines.events;
|
|
2398
2398
|
/**
|
|
@@ -2402,21 +2402,21 @@ interface on_player_input_method_changed {
|
|
|
2402
2402
|
/**
|
|
2403
2403
|
* Tick the event was generated.
|
|
2404
2404
|
*/
|
|
2405
|
-
tick:
|
|
2405
|
+
tick: MapTick;
|
|
2406
2406
|
}
|
|
2407
2407
|
/**
|
|
2408
2408
|
* Called after a player joins the game. This is not called when loading a save file in singleplayer, as the player doesn't actually leave the game, and the save is just on pause until they rejoin.
|
|
2409
2409
|
*/
|
|
2410
2410
|
interface on_player_joined_game {
|
|
2411
2411
|
/**
|
|
2412
|
-
* Identifier of the event
|
|
2412
|
+
* Identifier of the event.
|
|
2413
2413
|
*/
|
|
2414
2414
|
name: defines.events;
|
|
2415
2415
|
player_index: uint32;
|
|
2416
2416
|
/**
|
|
2417
2417
|
* Tick the event was generated.
|
|
2418
2418
|
*/
|
|
2419
|
-
tick:
|
|
2419
|
+
tick: MapTick;
|
|
2420
2420
|
}
|
|
2421
2421
|
/**
|
|
2422
2422
|
* Called when a player is kicked.
|
|
@@ -2427,7 +2427,7 @@ interface on_player_kicked {
|
|
|
2427
2427
|
*/
|
|
2428
2428
|
by_player?: uint32;
|
|
2429
2429
|
/**
|
|
2430
|
-
* Identifier of the event
|
|
2430
|
+
* Identifier of the event.
|
|
2431
2431
|
*/
|
|
2432
2432
|
name: defines.events;
|
|
2433
2433
|
/**
|
|
@@ -2441,14 +2441,14 @@ interface on_player_kicked {
|
|
|
2441
2441
|
/**
|
|
2442
2442
|
* Tick the event was generated.
|
|
2443
2443
|
*/
|
|
2444
|
-
tick:
|
|
2444
|
+
tick: MapTick;
|
|
2445
2445
|
}
|
|
2446
2446
|
/**
|
|
2447
2447
|
* Called after a player leaves the game. This is not called when closing a save file in singleplayer, as the player doesn't actually leave the game, and the save is just on pause until they rejoin.
|
|
2448
2448
|
*/
|
|
2449
2449
|
interface on_player_left_game {
|
|
2450
2450
|
/**
|
|
2451
|
-
* Identifier of the event
|
|
2451
|
+
* Identifier of the event.
|
|
2452
2452
|
*/
|
|
2453
2453
|
name: defines.events;
|
|
2454
2454
|
player_index: uint32;
|
|
@@ -2456,14 +2456,14 @@ interface on_player_left_game {
|
|
|
2456
2456
|
/**
|
|
2457
2457
|
* Tick the event was generated.
|
|
2458
2458
|
*/
|
|
2459
|
-
tick:
|
|
2459
|
+
tick: MapTick;
|
|
2460
2460
|
}
|
|
2461
2461
|
/**
|
|
2462
2462
|
* Called when a player's active locale changes. See {@link LuaPlayer::locale | runtime:LuaPlayer::locale}.
|
|
2463
2463
|
*/
|
|
2464
2464
|
interface on_player_locale_changed {
|
|
2465
2465
|
/**
|
|
2466
|
-
* Identifier of the event
|
|
2466
|
+
* Identifier of the event.
|
|
2467
2467
|
*/
|
|
2468
2468
|
name: defines.events;
|
|
2469
2469
|
/**
|
|
@@ -2477,21 +2477,21 @@ interface on_player_locale_changed {
|
|
|
2477
2477
|
/**
|
|
2478
2478
|
* Tick the event was generated.
|
|
2479
2479
|
*/
|
|
2480
|
-
tick:
|
|
2480
|
+
tick: MapTick;
|
|
2481
2481
|
}
|
|
2482
2482
|
/**
|
|
2483
2483
|
* Called after a players main inventory changed in some way.
|
|
2484
2484
|
*/
|
|
2485
2485
|
interface on_player_main_inventory_changed {
|
|
2486
2486
|
/**
|
|
2487
|
-
* Identifier of the event
|
|
2487
|
+
* Identifier of the event.
|
|
2488
2488
|
*/
|
|
2489
2489
|
name: defines.events;
|
|
2490
2490
|
player_index: uint32;
|
|
2491
2491
|
/**
|
|
2492
2492
|
* Tick the event was generated.
|
|
2493
2493
|
*/
|
|
2494
|
-
tick:
|
|
2494
|
+
tick: MapTick;
|
|
2495
2495
|
}
|
|
2496
2496
|
/**
|
|
2497
2497
|
* Called after the results of an entity being mined are collected just before the entity is destroyed.
|
|
@@ -2510,7 +2510,7 @@ interface on_player_mined_entity {
|
|
|
2510
2510
|
*/
|
|
2511
2511
|
entity: LuaEntity;
|
|
2512
2512
|
/**
|
|
2513
|
-
* Identifier of the event
|
|
2513
|
+
* Identifier of the event.
|
|
2514
2514
|
*/
|
|
2515
2515
|
name: defines.events;
|
|
2516
2516
|
/**
|
|
@@ -2520,7 +2520,7 @@ interface on_player_mined_entity {
|
|
|
2520
2520
|
/**
|
|
2521
2521
|
* Tick the event was generated.
|
|
2522
2522
|
*/
|
|
2523
|
-
tick:
|
|
2523
|
+
tick: MapTick;
|
|
2524
2524
|
}
|
|
2525
2525
|
/**
|
|
2526
2526
|
* Called when the player mines something.
|
|
@@ -2531,21 +2531,21 @@ interface on_player_mined_item {
|
|
|
2531
2531
|
*/
|
|
2532
2532
|
item_stack: ItemWithQualityCount;
|
|
2533
2533
|
/**
|
|
2534
|
-
* Identifier of the event
|
|
2534
|
+
* Identifier of the event.
|
|
2535
2535
|
*/
|
|
2536
2536
|
name: defines.events;
|
|
2537
2537
|
player_index: uint32;
|
|
2538
2538
|
/**
|
|
2539
2539
|
* Tick the event was generated.
|
|
2540
2540
|
*/
|
|
2541
|
-
tick:
|
|
2541
|
+
tick: MapTick;
|
|
2542
2542
|
}
|
|
2543
2543
|
/**
|
|
2544
2544
|
* Called after a player mines tiles.
|
|
2545
2545
|
*/
|
|
2546
2546
|
interface on_player_mined_tile {
|
|
2547
2547
|
/**
|
|
2548
|
-
* Identifier of the event
|
|
2548
|
+
* Identifier of the event.
|
|
2549
2549
|
*/
|
|
2550
2550
|
name: defines.events;
|
|
2551
2551
|
player_index: uint32;
|
|
@@ -2556,7 +2556,7 @@ interface on_player_mined_tile {
|
|
|
2556
2556
|
/**
|
|
2557
2557
|
* Tick the event was generated.
|
|
2558
2558
|
*/
|
|
2559
|
-
tick:
|
|
2559
|
+
tick: MapTick;
|
|
2560
2560
|
/**
|
|
2561
2561
|
* The position data.
|
|
2562
2562
|
*/
|
|
@@ -2567,7 +2567,7 @@ interface on_player_mined_tile {
|
|
|
2567
2567
|
*/
|
|
2568
2568
|
interface on_player_muted {
|
|
2569
2569
|
/**
|
|
2570
|
-
* Identifier of the event
|
|
2570
|
+
* Identifier of the event.
|
|
2571
2571
|
*/
|
|
2572
2572
|
name: defines.events;
|
|
2573
2573
|
/**
|
|
@@ -2577,7 +2577,7 @@ interface on_player_muted {
|
|
|
2577
2577
|
/**
|
|
2578
2578
|
* Tick the event was generated.
|
|
2579
2579
|
*/
|
|
2580
|
-
tick:
|
|
2580
|
+
tick: MapTick;
|
|
2581
2581
|
}
|
|
2582
2582
|
/**
|
|
2583
2583
|
* Called when a player invokes the "smart pipette" over an entity.
|
|
@@ -2588,7 +2588,7 @@ interface on_player_pipette {
|
|
|
2588
2588
|
*/
|
|
2589
2589
|
item: LuaItemPrototype;
|
|
2590
2590
|
/**
|
|
2591
|
-
* Identifier of the event
|
|
2591
|
+
* Identifier of the event.
|
|
2592
2592
|
*/
|
|
2593
2593
|
name: defines.events;
|
|
2594
2594
|
/**
|
|
@@ -2602,7 +2602,7 @@ interface on_player_pipette {
|
|
|
2602
2602
|
/**
|
|
2603
2603
|
* Tick the event was generated.
|
|
2604
2604
|
*/
|
|
2605
|
-
tick:
|
|
2605
|
+
tick: MapTick;
|
|
2606
2606
|
/**
|
|
2607
2607
|
* If cheat mode was used to give a free stack of the item.
|
|
2608
2608
|
*/
|
|
@@ -2621,21 +2621,21 @@ interface on_player_placed_equipment {
|
|
|
2621
2621
|
*/
|
|
2622
2622
|
grid: LuaEquipmentGrid;
|
|
2623
2623
|
/**
|
|
2624
|
-
* Identifier of the event
|
|
2624
|
+
* Identifier of the event.
|
|
2625
2625
|
*/
|
|
2626
2626
|
name: defines.events;
|
|
2627
2627
|
player_index: uint32;
|
|
2628
2628
|
/**
|
|
2629
2629
|
* Tick the event was generated.
|
|
2630
2630
|
*/
|
|
2631
|
-
tick:
|
|
2631
|
+
tick: MapTick;
|
|
2632
2632
|
}
|
|
2633
2633
|
/**
|
|
2634
2634
|
* Called when a player is promoted.
|
|
2635
2635
|
*/
|
|
2636
2636
|
interface on_player_promoted {
|
|
2637
2637
|
/**
|
|
2638
|
-
* Identifier of the event
|
|
2638
|
+
* Identifier of the event.
|
|
2639
2639
|
*/
|
|
2640
2640
|
name: defines.events;
|
|
2641
2641
|
/**
|
|
@@ -2645,14 +2645,14 @@ interface on_player_promoted {
|
|
|
2645
2645
|
/**
|
|
2646
2646
|
* Tick the event was generated.
|
|
2647
2647
|
*/
|
|
2648
|
-
tick:
|
|
2648
|
+
tick: MapTick;
|
|
2649
2649
|
}
|
|
2650
2650
|
/**
|
|
2651
2651
|
* Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | runtime:on_player_left_game} the game, and instead behaves like the player never existed in the save file.
|
|
2652
2652
|
*/
|
|
2653
2653
|
interface on_player_removed {
|
|
2654
2654
|
/**
|
|
2655
|
-
* Identifier of the event
|
|
2655
|
+
* Identifier of the event.
|
|
2656
2656
|
*/
|
|
2657
2657
|
name: defines.events;
|
|
2658
2658
|
/**
|
|
@@ -2662,7 +2662,7 @@ interface on_player_removed {
|
|
|
2662
2662
|
/**
|
|
2663
2663
|
* Tick the event was generated.
|
|
2664
2664
|
*/
|
|
2665
|
-
tick:
|
|
2665
|
+
tick: MapTick;
|
|
2666
2666
|
}
|
|
2667
2667
|
/**
|
|
2668
2668
|
* Called after the player removes equipment from an equipment grid
|
|
@@ -2681,7 +2681,7 @@ interface on_player_removed_equipment {
|
|
|
2681
2681
|
*/
|
|
2682
2682
|
grid: LuaEquipmentGrid;
|
|
2683
2683
|
/**
|
|
2684
|
-
* Identifier of the event
|
|
2684
|
+
* Identifier of the event.
|
|
2685
2685
|
*/
|
|
2686
2686
|
name: defines.events;
|
|
2687
2687
|
player_index: uint32;
|
|
@@ -2692,7 +2692,7 @@ interface on_player_removed_equipment {
|
|
|
2692
2692
|
/**
|
|
2693
2693
|
* Tick the event was generated.
|
|
2694
2694
|
*/
|
|
2695
|
-
tick:
|
|
2695
|
+
tick: MapTick;
|
|
2696
2696
|
}
|
|
2697
2697
|
/**
|
|
2698
2698
|
* Called when a player repairs an entity.
|
|
@@ -2700,21 +2700,21 @@ interface on_player_removed_equipment {
|
|
|
2700
2700
|
interface on_player_repaired_entity {
|
|
2701
2701
|
entity: LuaEntity;
|
|
2702
2702
|
/**
|
|
2703
|
-
* Identifier of the event
|
|
2703
|
+
* Identifier of the event.
|
|
2704
2704
|
*/
|
|
2705
2705
|
name: defines.events;
|
|
2706
2706
|
player_index: uint32;
|
|
2707
2707
|
/**
|
|
2708
2708
|
* Tick the event was generated.
|
|
2709
2709
|
*/
|
|
2710
|
-
tick:
|
|
2710
|
+
tick: MapTick;
|
|
2711
2711
|
}
|
|
2712
2712
|
/**
|
|
2713
2713
|
* Called after a player respawns.
|
|
2714
2714
|
*/
|
|
2715
2715
|
interface on_player_respawned {
|
|
2716
2716
|
/**
|
|
2717
|
-
* Identifier of the event
|
|
2717
|
+
* Identifier of the event.
|
|
2718
2718
|
*/
|
|
2719
2719
|
name: defines.events;
|
|
2720
2720
|
player_index: uint32;
|
|
@@ -2725,7 +2725,7 @@ interface on_player_respawned {
|
|
|
2725
2725
|
/**
|
|
2726
2726
|
* Tick the event was generated.
|
|
2727
2727
|
*/
|
|
2728
|
-
tick:
|
|
2728
|
+
tick: MapTick;
|
|
2729
2729
|
}
|
|
2730
2730
|
/**
|
|
2731
2731
|
* Called after a player reverse-selects an area with a selection-tool item.
|
|
@@ -2744,7 +2744,7 @@ interface on_player_reverse_selected_area {
|
|
|
2744
2744
|
*/
|
|
2745
2745
|
item: string;
|
|
2746
2746
|
/**
|
|
2747
|
-
* Identifier of the event
|
|
2747
|
+
* Identifier of the event.
|
|
2748
2748
|
*/
|
|
2749
2749
|
name: defines.events;
|
|
2750
2750
|
/**
|
|
@@ -2758,7 +2758,7 @@ interface on_player_reverse_selected_area {
|
|
|
2758
2758
|
/**
|
|
2759
2759
|
* Tick the event was generated.
|
|
2760
2760
|
*/
|
|
2761
|
-
tick:
|
|
2761
|
+
tick: MapTick;
|
|
2762
2762
|
/**
|
|
2763
2763
|
* The tiles selected.
|
|
2764
2764
|
*/
|
|
@@ -2775,7 +2775,7 @@ interface on_player_rotated_entity {
|
|
|
2775
2775
|
*/
|
|
2776
2776
|
entity: LuaEntity;
|
|
2777
2777
|
/**
|
|
2778
|
-
* Identifier of the event
|
|
2778
|
+
* Identifier of the event.
|
|
2779
2779
|
*/
|
|
2780
2780
|
name: defines.events;
|
|
2781
2781
|
player_index: uint32;
|
|
@@ -2786,7 +2786,7 @@ interface on_player_rotated_entity {
|
|
|
2786
2786
|
/**
|
|
2787
2787
|
* Tick the event was generated.
|
|
2788
2788
|
*/
|
|
2789
|
-
tick:
|
|
2789
|
+
tick: MapTick;
|
|
2790
2790
|
}
|
|
2791
2791
|
/**
|
|
2792
2792
|
* Called after a player selects an area with a selection-tool item.
|
|
@@ -2805,7 +2805,7 @@ interface on_player_selected_area {
|
|
|
2805
2805
|
*/
|
|
2806
2806
|
item: string;
|
|
2807
2807
|
/**
|
|
2808
|
-
* Identifier of the event
|
|
2808
|
+
* Identifier of the event.
|
|
2809
2809
|
*/
|
|
2810
2810
|
name: defines.events;
|
|
2811
2811
|
/**
|
|
@@ -2823,7 +2823,7 @@ interface on_player_selected_area {
|
|
|
2823
2823
|
/**
|
|
2824
2824
|
* Tick the event was generated.
|
|
2825
2825
|
*/
|
|
2826
|
-
tick:
|
|
2826
|
+
tick: MapTick;
|
|
2827
2827
|
/**
|
|
2828
2828
|
* The tiles selected.
|
|
2829
2829
|
*/
|
|
@@ -2834,14 +2834,14 @@ interface on_player_selected_area {
|
|
|
2834
2834
|
*/
|
|
2835
2835
|
interface on_player_set_quick_bar_slot {
|
|
2836
2836
|
/**
|
|
2837
|
-
* Identifier of the event
|
|
2837
|
+
* Identifier of the event.
|
|
2838
2838
|
*/
|
|
2839
2839
|
name: defines.events;
|
|
2840
2840
|
player_index: uint32;
|
|
2841
2841
|
/**
|
|
2842
2842
|
* Tick the event was generated.
|
|
2843
2843
|
*/
|
|
2844
|
-
tick:
|
|
2844
|
+
tick: MapTick;
|
|
2845
2845
|
}
|
|
2846
2846
|
/**
|
|
2847
2847
|
* Called when a player selects an area with a blueprint.
|
|
@@ -2864,7 +2864,7 @@ interface on_player_setup_blueprint {
|
|
|
2864
2864
|
*/
|
|
2865
2865
|
mapping: LuaLazyLoadedValue<LuaTable<uint32, LuaEntity>>;
|
|
2866
2866
|
/**
|
|
2867
|
-
* Identifier of the event
|
|
2867
|
+
* Identifier of the event.
|
|
2868
2868
|
*/
|
|
2869
2869
|
name: defines.events;
|
|
2870
2870
|
/**
|
|
@@ -2876,7 +2876,7 @@ interface on_player_setup_blueprint {
|
|
|
2876
2876
|
*/
|
|
2877
2877
|
quality: string;
|
|
2878
2878
|
/**
|
|
2879
|
-
* The record that is being reassigned.
|
|
2879
|
+
* The record that is being reassigned. This blueprint record is writable even if it is in the "my blueprints" shelf.
|
|
2880
2880
|
*/
|
|
2881
2881
|
record?: LuaRecord;
|
|
2882
2882
|
/**
|
|
@@ -2890,7 +2890,7 @@ interface on_player_setup_blueprint {
|
|
|
2890
2890
|
/**
|
|
2891
2891
|
* Tick the event was generated.
|
|
2892
2892
|
*/
|
|
2893
|
-
tick:
|
|
2893
|
+
tick: MapTick;
|
|
2894
2894
|
}
|
|
2895
2895
|
/**
|
|
2896
2896
|
* Called when a player toggles alt mode, also known as "show entity info".
|
|
@@ -2901,42 +2901,42 @@ interface on_player_toggled_alt_mode {
|
|
|
2901
2901
|
*/
|
|
2902
2902
|
alt_mode: boolean;
|
|
2903
2903
|
/**
|
|
2904
|
-
* Identifier of the event
|
|
2904
|
+
* Identifier of the event.
|
|
2905
2905
|
*/
|
|
2906
2906
|
name: defines.events;
|
|
2907
2907
|
player_index: uint32;
|
|
2908
2908
|
/**
|
|
2909
2909
|
* Tick the event was generated.
|
|
2910
2910
|
*/
|
|
2911
|
-
tick:
|
|
2911
|
+
tick: MapTick;
|
|
2912
2912
|
}
|
|
2913
2913
|
/**
|
|
2914
2914
|
* Called when a player toggles the map editor on or off.
|
|
2915
2915
|
*/
|
|
2916
2916
|
interface on_player_toggled_map_editor {
|
|
2917
2917
|
/**
|
|
2918
|
-
* Identifier of the event
|
|
2918
|
+
* Identifier of the event.
|
|
2919
2919
|
*/
|
|
2920
2920
|
name: defines.events;
|
|
2921
2921
|
player_index: uint32;
|
|
2922
2922
|
/**
|
|
2923
2923
|
* Tick the event was generated.
|
|
2924
2924
|
*/
|
|
2925
|
-
tick:
|
|
2925
|
+
tick: MapTick;
|
|
2926
2926
|
}
|
|
2927
2927
|
/**
|
|
2928
2928
|
* Called after a players trash inventory changed in some way.
|
|
2929
2929
|
*/
|
|
2930
2930
|
interface on_player_trash_inventory_changed {
|
|
2931
2931
|
/**
|
|
2932
|
-
* Identifier of the event
|
|
2932
|
+
* Identifier of the event.
|
|
2933
2933
|
*/
|
|
2934
2934
|
name: defines.events;
|
|
2935
2935
|
player_index: uint32;
|
|
2936
2936
|
/**
|
|
2937
2937
|
* Tick the event was generated.
|
|
2938
2938
|
*/
|
|
2939
|
-
tick:
|
|
2939
|
+
tick: MapTick;
|
|
2940
2940
|
}
|
|
2941
2941
|
/**
|
|
2942
2942
|
* Called when a player is un-banned.
|
|
@@ -2947,7 +2947,7 @@ interface on_player_unbanned {
|
|
|
2947
2947
|
*/
|
|
2948
2948
|
by_player?: uint32;
|
|
2949
2949
|
/**
|
|
2950
|
-
* Identifier of the event
|
|
2950
|
+
* Identifier of the event.
|
|
2951
2951
|
*/
|
|
2952
2952
|
name: defines.events;
|
|
2953
2953
|
/**
|
|
@@ -2965,14 +2965,14 @@ interface on_player_unbanned {
|
|
|
2965
2965
|
/**
|
|
2966
2966
|
* Tick the event was generated.
|
|
2967
2967
|
*/
|
|
2968
|
-
tick:
|
|
2968
|
+
tick: MapTick;
|
|
2969
2969
|
}
|
|
2970
2970
|
/**
|
|
2971
2971
|
* Called when a player is unmuted.
|
|
2972
2972
|
*/
|
|
2973
2973
|
interface on_player_unmuted {
|
|
2974
2974
|
/**
|
|
2975
|
-
* Identifier of the event
|
|
2975
|
+
* Identifier of the event.
|
|
2976
2976
|
*/
|
|
2977
2977
|
name: defines.events;
|
|
2978
2978
|
/**
|
|
@@ -2982,7 +2982,7 @@ interface on_player_unmuted {
|
|
|
2982
2982
|
/**
|
|
2983
2983
|
* Tick the event was generated.
|
|
2984
2984
|
*/
|
|
2985
|
-
tick:
|
|
2985
|
+
tick: MapTick;
|
|
2986
2986
|
}
|
|
2987
2987
|
/**
|
|
2988
2988
|
* Called when a player uses a capsule that results in some game action.
|
|
@@ -2993,7 +2993,7 @@ interface on_player_used_capsule {
|
|
|
2993
2993
|
*/
|
|
2994
2994
|
item: LuaItemPrototype;
|
|
2995
2995
|
/**
|
|
2996
|
-
* Identifier of the event
|
|
2996
|
+
* Identifier of the event.
|
|
2997
2997
|
*/
|
|
2998
2998
|
name: defines.events;
|
|
2999
2999
|
/**
|
|
@@ -3011,14 +3011,14 @@ interface on_player_used_capsule {
|
|
|
3011
3011
|
/**
|
|
3012
3012
|
* Tick the event was generated.
|
|
3013
3013
|
*/
|
|
3014
|
-
tick:
|
|
3014
|
+
tick: MapTick;
|
|
3015
3015
|
}
|
|
3016
3016
|
/**
|
|
3017
3017
|
* Called when a player uses spidertron remote to send all selected units to a given position
|
|
3018
3018
|
*/
|
|
3019
3019
|
interface on_player_used_spidertron_remote {
|
|
3020
3020
|
/**
|
|
3021
|
-
* Identifier of the event
|
|
3021
|
+
* Identifier of the event.
|
|
3022
3022
|
*/
|
|
3023
3023
|
name: defines.events;
|
|
3024
3024
|
/**
|
|
@@ -3032,7 +3032,7 @@ interface on_player_used_spidertron_remote {
|
|
|
3032
3032
|
/**
|
|
3033
3033
|
* Tick the event was generated.
|
|
3034
3034
|
*/
|
|
3035
|
-
tick:
|
|
3035
|
+
tick: MapTick;
|
|
3036
3036
|
}
|
|
3037
3037
|
/**
|
|
3038
3038
|
* Called after an entity dies.
|
|
@@ -3055,7 +3055,7 @@ interface on_post_entity_died {
|
|
|
3055
3055
|
*/
|
|
3056
3056
|
ghost?: LuaEntity;
|
|
3057
3057
|
/**
|
|
3058
|
-
* Identifier of the event
|
|
3058
|
+
* Identifier of the event.
|
|
3059
3059
|
*/
|
|
3060
3060
|
name: defines.events;
|
|
3061
3061
|
/**
|
|
@@ -3077,7 +3077,7 @@ interface on_post_entity_died {
|
|
|
3077
3077
|
/**
|
|
3078
3078
|
* Tick the event was generated.
|
|
3079
3079
|
*/
|
|
3080
|
-
tick:
|
|
3080
|
+
tick: MapTick;
|
|
3081
3081
|
/**
|
|
3082
3082
|
* The unit number the entity had if any.
|
|
3083
3083
|
*/
|
|
@@ -3096,7 +3096,7 @@ interface on_post_segmented_unit_died {
|
|
|
3096
3096
|
*/
|
|
3097
3097
|
force?: LuaForce;
|
|
3098
3098
|
/**
|
|
3099
|
-
* Identifier of the event
|
|
3099
|
+
* Identifier of the event.
|
|
3100
3100
|
*/
|
|
3101
3101
|
name: defines.events;
|
|
3102
3102
|
/**
|
|
@@ -3118,7 +3118,7 @@ interface on_post_segmented_unit_died {
|
|
|
3118
3118
|
/**
|
|
3119
3119
|
* Tick the event was generated.
|
|
3120
3120
|
*/
|
|
3121
|
-
tick:
|
|
3121
|
+
tick: MapTick;
|
|
3122
3122
|
/**
|
|
3123
3123
|
* The unit number of the unit that died.
|
|
3124
3124
|
*/
|
|
@@ -3153,7 +3153,7 @@ interface on_pre_build {
|
|
|
3153
3153
|
*/
|
|
3154
3154
|
mirror: boolean;
|
|
3155
3155
|
/**
|
|
3156
|
-
* Identifier of the event
|
|
3156
|
+
* Identifier of the event.
|
|
3157
3157
|
*/
|
|
3158
3158
|
name: defines.events;
|
|
3159
3159
|
/**
|
|
@@ -3167,14 +3167,14 @@ interface on_pre_build {
|
|
|
3167
3167
|
/**
|
|
3168
3168
|
* Tick the event was generated.
|
|
3169
3169
|
*/
|
|
3170
|
-
tick:
|
|
3170
|
+
tick: MapTick;
|
|
3171
3171
|
}
|
|
3172
3172
|
/**
|
|
3173
3173
|
* Called before one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
|
|
3174
3174
|
*/
|
|
3175
3175
|
interface on_pre_chunk_deleted {
|
|
3176
3176
|
/**
|
|
3177
|
-
* Identifier of the event
|
|
3177
|
+
* Identifier of the event.
|
|
3178
3178
|
*/
|
|
3179
3179
|
name: defines.events;
|
|
3180
3180
|
/**
|
|
@@ -3185,7 +3185,7 @@ interface on_pre_chunk_deleted {
|
|
|
3185
3185
|
/**
|
|
3186
3186
|
* Tick the event was generated.
|
|
3187
3187
|
*/
|
|
3188
|
-
tick:
|
|
3188
|
+
tick: MapTick;
|
|
3189
3189
|
}
|
|
3190
3190
|
/**
|
|
3191
3191
|
* Called before entity copy-paste is done.
|
|
@@ -3196,7 +3196,7 @@ interface on_pre_entity_settings_pasted {
|
|
|
3196
3196
|
*/
|
|
3197
3197
|
destination: LuaEntity;
|
|
3198
3198
|
/**
|
|
3199
|
-
* Identifier of the event
|
|
3199
|
+
* Identifier of the event.
|
|
3200
3200
|
*/
|
|
3201
3201
|
name: defines.events;
|
|
3202
3202
|
player_index: uint32;
|
|
@@ -3207,7 +3207,7 @@ interface on_pre_entity_settings_pasted {
|
|
|
3207
3207
|
/**
|
|
3208
3208
|
* Tick the event was generated.
|
|
3209
3209
|
*/
|
|
3210
|
-
tick:
|
|
3210
|
+
tick: MapTick;
|
|
3211
3211
|
}
|
|
3212
3212
|
/**
|
|
3213
3213
|
* Called before a ghost entity is destroyed as a result of being marked for deconstruction.
|
|
@@ -3217,7 +3217,7 @@ interface on_pre_entity_settings_pasted {
|
|
|
3217
3217
|
interface on_pre_ghost_deconstructed {
|
|
3218
3218
|
ghost: LuaEntity;
|
|
3219
3219
|
/**
|
|
3220
|
-
* Identifier of the event
|
|
3220
|
+
* Identifier of the event.
|
|
3221
3221
|
*/
|
|
3222
3222
|
name: defines.events;
|
|
3223
3223
|
/**
|
|
@@ -3227,7 +3227,7 @@ interface on_pre_ghost_deconstructed {
|
|
|
3227
3227
|
/**
|
|
3228
3228
|
* Tick the event was generated.
|
|
3229
3229
|
*/
|
|
3230
|
-
tick:
|
|
3230
|
+
tick: MapTick;
|
|
3231
3231
|
}
|
|
3232
3232
|
/**
|
|
3233
3233
|
* Called before a ghost entity is upgraded.
|
|
@@ -3235,7 +3235,7 @@ interface on_pre_ghost_deconstructed {
|
|
|
3235
3235
|
interface on_pre_ghost_upgraded {
|
|
3236
3236
|
ghost: LuaEntity;
|
|
3237
3237
|
/**
|
|
3238
|
-
* Identifier of the event
|
|
3238
|
+
* Identifier of the event.
|
|
3239
3239
|
*/
|
|
3240
3240
|
name: defines.events;
|
|
3241
3241
|
/**
|
|
@@ -3247,7 +3247,7 @@ interface on_pre_ghost_upgraded {
|
|
|
3247
3247
|
/**
|
|
3248
3248
|
* Tick the event was generated.
|
|
3249
3249
|
*/
|
|
3250
|
-
tick:
|
|
3250
|
+
tick: MapTick;
|
|
3251
3251
|
}
|
|
3252
3252
|
/**
|
|
3253
3253
|
* Called directly before a permission group is deleted.
|
|
@@ -3258,7 +3258,7 @@ interface on_pre_permission_group_deleted {
|
|
|
3258
3258
|
*/
|
|
3259
3259
|
group: LuaPermissionGroup;
|
|
3260
3260
|
/**
|
|
3261
|
-
* Identifier of the event
|
|
3261
|
+
* Identifier of the event.
|
|
3262
3262
|
*/
|
|
3263
3263
|
name: defines.events;
|
|
3264
3264
|
/**
|
|
@@ -3268,14 +3268,14 @@ interface on_pre_permission_group_deleted {
|
|
|
3268
3268
|
/**
|
|
3269
3269
|
* Tick the event was generated.
|
|
3270
3270
|
*/
|
|
3271
|
-
tick:
|
|
3271
|
+
tick: MapTick;
|
|
3272
3272
|
}
|
|
3273
3273
|
/**
|
|
3274
3274
|
* Called directly before a permission string is imported.
|
|
3275
3275
|
*/
|
|
3276
3276
|
interface on_pre_permission_string_imported {
|
|
3277
3277
|
/**
|
|
3278
|
-
* Identifier of the event
|
|
3278
|
+
* Identifier of the event.
|
|
3279
3279
|
*/
|
|
3280
3280
|
name: defines.events;
|
|
3281
3281
|
/**
|
|
@@ -3285,7 +3285,7 @@ interface on_pre_permission_string_imported {
|
|
|
3285
3285
|
/**
|
|
3286
3286
|
* Tick the event was generated.
|
|
3287
3287
|
*/
|
|
3288
|
-
tick:
|
|
3288
|
+
tick: MapTick;
|
|
3289
3289
|
}
|
|
3290
3290
|
/**
|
|
3291
3291
|
* Called when a player queues something to be crafted.
|
|
@@ -3296,7 +3296,7 @@ interface on_pre_player_crafted_item {
|
|
|
3296
3296
|
*/
|
|
3297
3297
|
items: LuaInventory;
|
|
3298
3298
|
/**
|
|
3299
|
-
* Identifier of the event
|
|
3299
|
+
* Identifier of the event.
|
|
3300
3300
|
*/
|
|
3301
3301
|
name: defines.events;
|
|
3302
3302
|
/**
|
|
@@ -3314,7 +3314,7 @@ interface on_pre_player_crafted_item {
|
|
|
3314
3314
|
/**
|
|
3315
3315
|
* Tick the event was generated.
|
|
3316
3316
|
*/
|
|
3317
|
-
tick:
|
|
3317
|
+
tick: MapTick;
|
|
3318
3318
|
}
|
|
3319
3319
|
/**
|
|
3320
3320
|
* Called before a players dies.
|
|
@@ -3322,21 +3322,21 @@ interface on_pre_player_crafted_item {
|
|
|
3322
3322
|
interface on_pre_player_died {
|
|
3323
3323
|
cause?: LuaEntity;
|
|
3324
3324
|
/**
|
|
3325
|
-
* Identifier of the event
|
|
3325
|
+
* Identifier of the event.
|
|
3326
3326
|
*/
|
|
3327
3327
|
name: defines.events;
|
|
3328
3328
|
player_index: uint32;
|
|
3329
3329
|
/**
|
|
3330
3330
|
* Tick the event was generated.
|
|
3331
3331
|
*/
|
|
3332
|
-
tick:
|
|
3332
|
+
tick: MapTick;
|
|
3333
3333
|
}
|
|
3334
3334
|
/**
|
|
3335
3335
|
* Called before a player leaves the game.
|
|
3336
3336
|
*/
|
|
3337
3337
|
interface on_pre_player_left_game {
|
|
3338
3338
|
/**
|
|
3339
|
-
* Identifier of the event
|
|
3339
|
+
* Identifier of the event.
|
|
3340
3340
|
*/
|
|
3341
3341
|
name: defines.events;
|
|
3342
3342
|
player_index: uint32;
|
|
@@ -3344,7 +3344,7 @@ interface on_pre_player_left_game {
|
|
|
3344
3344
|
/**
|
|
3345
3345
|
* Tick the event was generated.
|
|
3346
3346
|
*/
|
|
3347
|
-
tick:
|
|
3347
|
+
tick: MapTick;
|
|
3348
3348
|
}
|
|
3349
3349
|
/**
|
|
3350
3350
|
* Called when the player completes a mining action, but before the entity is potentially removed from the map. This is called even if the entity does not end up being removed.
|
|
@@ -3355,21 +3355,21 @@ interface on_pre_player_mined_item {
|
|
|
3355
3355
|
*/
|
|
3356
3356
|
entity: LuaEntity;
|
|
3357
3357
|
/**
|
|
3358
|
-
* Identifier of the event
|
|
3358
|
+
* Identifier of the event.
|
|
3359
3359
|
*/
|
|
3360
3360
|
name: defines.events;
|
|
3361
3361
|
player_index: uint32;
|
|
3362
3362
|
/**
|
|
3363
3363
|
* Tick the event was generated.
|
|
3364
3364
|
*/
|
|
3365
|
-
tick:
|
|
3365
|
+
tick: MapTick;
|
|
3366
3366
|
}
|
|
3367
3367
|
/**
|
|
3368
3368
|
* Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | runtime:on_player_left_game} the game, and instead behaves like the player never existed in the save file.
|
|
3369
3369
|
*/
|
|
3370
3370
|
interface on_pre_player_removed {
|
|
3371
3371
|
/**
|
|
3372
|
-
* Identifier of the event
|
|
3372
|
+
* Identifier of the event.
|
|
3373
3373
|
*/
|
|
3374
3374
|
name: defines.events;
|
|
3375
3375
|
/**
|
|
@@ -3379,21 +3379,21 @@ interface on_pre_player_removed {
|
|
|
3379
3379
|
/**
|
|
3380
3380
|
* Tick the event was generated.
|
|
3381
3381
|
*/
|
|
3382
|
-
tick:
|
|
3382
|
+
tick: MapTick;
|
|
3383
3383
|
}
|
|
3384
3384
|
/**
|
|
3385
3385
|
* Called before a player toggles the map editor on or off.
|
|
3386
3386
|
*/
|
|
3387
3387
|
interface on_pre_player_toggled_map_editor {
|
|
3388
3388
|
/**
|
|
3389
|
-
* Identifier of the event
|
|
3389
|
+
* Identifier of the event.
|
|
3390
3390
|
*/
|
|
3391
3391
|
name: defines.events;
|
|
3392
3392
|
player_index: uint32;
|
|
3393
3393
|
/**
|
|
3394
3394
|
* Tick the event was generated.
|
|
3395
3395
|
*/
|
|
3396
|
-
tick:
|
|
3396
|
+
tick: MapTick;
|
|
3397
3397
|
}
|
|
3398
3398
|
/**
|
|
3399
3399
|
* Called directly before a robot explodes cliffs.
|
|
@@ -3405,7 +3405,7 @@ interface on_pre_robot_exploded_cliff {
|
|
|
3405
3405
|
*/
|
|
3406
3406
|
item: LuaItemPrototype;
|
|
3407
3407
|
/**
|
|
3408
|
-
* Identifier of the event
|
|
3408
|
+
* Identifier of the event.
|
|
3409
3409
|
*/
|
|
3410
3410
|
name: defines.events;
|
|
3411
3411
|
/**
|
|
@@ -3416,14 +3416,14 @@ interface on_pre_robot_exploded_cliff {
|
|
|
3416
3416
|
/**
|
|
3417
3417
|
* Tick the event was generated.
|
|
3418
3418
|
*/
|
|
3419
|
-
tick:
|
|
3419
|
+
tick: MapTick;
|
|
3420
3420
|
}
|
|
3421
3421
|
/**
|
|
3422
3422
|
* Called just before the scenario finishes.
|
|
3423
3423
|
*/
|
|
3424
3424
|
interface on_pre_scenario_finished {
|
|
3425
3425
|
/**
|
|
3426
|
-
* Identifier of the event
|
|
3426
|
+
* Identifier of the event.
|
|
3427
3427
|
*/
|
|
3428
3428
|
name: defines.events;
|
|
3429
3429
|
/**
|
|
@@ -3433,7 +3433,7 @@ interface on_pre_scenario_finished {
|
|
|
3433
3433
|
/**
|
|
3434
3434
|
* Tick the event was generated.
|
|
3435
3435
|
*/
|
|
3436
|
-
tick:
|
|
3436
|
+
tick: MapTick;
|
|
3437
3437
|
}
|
|
3438
3438
|
/**
|
|
3439
3439
|
* Called just before a script inventory is resized.
|
|
@@ -3445,7 +3445,7 @@ interface on_pre_script_inventory_resized {
|
|
|
3445
3445
|
*/
|
|
3446
3446
|
mod: string;
|
|
3447
3447
|
/**
|
|
3448
|
-
* Identifier of the event
|
|
3448
|
+
* Identifier of the event.
|
|
3449
3449
|
*/
|
|
3450
3450
|
name: defines.events;
|
|
3451
3451
|
/**
|
|
@@ -3463,35 +3463,35 @@ interface on_pre_script_inventory_resized {
|
|
|
3463
3463
|
/**
|
|
3464
3464
|
* Tick the event was generated.
|
|
3465
3465
|
*/
|
|
3466
|
-
tick:
|
|
3466
|
+
tick: MapTick;
|
|
3467
3467
|
}
|
|
3468
3468
|
/**
|
|
3469
3469
|
* Called just before a surface is cleared (all entities removed and all chunks deleted).
|
|
3470
3470
|
*/
|
|
3471
3471
|
interface on_pre_surface_cleared {
|
|
3472
3472
|
/**
|
|
3473
|
-
* Identifier of the event
|
|
3473
|
+
* Identifier of the event.
|
|
3474
3474
|
*/
|
|
3475
3475
|
name: defines.events;
|
|
3476
3476
|
surface_index: uint32;
|
|
3477
3477
|
/**
|
|
3478
3478
|
* Tick the event was generated.
|
|
3479
3479
|
*/
|
|
3480
|
-
tick:
|
|
3480
|
+
tick: MapTick;
|
|
3481
3481
|
}
|
|
3482
3482
|
/**
|
|
3483
3483
|
* Called just before a surface is deleted.
|
|
3484
3484
|
*/
|
|
3485
3485
|
interface on_pre_surface_deleted {
|
|
3486
3486
|
/**
|
|
3487
|
-
* Identifier of the event
|
|
3487
|
+
* Identifier of the event.
|
|
3488
3488
|
*/
|
|
3489
3489
|
name: defines.events;
|
|
3490
3490
|
surface_index: uint32;
|
|
3491
3491
|
/**
|
|
3492
3492
|
* Tick the event was generated.
|
|
3493
3493
|
*/
|
|
3494
|
-
tick:
|
|
3494
|
+
tick: MapTick;
|
|
3495
3495
|
}
|
|
3496
3496
|
/**
|
|
3497
3497
|
* Called when the player triggers "redo".
|
|
@@ -3502,7 +3502,7 @@ interface on_redo_applied {
|
|
|
3502
3502
|
*/
|
|
3503
3503
|
actions: UndoRedoAction[];
|
|
3504
3504
|
/**
|
|
3505
|
-
* Identifier of the event
|
|
3505
|
+
* Identifier of the event.
|
|
3506
3506
|
*/
|
|
3507
3507
|
name: defines.events;
|
|
3508
3508
|
/**
|
|
@@ -3512,7 +3512,7 @@ interface on_redo_applied {
|
|
|
3512
3512
|
/**
|
|
3513
3513
|
* Tick the event was generated.
|
|
3514
3514
|
*/
|
|
3515
|
-
tick:
|
|
3515
|
+
tick: MapTick;
|
|
3516
3516
|
}
|
|
3517
3517
|
/**
|
|
3518
3518
|
* Called when research is cancelled.
|
|
@@ -3523,7 +3523,7 @@ interface on_research_cancelled {
|
|
|
3523
3523
|
*/
|
|
3524
3524
|
force: LuaForce;
|
|
3525
3525
|
/**
|
|
3526
|
-
* Identifier of the event
|
|
3526
|
+
* Identifier of the event.
|
|
3527
3527
|
*/
|
|
3528
3528
|
name: defines.events;
|
|
3529
3529
|
/**
|
|
@@ -3537,7 +3537,7 @@ interface on_research_cancelled {
|
|
|
3537
3537
|
/**
|
|
3538
3538
|
* Tick the event was generated.
|
|
3539
3539
|
*/
|
|
3540
|
-
tick:
|
|
3540
|
+
tick: MapTick;
|
|
3541
3541
|
}
|
|
3542
3542
|
/**
|
|
3543
3543
|
* Called when a research finishes.
|
|
@@ -3548,7 +3548,7 @@ interface on_research_finished {
|
|
|
3548
3548
|
*/
|
|
3549
3549
|
by_script: boolean;
|
|
3550
3550
|
/**
|
|
3551
|
-
* Identifier of the event
|
|
3551
|
+
* Identifier of the event.
|
|
3552
3552
|
*/
|
|
3553
3553
|
name: defines.events;
|
|
3554
3554
|
/**
|
|
@@ -3558,7 +3558,7 @@ interface on_research_finished {
|
|
|
3558
3558
|
/**
|
|
3559
3559
|
* Tick the event was generated.
|
|
3560
3560
|
*/
|
|
3561
|
-
tick:
|
|
3561
|
+
tick: MapTick;
|
|
3562
3562
|
}
|
|
3563
3563
|
/**
|
|
3564
3564
|
* Called when research is moved forwards or backwards in the research queue.
|
|
@@ -3569,7 +3569,7 @@ interface on_research_moved {
|
|
|
3569
3569
|
*/
|
|
3570
3570
|
force: LuaForce;
|
|
3571
3571
|
/**
|
|
3572
|
-
* Identifier of the event
|
|
3572
|
+
* Identifier of the event.
|
|
3573
3573
|
*/
|
|
3574
3574
|
name: defines.events;
|
|
3575
3575
|
/**
|
|
@@ -3579,7 +3579,7 @@ interface on_research_moved {
|
|
|
3579
3579
|
/**
|
|
3580
3580
|
* Tick the event was generated.
|
|
3581
3581
|
*/
|
|
3582
|
-
tick:
|
|
3582
|
+
tick: MapTick;
|
|
3583
3583
|
}
|
|
3584
3584
|
/**
|
|
3585
3585
|
* Called when research is queued.
|
|
@@ -3590,7 +3590,7 @@ interface on_research_queued {
|
|
|
3590
3590
|
*/
|
|
3591
3591
|
force: LuaForce;
|
|
3592
3592
|
/**
|
|
3593
|
-
* Identifier of the event
|
|
3593
|
+
* Identifier of the event.
|
|
3594
3594
|
*/
|
|
3595
3595
|
name: defines.events;
|
|
3596
3596
|
/**
|
|
@@ -3604,7 +3604,7 @@ interface on_research_queued {
|
|
|
3604
3604
|
/**
|
|
3605
3605
|
* Tick the event was generated.
|
|
3606
3606
|
*/
|
|
3607
|
-
tick:
|
|
3607
|
+
tick: MapTick;
|
|
3608
3608
|
}
|
|
3609
3609
|
/**
|
|
3610
3610
|
* Called when a research is reversed (unresearched).
|
|
@@ -3615,7 +3615,7 @@ interface on_research_reversed {
|
|
|
3615
3615
|
*/
|
|
3616
3616
|
by_script: boolean;
|
|
3617
3617
|
/**
|
|
3618
|
-
* Identifier of the event
|
|
3618
|
+
* Identifier of the event.
|
|
3619
3619
|
*/
|
|
3620
3620
|
name: defines.events;
|
|
3621
3621
|
/**
|
|
@@ -3625,7 +3625,7 @@ interface on_research_reversed {
|
|
|
3625
3625
|
/**
|
|
3626
3626
|
* Tick the event was generated.
|
|
3627
3627
|
*/
|
|
3628
|
-
tick:
|
|
3628
|
+
tick: MapTick;
|
|
3629
3629
|
}
|
|
3630
3630
|
/**
|
|
3631
3631
|
* Called when a technology research starts.
|
|
@@ -3633,7 +3633,7 @@ interface on_research_reversed {
|
|
|
3633
3633
|
interface on_research_started {
|
|
3634
3634
|
last_research?: LuaTechnology;
|
|
3635
3635
|
/**
|
|
3636
|
-
* Identifier of the event
|
|
3636
|
+
* Identifier of the event.
|
|
3637
3637
|
*/
|
|
3638
3638
|
name: defines.events;
|
|
3639
3639
|
/**
|
|
@@ -3643,7 +3643,7 @@ interface on_research_started {
|
|
|
3643
3643
|
/**
|
|
3644
3644
|
* Tick the event was generated.
|
|
3645
3645
|
*/
|
|
3646
|
-
tick:
|
|
3646
|
+
tick: MapTick;
|
|
3647
3647
|
}
|
|
3648
3648
|
/**
|
|
3649
3649
|
* Called when a resource entity reaches 0 or its minimum yield for infinite resources.
|
|
@@ -3651,13 +3651,13 @@ interface on_research_started {
|
|
|
3651
3651
|
interface on_resource_depleted {
|
|
3652
3652
|
entity: LuaEntity;
|
|
3653
3653
|
/**
|
|
3654
|
-
* Identifier of the event
|
|
3654
|
+
* Identifier of the event.
|
|
3655
3655
|
*/
|
|
3656
3656
|
name: defines.events;
|
|
3657
3657
|
/**
|
|
3658
3658
|
* Tick the event was generated.
|
|
3659
3659
|
*/
|
|
3660
|
-
tick:
|
|
3660
|
+
tick: MapTick;
|
|
3661
3661
|
}
|
|
3662
3662
|
/**
|
|
3663
3663
|
* Called when a construction robot builds an entity.
|
|
@@ -3668,7 +3668,7 @@ interface on_robot_built_entity {
|
|
|
3668
3668
|
*/
|
|
3669
3669
|
entity: LuaEntity;
|
|
3670
3670
|
/**
|
|
3671
|
-
* Identifier of the event
|
|
3671
|
+
* Identifier of the event.
|
|
3672
3672
|
*/
|
|
3673
3673
|
name: defines.events;
|
|
3674
3674
|
/**
|
|
@@ -3686,7 +3686,7 @@ interface on_robot_built_entity {
|
|
|
3686
3686
|
/**
|
|
3687
3687
|
* Tick the event was generated.
|
|
3688
3688
|
*/
|
|
3689
|
-
tick:
|
|
3689
|
+
tick: MapTick;
|
|
3690
3690
|
}
|
|
3691
3691
|
/**
|
|
3692
3692
|
* Called after a robot builds tiles.
|
|
@@ -3701,7 +3701,7 @@ interface on_robot_built_tile {
|
|
|
3701
3701
|
*/
|
|
3702
3702
|
item: LuaItemPrototype;
|
|
3703
3703
|
/**
|
|
3704
|
-
* Identifier of the event
|
|
3704
|
+
* Identifier of the event.
|
|
3705
3705
|
*/
|
|
3706
3706
|
name: defines.events;
|
|
3707
3707
|
/**
|
|
@@ -3719,7 +3719,7 @@ interface on_robot_built_tile {
|
|
|
3719
3719
|
/**
|
|
3720
3720
|
* Tick the event was generated.
|
|
3721
3721
|
*/
|
|
3722
|
-
tick:
|
|
3722
|
+
tick: MapTick;
|
|
3723
3723
|
/**
|
|
3724
3724
|
* The tile prototype that was placed.
|
|
3725
3725
|
*/
|
|
@@ -3738,7 +3738,7 @@ interface on_robot_exploded_cliff {
|
|
|
3738
3738
|
*/
|
|
3739
3739
|
item: LuaItemPrototype;
|
|
3740
3740
|
/**
|
|
3741
|
-
* Identifier of the event
|
|
3741
|
+
* Identifier of the event.
|
|
3742
3742
|
*/
|
|
3743
3743
|
name: defines.events;
|
|
3744
3744
|
/**
|
|
@@ -3749,7 +3749,7 @@ interface on_robot_exploded_cliff {
|
|
|
3749
3749
|
/**
|
|
3750
3750
|
* Tick the event was generated.
|
|
3751
3751
|
*/
|
|
3752
|
-
tick:
|
|
3752
|
+
tick: MapTick;
|
|
3753
3753
|
}
|
|
3754
3754
|
/**
|
|
3755
3755
|
* Called when a robot mines an entity.
|
|
@@ -3760,7 +3760,7 @@ interface on_robot_mined {
|
|
|
3760
3760
|
*/
|
|
3761
3761
|
item_stack: ItemWithQualityCount;
|
|
3762
3762
|
/**
|
|
3763
|
-
* Identifier of the event
|
|
3763
|
+
* Identifier of the event.
|
|
3764
3764
|
*/
|
|
3765
3765
|
name: defines.events;
|
|
3766
3766
|
/**
|
|
@@ -3770,7 +3770,7 @@ interface on_robot_mined {
|
|
|
3770
3770
|
/**
|
|
3771
3771
|
* Tick the event was generated.
|
|
3772
3772
|
*/
|
|
3773
|
-
tick:
|
|
3773
|
+
tick: MapTick;
|
|
3774
3774
|
}
|
|
3775
3775
|
/**
|
|
3776
3776
|
* Called after the results of an entity being mined are collected just before the entity is destroyed.
|
|
@@ -3789,7 +3789,7 @@ interface on_robot_mined_entity {
|
|
|
3789
3789
|
*/
|
|
3790
3790
|
entity: LuaEntity;
|
|
3791
3791
|
/**
|
|
3792
|
-
* Identifier of the event
|
|
3792
|
+
* Identifier of the event.
|
|
3793
3793
|
*/
|
|
3794
3794
|
name: defines.events;
|
|
3795
3795
|
/**
|
|
@@ -3799,14 +3799,14 @@ interface on_robot_mined_entity {
|
|
|
3799
3799
|
/**
|
|
3800
3800
|
* Tick the event was generated.
|
|
3801
3801
|
*/
|
|
3802
|
-
tick:
|
|
3802
|
+
tick: MapTick;
|
|
3803
3803
|
}
|
|
3804
3804
|
/**
|
|
3805
3805
|
* Called after a robot mines tiles.
|
|
3806
3806
|
*/
|
|
3807
3807
|
interface on_robot_mined_tile {
|
|
3808
3808
|
/**
|
|
3809
|
-
* Identifier of the event
|
|
3809
|
+
* Identifier of the event.
|
|
3810
3810
|
*/
|
|
3811
3811
|
name: defines.events;
|
|
3812
3812
|
/**
|
|
@@ -3820,7 +3820,7 @@ interface on_robot_mined_tile {
|
|
|
3820
3820
|
/**
|
|
3821
3821
|
* Tick the event was generated.
|
|
3822
3822
|
*/
|
|
3823
|
-
tick:
|
|
3823
|
+
tick: MapTick;
|
|
3824
3824
|
/**
|
|
3825
3825
|
* The position data.
|
|
3826
3826
|
*/
|
|
@@ -3835,7 +3835,7 @@ interface on_robot_pre_mined {
|
|
|
3835
3835
|
*/
|
|
3836
3836
|
entity: LuaEntity;
|
|
3837
3837
|
/**
|
|
3838
|
-
* Identifier of the event
|
|
3838
|
+
* Identifier of the event.
|
|
3839
3839
|
*/
|
|
3840
3840
|
name: defines.events;
|
|
3841
3841
|
/**
|
|
@@ -3845,14 +3845,14 @@ interface on_robot_pre_mined {
|
|
|
3845
3845
|
/**
|
|
3846
3846
|
* Tick the event was generated.
|
|
3847
3847
|
*/
|
|
3848
|
-
tick:
|
|
3848
|
+
tick: MapTick;
|
|
3849
3849
|
}
|
|
3850
3850
|
/**
|
|
3851
3851
|
* Called when a rocket silo is ordered to be launched.
|
|
3852
3852
|
*/
|
|
3853
3853
|
interface on_rocket_launch_ordered {
|
|
3854
3854
|
/**
|
|
3855
|
-
* Identifier of the event
|
|
3855
|
+
* Identifier of the event.
|
|
3856
3856
|
*/
|
|
3857
3857
|
name: defines.events;
|
|
3858
3858
|
/**
|
|
@@ -3864,14 +3864,14 @@ interface on_rocket_launch_ordered {
|
|
|
3864
3864
|
/**
|
|
3865
3865
|
* Tick the event was generated.
|
|
3866
3866
|
*/
|
|
3867
|
-
tick:
|
|
3867
|
+
tick: MapTick;
|
|
3868
3868
|
}
|
|
3869
3869
|
/**
|
|
3870
3870
|
* Called when a rocket finishes ascending. (Triggers listening for finished rocket launch past 2.0 have been moved to 'on_cargo_pod_finished_ascending' as rocket and cargo pod are two separate entities)
|
|
3871
3871
|
*/
|
|
3872
3872
|
interface on_rocket_launched {
|
|
3873
3873
|
/**
|
|
3874
|
-
* Identifier of the event
|
|
3874
|
+
* Identifier of the event.
|
|
3875
3875
|
*/
|
|
3876
3876
|
name: defines.events;
|
|
3877
3877
|
rocket: LuaEntity;
|
|
@@ -3879,14 +3879,14 @@ interface on_rocket_launched {
|
|
|
3879
3879
|
/**
|
|
3880
3880
|
* Tick the event was generated.
|
|
3881
3881
|
*/
|
|
3882
|
-
tick:
|
|
3882
|
+
tick: MapTick;
|
|
3883
3883
|
}
|
|
3884
3884
|
/**
|
|
3885
3885
|
* Called when a runtime mod setting is changed by a player.
|
|
3886
3886
|
*/
|
|
3887
3887
|
interface on_runtime_mod_setting_changed {
|
|
3888
3888
|
/**
|
|
3889
|
-
* Identifier of the event
|
|
3889
|
+
* Identifier of the event.
|
|
3890
3890
|
*/
|
|
3891
3891
|
name: defines.events;
|
|
3892
3892
|
/**
|
|
@@ -3901,7 +3901,7 @@ interface on_runtime_mod_setting_changed {
|
|
|
3901
3901
|
/**
|
|
3902
3902
|
* Tick the event was generated.
|
|
3903
3903
|
*/
|
|
3904
|
-
tick:
|
|
3904
|
+
tick: MapTick;
|
|
3905
3905
|
}
|
|
3906
3906
|
/**
|
|
3907
3907
|
* Called just after a script inventory is resized.
|
|
@@ -3913,7 +3913,7 @@ interface on_script_inventory_resized {
|
|
|
3913
3913
|
*/
|
|
3914
3914
|
mod: string;
|
|
3915
3915
|
/**
|
|
3916
|
-
* Identifier of the event
|
|
3916
|
+
* Identifier of the event.
|
|
3917
3917
|
*/
|
|
3918
3918
|
name: defines.events;
|
|
3919
3919
|
/**
|
|
@@ -3935,7 +3935,7 @@ interface on_script_inventory_resized {
|
|
|
3935
3935
|
/**
|
|
3936
3936
|
* Tick the event was generated.
|
|
3937
3937
|
*/
|
|
3938
|
-
tick:
|
|
3938
|
+
tick: MapTick;
|
|
3939
3939
|
}
|
|
3940
3940
|
/**
|
|
3941
3941
|
* Called when a {@link LuaSurface::request_path | runtime:LuaSurface::request_path} call completes.
|
|
@@ -3946,7 +3946,7 @@ interface on_script_path_request_finished {
|
|
|
3946
3946
|
*/
|
|
3947
3947
|
id: uint32;
|
|
3948
3948
|
/**
|
|
3949
|
-
* Identifier of the event
|
|
3949
|
+
* Identifier of the event.
|
|
3950
3950
|
*/
|
|
3951
3951
|
name: defines.events;
|
|
3952
3952
|
/**
|
|
@@ -3956,7 +3956,7 @@ interface on_script_path_request_finished {
|
|
|
3956
3956
|
/**
|
|
3957
3957
|
* Tick the event was generated.
|
|
3958
3958
|
*/
|
|
3959
|
-
tick:
|
|
3959
|
+
tick: MapTick;
|
|
3960
3960
|
/**
|
|
3961
3961
|
* Indicates that the pathfinder failed because it is too busy, and that you can retry later.
|
|
3962
3962
|
*/
|
|
@@ -3975,7 +3975,7 @@ interface on_script_trigger_effect {
|
|
|
3975
3975
|
*/
|
|
3976
3976
|
effect_id: string;
|
|
3977
3977
|
/**
|
|
3978
|
-
* Identifier of the event
|
|
3978
|
+
* Identifier of the event.
|
|
3979
3979
|
*/
|
|
3980
3980
|
name: defines.events;
|
|
3981
3981
|
quality?: string;
|
|
@@ -3990,7 +3990,7 @@ interface on_script_trigger_effect {
|
|
|
3990
3990
|
/**
|
|
3991
3991
|
* Tick the event was generated.
|
|
3992
3992
|
*/
|
|
3993
|
-
tick:
|
|
3993
|
+
tick: MapTick;
|
|
3994
3994
|
}
|
|
3995
3995
|
/**
|
|
3996
3996
|
* Called when an entity of type `radar` finishes scanning a sector.
|
|
@@ -4005,7 +4005,7 @@ interface on_sector_scanned {
|
|
|
4005
4005
|
*/
|
|
4006
4006
|
chunk_position: ChunkPosition;
|
|
4007
4007
|
/**
|
|
4008
|
-
* Identifier of the event
|
|
4008
|
+
* Identifier of the event.
|
|
4009
4009
|
*/
|
|
4010
4010
|
name: defines.events;
|
|
4011
4011
|
/**
|
|
@@ -4015,7 +4015,7 @@ interface on_sector_scanned {
|
|
|
4015
4015
|
/**
|
|
4016
4016
|
* Tick the event was generated.
|
|
4017
4017
|
*/
|
|
4018
|
-
tick:
|
|
4018
|
+
tick: MapTick;
|
|
4019
4019
|
}
|
|
4020
4020
|
/**
|
|
4021
4021
|
* Called when an individual segment of a SegmentedUnit is created.
|
|
@@ -4023,13 +4023,13 @@ interface on_sector_scanned {
|
|
|
4023
4023
|
interface on_segment_entity_created {
|
|
4024
4024
|
entity: LuaEntity;
|
|
4025
4025
|
/**
|
|
4026
|
-
* Identifier of the event
|
|
4026
|
+
* Identifier of the event.
|
|
4027
4027
|
*/
|
|
4028
4028
|
name: defines.events;
|
|
4029
4029
|
/**
|
|
4030
4030
|
* Tick the event was generated.
|
|
4031
4031
|
*/
|
|
4032
|
-
tick:
|
|
4032
|
+
tick: MapTick;
|
|
4033
4033
|
}
|
|
4034
4034
|
/**
|
|
4035
4035
|
* Called when a segmented unit is created for any reason.
|
|
@@ -4044,7 +4044,7 @@ interface on_segmented_unit_created {
|
|
|
4044
4044
|
*/
|
|
4045
4045
|
clone_source?: LuaSegmentedUnit;
|
|
4046
4046
|
/**
|
|
4047
|
-
* Identifier of the event
|
|
4047
|
+
* Identifier of the event.
|
|
4048
4048
|
*/
|
|
4049
4049
|
name: defines.events;
|
|
4050
4050
|
/**
|
|
@@ -4054,7 +4054,7 @@ interface on_segmented_unit_created {
|
|
|
4054
4054
|
/**
|
|
4055
4055
|
* Tick the event was generated.
|
|
4056
4056
|
*/
|
|
4057
|
-
tick:
|
|
4057
|
+
tick: MapTick;
|
|
4058
4058
|
}
|
|
4059
4059
|
/**
|
|
4060
4060
|
* Called when a segmented unit is damaged. This is not called when a segmented unit's health is set directly by another mod.
|
|
@@ -4078,7 +4078,7 @@ interface on_segmented_unit_damaged {
|
|
|
4078
4078
|
*/
|
|
4079
4079
|
force?: LuaForce;
|
|
4080
4080
|
/**
|
|
4081
|
-
* Identifier of the event
|
|
4081
|
+
* Identifier of the event.
|
|
4082
4082
|
*/
|
|
4083
4083
|
name: defines.events;
|
|
4084
4084
|
/**
|
|
@@ -4093,7 +4093,7 @@ interface on_segmented_unit_damaged {
|
|
|
4093
4093
|
/**
|
|
4094
4094
|
* Tick the event was generated.
|
|
4095
4095
|
*/
|
|
4096
|
-
tick:
|
|
4096
|
+
tick: MapTick;
|
|
4097
4097
|
}
|
|
4098
4098
|
/**
|
|
4099
4099
|
* Called when a segmented unit dies.
|
|
@@ -4112,7 +4112,7 @@ interface on_segmented_unit_died {
|
|
|
4112
4112
|
*/
|
|
4113
4113
|
force?: LuaForce;
|
|
4114
4114
|
/**
|
|
4115
|
-
* Identifier of the event
|
|
4115
|
+
* Identifier of the event.
|
|
4116
4116
|
*/
|
|
4117
4117
|
name: defines.events;
|
|
4118
4118
|
/**
|
|
@@ -4122,7 +4122,7 @@ interface on_segmented_unit_died {
|
|
|
4122
4122
|
/**
|
|
4123
4123
|
* Tick the event was generated.
|
|
4124
4124
|
*/
|
|
4125
|
-
tick:
|
|
4125
|
+
tick: MapTick;
|
|
4126
4126
|
}
|
|
4127
4127
|
/**
|
|
4128
4128
|
* Called after the selected entity changes for a given player.
|
|
@@ -4133,7 +4133,7 @@ interface on_selected_entity_changed {
|
|
|
4133
4133
|
*/
|
|
4134
4134
|
last_entity?: LuaEntity;
|
|
4135
4135
|
/**
|
|
4136
|
-
* Identifier of the event
|
|
4136
|
+
* Identifier of the event.
|
|
4137
4137
|
*/
|
|
4138
4138
|
name: defines.events;
|
|
4139
4139
|
/**
|
|
@@ -4143,20 +4143,20 @@ interface on_selected_entity_changed {
|
|
|
4143
4143
|
/**
|
|
4144
4144
|
* Tick the event was generated.
|
|
4145
4145
|
*/
|
|
4146
|
-
tick:
|
|
4146
|
+
tick: MapTick;
|
|
4147
4147
|
}
|
|
4148
4148
|
/**
|
|
4149
4149
|
* Called when {@link LuaGameScript::is_multiplayer | runtime:LuaGameScript::is_multiplayer} changes to false. May also be raised when it was already false but a game was loaded from a save file without hosting.
|
|
4150
4150
|
*/
|
|
4151
4151
|
interface on_singleplayer_init {
|
|
4152
4152
|
/**
|
|
4153
|
-
* Identifier of the event
|
|
4153
|
+
* Identifier of the event.
|
|
4154
4154
|
*/
|
|
4155
4155
|
name: defines.events;
|
|
4156
4156
|
/**
|
|
4157
4157
|
* Tick the event was generated.
|
|
4158
4158
|
*/
|
|
4159
|
-
tick:
|
|
4159
|
+
tick: MapTick;
|
|
4160
4160
|
}
|
|
4161
4161
|
/**
|
|
4162
4162
|
* Called when a space platform builds an entity.
|
|
@@ -4167,7 +4167,7 @@ interface on_space_platform_built_entity {
|
|
|
4167
4167
|
*/
|
|
4168
4168
|
entity: LuaEntity;
|
|
4169
4169
|
/**
|
|
4170
|
-
* Identifier of the event
|
|
4170
|
+
* Identifier of the event.
|
|
4171
4171
|
*/
|
|
4172
4172
|
name: defines.events;
|
|
4173
4173
|
/**
|
|
@@ -4185,7 +4185,7 @@ interface on_space_platform_built_entity {
|
|
|
4185
4185
|
/**
|
|
4186
4186
|
* Tick the event was generated.
|
|
4187
4187
|
*/
|
|
4188
|
-
tick:
|
|
4188
|
+
tick: MapTick;
|
|
4189
4189
|
}
|
|
4190
4190
|
/**
|
|
4191
4191
|
* Called after a space platform builds tiles.
|
|
@@ -4200,7 +4200,7 @@ interface on_space_platform_built_tile {
|
|
|
4200
4200
|
*/
|
|
4201
4201
|
item: LuaItemPrototype;
|
|
4202
4202
|
/**
|
|
4203
|
-
* Identifier of the event
|
|
4203
|
+
* Identifier of the event.
|
|
4204
4204
|
*/
|
|
4205
4205
|
name: defines.events;
|
|
4206
4206
|
/**
|
|
@@ -4218,7 +4218,7 @@ interface on_space_platform_built_tile {
|
|
|
4218
4218
|
/**
|
|
4219
4219
|
* Tick the event was generated.
|
|
4220
4220
|
*/
|
|
4221
|
-
tick:
|
|
4221
|
+
tick: MapTick;
|
|
4222
4222
|
/**
|
|
4223
4223
|
* The tile prototype that was placed.
|
|
4224
4224
|
*/
|
|
@@ -4233,7 +4233,7 @@ interface on_space_platform_built_tile {
|
|
|
4233
4233
|
*/
|
|
4234
4234
|
interface on_space_platform_changed_state {
|
|
4235
4235
|
/**
|
|
4236
|
-
* Identifier of the event
|
|
4236
|
+
* Identifier of the event.
|
|
4237
4237
|
*/
|
|
4238
4238
|
name: defines.events;
|
|
4239
4239
|
old_state: defines.space_platform_state;
|
|
@@ -4241,7 +4241,7 @@ interface on_space_platform_changed_state {
|
|
|
4241
4241
|
/**
|
|
4242
4242
|
* Tick the event was generated.
|
|
4243
4243
|
*/
|
|
4244
|
-
tick:
|
|
4244
|
+
tick: MapTick;
|
|
4245
4245
|
}
|
|
4246
4246
|
/**
|
|
4247
4247
|
* Called after the results of an entity being mined are collected just before the entity is destroyed.
|
|
@@ -4260,7 +4260,7 @@ interface on_space_platform_mined_entity {
|
|
|
4260
4260
|
*/
|
|
4261
4261
|
entity: LuaEntity;
|
|
4262
4262
|
/**
|
|
4263
|
-
* Identifier of the event
|
|
4263
|
+
* Identifier of the event.
|
|
4264
4264
|
*/
|
|
4265
4265
|
name: defines.events;
|
|
4266
4266
|
/**
|
|
@@ -4270,7 +4270,7 @@ interface on_space_platform_mined_entity {
|
|
|
4270
4270
|
/**
|
|
4271
4271
|
* Tick the event was generated.
|
|
4272
4272
|
*/
|
|
4273
|
-
tick:
|
|
4273
|
+
tick: MapTick;
|
|
4274
4274
|
}
|
|
4275
4275
|
/**
|
|
4276
4276
|
* Called when a platform mines an entity.
|
|
@@ -4281,7 +4281,7 @@ interface on_space_platform_mined_item {
|
|
|
4281
4281
|
*/
|
|
4282
4282
|
item_stack: ItemWithQualityCount;
|
|
4283
4283
|
/**
|
|
4284
|
-
* Identifier of the event
|
|
4284
|
+
* Identifier of the event.
|
|
4285
4285
|
*/
|
|
4286
4286
|
name: defines.events;
|
|
4287
4287
|
/**
|
|
@@ -4291,14 +4291,14 @@ interface on_space_platform_mined_item {
|
|
|
4291
4291
|
/**
|
|
4292
4292
|
* Tick the event was generated.
|
|
4293
4293
|
*/
|
|
4294
|
-
tick:
|
|
4294
|
+
tick: MapTick;
|
|
4295
4295
|
}
|
|
4296
4296
|
/**
|
|
4297
4297
|
* Called after a platform mines tiles.
|
|
4298
4298
|
*/
|
|
4299
4299
|
interface on_space_platform_mined_tile {
|
|
4300
4300
|
/**
|
|
4301
|
-
* Identifier of the event
|
|
4301
|
+
* Identifier of the event.
|
|
4302
4302
|
*/
|
|
4303
4303
|
name: defines.events;
|
|
4304
4304
|
/**
|
|
@@ -4312,7 +4312,7 @@ interface on_space_platform_mined_tile {
|
|
|
4312
4312
|
/**
|
|
4313
4313
|
* Tick the event was generated.
|
|
4314
4314
|
*/
|
|
4315
|
-
tick:
|
|
4315
|
+
tick: MapTick;
|
|
4316
4316
|
/**
|
|
4317
4317
|
* The position data.
|
|
4318
4318
|
*/
|
|
@@ -4327,7 +4327,7 @@ interface on_space_platform_pre_mined {
|
|
|
4327
4327
|
*/
|
|
4328
4328
|
entity: LuaEntity;
|
|
4329
4329
|
/**
|
|
4330
|
-
* Identifier of the event
|
|
4330
|
+
* Identifier of the event.
|
|
4331
4331
|
*/
|
|
4332
4332
|
name: defines.events;
|
|
4333
4333
|
/**
|
|
@@ -4337,20 +4337,20 @@ interface on_space_platform_pre_mined {
|
|
|
4337
4337
|
/**
|
|
4338
4338
|
* Tick the event was generated.
|
|
4339
4339
|
*/
|
|
4340
|
-
tick:
|
|
4340
|
+
tick: MapTick;
|
|
4341
4341
|
}
|
|
4342
4342
|
/**
|
|
4343
4343
|
* Called when a spider finishes moving to its autopilot position.
|
|
4344
4344
|
*/
|
|
4345
4345
|
interface on_spider_command_completed {
|
|
4346
4346
|
/**
|
|
4347
|
-
* Identifier of the event
|
|
4347
|
+
* Identifier of the event.
|
|
4348
4348
|
*/
|
|
4349
4349
|
name: defines.events;
|
|
4350
4350
|
/**
|
|
4351
4351
|
* Tick the event was generated.
|
|
4352
4352
|
*/
|
|
4353
|
-
tick:
|
|
4353
|
+
tick: MapTick;
|
|
4354
4354
|
/**
|
|
4355
4355
|
* Spider vehicle which was requested to move.
|
|
4356
4356
|
*/
|
|
@@ -4369,7 +4369,7 @@ interface on_string_translated {
|
|
|
4369
4369
|
*/
|
|
4370
4370
|
localised_string: LocalisedString;
|
|
4371
4371
|
/**
|
|
4372
|
-
* Identifier of the event
|
|
4372
|
+
* Identifier of the event.
|
|
4373
4373
|
*/
|
|
4374
4374
|
name: defines.events;
|
|
4375
4375
|
/**
|
|
@@ -4383,7 +4383,7 @@ interface on_string_translated {
|
|
|
4383
4383
|
/**
|
|
4384
4384
|
* Tick the event was generated.
|
|
4385
4385
|
*/
|
|
4386
|
-
tick:
|
|
4386
|
+
tick: MapTick;
|
|
4387
4387
|
/**
|
|
4388
4388
|
* Whether the requested localised string was valid and could be translated.
|
|
4389
4389
|
*/
|
|
@@ -4394,14 +4394,14 @@ interface on_string_translated {
|
|
|
4394
4394
|
*/
|
|
4395
4395
|
interface on_surface_cleared {
|
|
4396
4396
|
/**
|
|
4397
|
-
* Identifier of the event
|
|
4397
|
+
* Identifier of the event.
|
|
4398
4398
|
*/
|
|
4399
4399
|
name: defines.events;
|
|
4400
4400
|
surface_index: uint32;
|
|
4401
4401
|
/**
|
|
4402
4402
|
* Tick the event was generated.
|
|
4403
4403
|
*/
|
|
4404
|
-
tick:
|
|
4404
|
+
tick: MapTick;
|
|
4405
4405
|
}
|
|
4406
4406
|
/**
|
|
4407
4407
|
* Called when a surface is created.
|
|
@@ -4410,35 +4410,35 @@ interface on_surface_cleared {
|
|
|
4410
4410
|
*/
|
|
4411
4411
|
interface on_surface_created {
|
|
4412
4412
|
/**
|
|
4413
|
-
* Identifier of the event
|
|
4413
|
+
* Identifier of the event.
|
|
4414
4414
|
*/
|
|
4415
4415
|
name: defines.events;
|
|
4416
4416
|
surface_index: uint32;
|
|
4417
4417
|
/**
|
|
4418
4418
|
* Tick the event was generated.
|
|
4419
4419
|
*/
|
|
4420
|
-
tick:
|
|
4420
|
+
tick: MapTick;
|
|
4421
4421
|
}
|
|
4422
4422
|
/**
|
|
4423
4423
|
* Called after a surface is deleted.
|
|
4424
4424
|
*/
|
|
4425
4425
|
interface on_surface_deleted {
|
|
4426
4426
|
/**
|
|
4427
|
-
* Identifier of the event
|
|
4427
|
+
* Identifier of the event.
|
|
4428
4428
|
*/
|
|
4429
4429
|
name: defines.events;
|
|
4430
4430
|
surface_index: uint32;
|
|
4431
4431
|
/**
|
|
4432
4432
|
* Tick the event was generated.
|
|
4433
4433
|
*/
|
|
4434
|
-
tick:
|
|
4434
|
+
tick: MapTick;
|
|
4435
4435
|
}
|
|
4436
4436
|
/**
|
|
4437
4437
|
* Called after a surface is imported via the map editor.
|
|
4438
4438
|
*/
|
|
4439
4439
|
interface on_surface_imported {
|
|
4440
4440
|
/**
|
|
4441
|
-
* Identifier of the event
|
|
4441
|
+
* Identifier of the event.
|
|
4442
4442
|
*/
|
|
4443
4443
|
name: defines.events;
|
|
4444
4444
|
/**
|
|
@@ -4449,14 +4449,14 @@ interface on_surface_imported {
|
|
|
4449
4449
|
/**
|
|
4450
4450
|
* Tick the event was generated.
|
|
4451
4451
|
*/
|
|
4452
|
-
tick:
|
|
4452
|
+
tick: MapTick;
|
|
4453
4453
|
}
|
|
4454
4454
|
/**
|
|
4455
4455
|
* Called when a surface is renamed.
|
|
4456
4456
|
*/
|
|
4457
4457
|
interface on_surface_renamed {
|
|
4458
4458
|
/**
|
|
4459
|
-
* Identifier of the event
|
|
4459
|
+
* Identifier of the event.
|
|
4460
4460
|
*/
|
|
4461
4461
|
name: defines.events;
|
|
4462
4462
|
new_name: string;
|
|
@@ -4465,7 +4465,7 @@ interface on_surface_renamed {
|
|
|
4465
4465
|
/**
|
|
4466
4466
|
* Tick the event was generated.
|
|
4467
4467
|
*/
|
|
4468
|
-
tick:
|
|
4468
|
+
tick: MapTick;
|
|
4469
4469
|
}
|
|
4470
4470
|
/**
|
|
4471
4471
|
* Called when {@link LuaForce::reset_technology_effects | runtime:LuaForce::reset_technology_effects} is finished.
|
|
@@ -4473,13 +4473,13 @@ interface on_surface_renamed {
|
|
|
4473
4473
|
interface on_technology_effects_reset {
|
|
4474
4474
|
force: LuaForce;
|
|
4475
4475
|
/**
|
|
4476
|
-
* Identifier of the event
|
|
4476
|
+
* Identifier of the event.
|
|
4477
4477
|
*/
|
|
4478
4478
|
name: defines.events;
|
|
4479
4479
|
/**
|
|
4480
4480
|
* Tick the event was generated.
|
|
4481
4481
|
*/
|
|
4482
|
-
tick:
|
|
4482
|
+
tick: MapTick;
|
|
4483
4483
|
}
|
|
4484
4484
|
/**
|
|
4485
4485
|
* Called when a territory is created for any reason.
|
|
@@ -4490,7 +4490,7 @@ interface on_territory_created {
|
|
|
4490
4490
|
*/
|
|
4491
4491
|
cause: defines.territory_created_cause;
|
|
4492
4492
|
/**
|
|
4493
|
-
* Identifier of the event
|
|
4493
|
+
* Identifier of the event.
|
|
4494
4494
|
*/
|
|
4495
4495
|
name: defines.events;
|
|
4496
4496
|
/**
|
|
@@ -4500,14 +4500,14 @@ interface on_territory_created {
|
|
|
4500
4500
|
/**
|
|
4501
4501
|
* Tick the event was generated.
|
|
4502
4502
|
*/
|
|
4503
|
-
tick:
|
|
4503
|
+
tick: MapTick;
|
|
4504
4504
|
}
|
|
4505
4505
|
/**
|
|
4506
4506
|
* Called when a territory is destroyed from a surface.
|
|
4507
4507
|
*/
|
|
4508
4508
|
interface on_territory_destroyed {
|
|
4509
4509
|
/**
|
|
4510
|
-
* Identifier of the event
|
|
4510
|
+
* Identifier of the event.
|
|
4511
4511
|
*/
|
|
4512
4512
|
name: defines.events;
|
|
4513
4513
|
/**
|
|
@@ -4517,20 +4517,20 @@ interface on_territory_destroyed {
|
|
|
4517
4517
|
/**
|
|
4518
4518
|
* Tick the event was generated.
|
|
4519
4519
|
*/
|
|
4520
|
-
tick:
|
|
4520
|
+
tick: MapTick;
|
|
4521
4521
|
}
|
|
4522
4522
|
/**
|
|
4523
4523
|
* It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
|
|
4524
4524
|
*/
|
|
4525
4525
|
interface on_tick {
|
|
4526
4526
|
/**
|
|
4527
|
-
* Identifier of the event
|
|
4527
|
+
* Identifier of the event.
|
|
4528
4528
|
*/
|
|
4529
4529
|
name: defines.events;
|
|
4530
4530
|
/**
|
|
4531
4531
|
* Tick the event was generated.
|
|
4532
4532
|
*/
|
|
4533
|
-
tick:
|
|
4533
|
+
tick: MapTick;
|
|
4534
4534
|
}
|
|
4535
4535
|
/**
|
|
4536
4536
|
* Called after the results of an entity being mined are collected just before the entity is destroyed.
|
|
@@ -4545,7 +4545,7 @@ interface on_tower_mined_plant {
|
|
|
4545
4545
|
*/
|
|
4546
4546
|
buffer: LuaInventory;
|
|
4547
4547
|
/**
|
|
4548
|
-
* Identifier of the event
|
|
4548
|
+
* Identifier of the event.
|
|
4549
4549
|
*/
|
|
4550
4550
|
name: defines.events;
|
|
4551
4551
|
/**
|
|
@@ -4555,7 +4555,7 @@ interface on_tower_mined_plant {
|
|
|
4555
4555
|
/**
|
|
4556
4556
|
* Tick the event was generated.
|
|
4557
4557
|
*/
|
|
4558
|
-
tick:
|
|
4558
|
+
tick: MapTick;
|
|
4559
4559
|
/**
|
|
4560
4560
|
* The tower doing the mining.
|
|
4561
4561
|
*/
|
|
@@ -4566,7 +4566,7 @@ interface on_tower_mined_plant {
|
|
|
4566
4566
|
*/
|
|
4567
4567
|
interface on_tower_planted_seed {
|
|
4568
4568
|
/**
|
|
4569
|
-
* Identifier of the event
|
|
4569
|
+
* Identifier of the event.
|
|
4570
4570
|
*/
|
|
4571
4571
|
name: defines.events;
|
|
4572
4572
|
/**
|
|
@@ -4580,7 +4580,7 @@ interface on_tower_planted_seed {
|
|
|
4580
4580
|
/**
|
|
4581
4581
|
* Tick the event was generated.
|
|
4582
4582
|
*/
|
|
4583
|
-
tick:
|
|
4583
|
+
tick: MapTick;
|
|
4584
4584
|
/**
|
|
4585
4585
|
* The tower that did the planting.
|
|
4586
4586
|
*/
|
|
@@ -4591,7 +4591,7 @@ interface on_tower_planted_seed {
|
|
|
4591
4591
|
*/
|
|
4592
4592
|
interface on_tower_pre_mined_plant {
|
|
4593
4593
|
/**
|
|
4594
|
-
* Identifier of the event
|
|
4594
|
+
* Identifier of the event.
|
|
4595
4595
|
*/
|
|
4596
4596
|
name: defines.events;
|
|
4597
4597
|
/**
|
|
@@ -4601,7 +4601,7 @@ interface on_tower_pre_mined_plant {
|
|
|
4601
4601
|
/**
|
|
4602
4602
|
* Tick the event was generated.
|
|
4603
4603
|
*/
|
|
4604
|
-
tick:
|
|
4604
|
+
tick: MapTick;
|
|
4605
4605
|
/**
|
|
4606
4606
|
* The tower that is about to do the mining.
|
|
4607
4607
|
*/
|
|
@@ -4612,14 +4612,14 @@ interface on_tower_pre_mined_plant {
|
|
|
4612
4612
|
*/
|
|
4613
4613
|
interface on_train_changed_state {
|
|
4614
4614
|
/**
|
|
4615
|
-
* Identifier of the event
|
|
4615
|
+
* Identifier of the event.
|
|
4616
4616
|
*/
|
|
4617
4617
|
name: defines.events;
|
|
4618
4618
|
old_state: defines.train_state;
|
|
4619
4619
|
/**
|
|
4620
4620
|
* Tick the event was generated.
|
|
4621
4621
|
*/
|
|
4622
|
-
tick:
|
|
4622
|
+
tick: MapTick;
|
|
4623
4623
|
train: LuaTrain;
|
|
4624
4624
|
}
|
|
4625
4625
|
/**
|
|
@@ -4627,7 +4627,7 @@ interface on_train_changed_state {
|
|
|
4627
4627
|
*/
|
|
4628
4628
|
interface on_train_created {
|
|
4629
4629
|
/**
|
|
4630
|
-
* Identifier of the event
|
|
4630
|
+
* Identifier of the event.
|
|
4631
4631
|
*/
|
|
4632
4632
|
name: defines.events;
|
|
4633
4633
|
/**
|
|
@@ -4641,7 +4641,7 @@ interface on_train_created {
|
|
|
4641
4641
|
/**
|
|
4642
4642
|
* Tick the event was generated.
|
|
4643
4643
|
*/
|
|
4644
|
-
tick:
|
|
4644
|
+
tick: MapTick;
|
|
4645
4645
|
train: LuaTrain;
|
|
4646
4646
|
}
|
|
4647
4647
|
/**
|
|
@@ -4649,7 +4649,7 @@ interface on_train_created {
|
|
|
4649
4649
|
*/
|
|
4650
4650
|
interface on_train_schedule_changed {
|
|
4651
4651
|
/**
|
|
4652
|
-
* Identifier of the event
|
|
4652
|
+
* Identifier of the event.
|
|
4653
4653
|
*/
|
|
4654
4654
|
name: defines.events;
|
|
4655
4655
|
/**
|
|
@@ -4659,7 +4659,7 @@ interface on_train_schedule_changed {
|
|
|
4659
4659
|
/**
|
|
4660
4660
|
* Tick the event was generated.
|
|
4661
4661
|
*/
|
|
4662
|
-
tick:
|
|
4662
|
+
tick: MapTick;
|
|
4663
4663
|
train: LuaTrain;
|
|
4664
4664
|
}
|
|
4665
4665
|
/**
|
|
@@ -4668,14 +4668,14 @@ interface on_train_schedule_changed {
|
|
|
4668
4668
|
interface on_trigger_created_entity {
|
|
4669
4669
|
entity: LuaEntity;
|
|
4670
4670
|
/**
|
|
4671
|
-
* Identifier of the event
|
|
4671
|
+
* Identifier of the event.
|
|
4672
4672
|
*/
|
|
4673
4673
|
name: defines.events;
|
|
4674
4674
|
source?: LuaEntity;
|
|
4675
4675
|
/**
|
|
4676
4676
|
* Tick the event was generated.
|
|
4677
4677
|
*/
|
|
4678
|
-
tick:
|
|
4678
|
+
tick: MapTick;
|
|
4679
4679
|
}
|
|
4680
4680
|
/**
|
|
4681
4681
|
* Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery=true`.
|
|
@@ -4683,21 +4683,21 @@ interface on_trigger_created_entity {
|
|
|
4683
4683
|
interface on_trigger_fired_artillery {
|
|
4684
4684
|
entity: LuaEntity;
|
|
4685
4685
|
/**
|
|
4686
|
-
* Identifier of the event
|
|
4686
|
+
* Identifier of the event.
|
|
4687
4687
|
*/
|
|
4688
4688
|
name: defines.events;
|
|
4689
4689
|
source?: LuaEntity;
|
|
4690
4690
|
/**
|
|
4691
4691
|
* Tick the event was generated.
|
|
4692
4692
|
*/
|
|
4693
|
-
tick:
|
|
4693
|
+
tick: MapTick;
|
|
4694
4694
|
}
|
|
4695
4695
|
/**
|
|
4696
4696
|
* Called when new packets are processed by {@link LuaHelpers::recv_udp | runtime:LuaHelpers::recv_udp}.
|
|
4697
4697
|
*/
|
|
4698
4698
|
interface on_udp_packet_received {
|
|
4699
4699
|
/**
|
|
4700
|
-
* Identifier of the event
|
|
4700
|
+
* Identifier of the event.
|
|
4701
4701
|
*/
|
|
4702
4702
|
name: defines.events;
|
|
4703
4703
|
/**
|
|
@@ -4715,7 +4715,7 @@ interface on_udp_packet_received {
|
|
|
4715
4715
|
/**
|
|
4716
4716
|
* Tick the event was generated.
|
|
4717
4717
|
*/
|
|
4718
|
-
tick:
|
|
4718
|
+
tick: MapTick;
|
|
4719
4719
|
}
|
|
4720
4720
|
/**
|
|
4721
4721
|
* Called when the player triggers "undo".
|
|
@@ -4726,7 +4726,7 @@ interface on_undo_applied {
|
|
|
4726
4726
|
*/
|
|
4727
4727
|
actions: UndoRedoAction[];
|
|
4728
4728
|
/**
|
|
4729
|
-
* Identifier of the event
|
|
4729
|
+
* Identifier of the event.
|
|
4730
4730
|
*/
|
|
4731
4731
|
name: defines.events;
|
|
4732
4732
|
/**
|
|
@@ -4736,7 +4736,7 @@ interface on_undo_applied {
|
|
|
4736
4736
|
/**
|
|
4737
4737
|
* Tick the event was generated.
|
|
4738
4738
|
*/
|
|
4739
|
-
tick:
|
|
4739
|
+
tick: MapTick;
|
|
4740
4740
|
}
|
|
4741
4741
|
/**
|
|
4742
4742
|
* Called when a unit is added to a unit group.
|
|
@@ -4744,13 +4744,13 @@ interface on_undo_applied {
|
|
|
4744
4744
|
interface on_unit_added_to_group {
|
|
4745
4745
|
group: LuaCommandable;
|
|
4746
4746
|
/**
|
|
4747
|
-
* Identifier of the event
|
|
4747
|
+
* Identifier of the event.
|
|
4748
4748
|
*/
|
|
4749
4749
|
name: defines.events;
|
|
4750
4750
|
/**
|
|
4751
4751
|
* Tick the event was generated.
|
|
4752
4752
|
*/
|
|
4753
|
-
tick:
|
|
4753
|
+
tick: MapTick;
|
|
4754
4754
|
unit: LuaEntity;
|
|
4755
4755
|
}
|
|
4756
4756
|
/**
|
|
@@ -4759,13 +4759,13 @@ interface on_unit_added_to_group {
|
|
|
4759
4759
|
interface on_unit_group_created {
|
|
4760
4760
|
group: LuaCommandable;
|
|
4761
4761
|
/**
|
|
4762
|
-
* Identifier of the event
|
|
4762
|
+
* Identifier of the event.
|
|
4763
4763
|
*/
|
|
4764
4764
|
name: defines.events;
|
|
4765
4765
|
/**
|
|
4766
4766
|
* Tick the event was generated.
|
|
4767
4767
|
*/
|
|
4768
|
-
tick:
|
|
4768
|
+
tick: MapTick;
|
|
4769
4769
|
}
|
|
4770
4770
|
/**
|
|
4771
4771
|
* Called when a unit group finishes gathering and starts executing its command.
|
|
@@ -4773,13 +4773,13 @@ interface on_unit_group_created {
|
|
|
4773
4773
|
interface on_unit_group_finished_gathering {
|
|
4774
4774
|
group: LuaCommandable;
|
|
4775
4775
|
/**
|
|
4776
|
-
* Identifier of the event
|
|
4776
|
+
* Identifier of the event.
|
|
4777
4777
|
*/
|
|
4778
4778
|
name: defines.events;
|
|
4779
4779
|
/**
|
|
4780
4780
|
* Tick the event was generated.
|
|
4781
4781
|
*/
|
|
4782
|
-
tick:
|
|
4782
|
+
tick: MapTick;
|
|
4783
4783
|
}
|
|
4784
4784
|
/**
|
|
4785
4785
|
* Called when a unit is removed from a unit group.
|
|
@@ -4787,13 +4787,13 @@ interface on_unit_group_finished_gathering {
|
|
|
4787
4787
|
interface on_unit_removed_from_group {
|
|
4788
4788
|
group: LuaCommandable;
|
|
4789
4789
|
/**
|
|
4790
|
-
* Identifier of the event
|
|
4790
|
+
* Identifier of the event.
|
|
4791
4791
|
*/
|
|
4792
4792
|
name: defines.events;
|
|
4793
4793
|
/**
|
|
4794
4794
|
* Tick the event was generated.
|
|
4795
4795
|
*/
|
|
4796
|
-
tick:
|
|
4796
|
+
tick: MapTick;
|
|
4797
4797
|
unit: LuaEntity;
|
|
4798
4798
|
}
|
|
4799
4799
|
/**
|
|
@@ -4801,14 +4801,14 @@ interface on_unit_removed_from_group {
|
|
|
4801
4801
|
*/
|
|
4802
4802
|
interface on_worker_robot_expired {
|
|
4803
4803
|
/**
|
|
4804
|
-
* Identifier of the event
|
|
4804
|
+
* Identifier of the event.
|
|
4805
4805
|
*/
|
|
4806
4806
|
name: defines.events;
|
|
4807
4807
|
robot: LuaEntity;
|
|
4808
4808
|
/**
|
|
4809
4809
|
* Tick the event was generated.
|
|
4810
4810
|
*/
|
|
4811
|
-
tick:
|
|
4811
|
+
tick: MapTick;
|
|
4812
4812
|
}
|
|
4813
4813
|
/**
|
|
4814
4814
|
* A static event mods can use to tell other mods they built something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_built | runtime:LuaBootstrap::raise_script_built}, or when `raise_built` is passed to {@link LuaSurface::create_entity | runtime:LuaSurface::create_entity}.
|
|
@@ -4819,13 +4819,13 @@ interface script_raised_built {
|
|
|
4819
4819
|
*/
|
|
4820
4820
|
entity: LuaEntity;
|
|
4821
4821
|
/**
|
|
4822
|
-
* Identifier of the event
|
|
4822
|
+
* Identifier of the event.
|
|
4823
4823
|
*/
|
|
4824
4824
|
name: defines.events;
|
|
4825
4825
|
/**
|
|
4826
4826
|
* Tick the event was generated.
|
|
4827
4827
|
*/
|
|
4828
|
-
tick:
|
|
4828
|
+
tick: MapTick;
|
|
4829
4829
|
}
|
|
4830
4830
|
/**
|
|
4831
4831
|
* A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_destroy | runtime:LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to {@link LuaEntity::destroy | runtime:LuaEntity::destroy}.
|
|
@@ -4836,20 +4836,20 @@ interface script_raised_destroy {
|
|
|
4836
4836
|
*/
|
|
4837
4837
|
entity: LuaEntity;
|
|
4838
4838
|
/**
|
|
4839
|
-
* Identifier of the event
|
|
4839
|
+
* Identifier of the event.
|
|
4840
4840
|
*/
|
|
4841
4841
|
name: defines.events;
|
|
4842
4842
|
/**
|
|
4843
4843
|
* Tick the event was generated.
|
|
4844
4844
|
*/
|
|
4845
|
-
tick:
|
|
4845
|
+
tick: MapTick;
|
|
4846
4846
|
}
|
|
4847
4847
|
/**
|
|
4848
4848
|
* A static event that mods can use to tell other mods they destroyed a segmented unit by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event}, or {@link LuaBootstrap::raise_script_destroy_segmented_unit | runtime:LuaBootstrap::raise_script_destroy_segmented_unit}, or when `raise_destroy` is passed to {@link LuaSegmentedUnit::destroy | runtime:LuaSegmentedUnit::destroy}.
|
|
4849
4849
|
*/
|
|
4850
4850
|
interface script_raised_destroy_segmented_unit {
|
|
4851
4851
|
/**
|
|
4852
|
-
* Identifier of the event
|
|
4852
|
+
* Identifier of the event.
|
|
4853
4853
|
*/
|
|
4854
4854
|
name: defines.events;
|
|
4855
4855
|
/**
|
|
@@ -4859,7 +4859,7 @@ interface script_raised_destroy_segmented_unit {
|
|
|
4859
4859
|
/**
|
|
4860
4860
|
* Tick the event was generated.
|
|
4861
4861
|
*/
|
|
4862
|
-
tick:
|
|
4862
|
+
tick: MapTick;
|
|
4863
4863
|
}
|
|
4864
4864
|
/**
|
|
4865
4865
|
* A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_revive | runtime:LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity::revive | runtime:LuaEntity::revive}.
|
|
@@ -4870,7 +4870,7 @@ interface script_raised_revive {
|
|
|
4870
4870
|
*/
|
|
4871
4871
|
entity: LuaEntity;
|
|
4872
4872
|
/**
|
|
4873
|
-
* Identifier of the event
|
|
4873
|
+
* Identifier of the event.
|
|
4874
4874
|
*/
|
|
4875
4875
|
name: defines.events;
|
|
4876
4876
|
/**
|
|
@@ -4880,14 +4880,14 @@ interface script_raised_revive {
|
|
|
4880
4880
|
/**
|
|
4881
4881
|
* Tick the event was generated.
|
|
4882
4882
|
*/
|
|
4883
|
-
tick:
|
|
4883
|
+
tick: MapTick;
|
|
4884
4884
|
}
|
|
4885
4885
|
/**
|
|
4886
4886
|
* A static event mods can use to tell other mods they changed tiles on a surface by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_set_tiles | runtime:LuaBootstrap::raise_script_set_tiles}, or when `raise_event` is passed to {@link LuaSurface::set_tiles | runtime:LuaSurface::set_tiles}.
|
|
4887
4887
|
*/
|
|
4888
4888
|
interface script_raised_set_tiles {
|
|
4889
4889
|
/**
|
|
4890
|
-
* Identifier of the event
|
|
4890
|
+
* Identifier of the event.
|
|
4891
4891
|
*/
|
|
4892
4892
|
name: defines.events;
|
|
4893
4893
|
/**
|
|
@@ -4897,7 +4897,7 @@ interface script_raised_set_tiles {
|
|
|
4897
4897
|
/**
|
|
4898
4898
|
* Tick the event was generated.
|
|
4899
4899
|
*/
|
|
4900
|
-
tick:
|
|
4900
|
+
tick: MapTick;
|
|
4901
4901
|
/**
|
|
4902
4902
|
* The tiles that were changed.
|
|
4903
4903
|
*/
|
|
@@ -4912,7 +4912,7 @@ interface script_raised_teleported {
|
|
|
4912
4912
|
*/
|
|
4913
4913
|
entity: LuaEntity;
|
|
4914
4914
|
/**
|
|
4915
|
-
* Identifier of the event
|
|
4915
|
+
* Identifier of the event.
|
|
4916
4916
|
*/
|
|
4917
4917
|
name: defines.events;
|
|
4918
4918
|
/**
|
|
@@ -4926,7 +4926,7 @@ interface script_raised_teleported {
|
|
|
4926
4926
|
/**
|
|
4927
4927
|
* Tick the event was generated.
|
|
4928
4928
|
*/
|
|
4929
|
-
tick:
|
|
4929
|
+
tick: MapTick;
|
|
4930
4930
|
}
|
|
4931
4931
|
|
|
4932
4932
|
}
|