factorio-types 0.0.38 → 0.0.40

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/events.d.ts CHANGED
@@ -2,16 +2,17 @@
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 1.1.87
6
- // API version 3
5
+ // Factorio version 1.1.89
6
+ // API version 4
7
7
 
8
+ declare namespace runtime {
8
9
  /**
9
10
  * Base type for all events
10
11
  * @remarks
11
12
  * Not a member of the factorio API, added to type definitions for ease of use
12
13
  *
13
14
  */
14
- interface event {
15
+ interface event {
15
16
  /**
16
17
  * Identifier of the event
17
18
  */
@@ -22,9 +23,9 @@ interface event {
22
23
  tick: number
23
24
  }
24
25
  /**
25
- * Called when a {@link CustomInput | https://wiki.factorio.com/Prototype/CustomInput} is activated.
26
+ * Called when a {@link CustomInputPrototype | prototype:CustomInputPrototype} is activated.
26
27
  */
27
- interface CustomInputEvent extends event {
28
+ interface CustomInputEvent extends event {
28
29
  /**
29
30
  * The mouse cursor display location when the custom input was activated.
30
31
  */
@@ -49,7 +50,7 @@ interface CustomInputEvent extends event {
49
50
  /**
50
51
  * Called when a unit/group completes a command.
51
52
  */
52
- interface on_ai_command_completed extends event {
53
+ interface on_ai_command_completed extends event {
53
54
  result: defines.behavior_result
54
55
  /**
55
56
  * unit_number/group_number of the unit/group which just completed a command.
@@ -63,7 +64,7 @@ interface on_ai_command_completed extends event {
63
64
  /**
64
65
  * Called when an area of the map is cloned.
65
66
  */
66
- interface on_area_cloned extends event {
67
+ interface on_area_cloned extends event {
67
68
  clear_destination_decoratives: boolean
68
69
  clear_destination_entities: boolean
69
70
  clone_decoratives: boolean
@@ -81,7 +82,7 @@ interface on_area_cloned extends event {
81
82
  * This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
82
83
  *
83
84
  */
84
- interface on_biter_base_built extends event {
85
+ interface on_biter_base_built extends event {
85
86
  /**
86
87
  * The entity that was built.
87
88
  */
@@ -90,7 +91,7 @@ interface on_biter_base_built extends event {
90
91
  /**
91
92
  * Called when a set of positions on the map is cloned.
92
93
  */
93
- interface on_brush_cloned extends event {
94
+ interface on_brush_cloned extends event {
94
95
  clear_destination_decoratives: boolean
95
96
  clear_destination_entities: boolean
96
97
  clone_decoratives: boolean
@@ -104,9 +105,9 @@ interface on_brush_cloned extends event {
104
105
  source_surface: LuaSurface
105
106
  }
106
107
  /**
107
- * Called when a {@link defines.command.build_base | defines.command.build_base} command reaches its destination, and before building starts.
108
+ * Called when a {@link defines.command.build_base | runtime:defines.command.build_base} command reaches its destination, and before building starts.
108
109
  */
109
- interface on_build_base_arrived extends event {
110
+ interface on_build_base_arrived extends event {
110
111
  /**
111
112
  * The unit group the command was assigned to.
112
113
  */
@@ -117,9 +118,9 @@ interface on_build_base_arrived extends event {
117
118
  unit?: LuaEntity
118
119
  }
119
120
  /**
120
- * Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter | LuaPlayerBuiltEntityEventFilter}.
121
+ * Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter | runtime:LuaPlayerBuiltEntityEventFilter}.
121
122
  */
122
- interface on_built_entity extends event {
123
+ interface on_built_entity extends event {
123
124
  created_entity: LuaEntity
124
125
  /**
125
126
  * The item prototype used to build the entity. Note this won't exist in some situations (built from blueprint, undo, etc).
@@ -133,16 +134,16 @@ interface on_built_entity extends event {
133
134
  tags?: Tags
134
135
  }
135
136
  /**
136
- * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter | LuaEntityDeconstructionCancelledEventFilter}.
137
+ * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter | runtime:LuaEntityDeconstructionCancelledEventFilter}.
137
138
  */
138
- interface on_cancelled_deconstruction extends event {
139
+ interface on_cancelled_deconstruction extends event {
139
140
  entity: LuaEntity
140
141
  player_index?: number
141
142
  }
142
143
  /**
143
- * Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter | LuaUpgradeCancelledEventFilter}.
144
+ * Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter | runtime:LuaUpgradeCancelledEventFilter}.
144
145
  */
145
- interface on_cancelled_upgrade extends event {
146
+ interface on_cancelled_upgrade extends event {
146
147
  direction?: defines.direction
147
148
  entity: LuaEntity
148
149
  player_index?: number
@@ -151,10 +152,10 @@ interface on_cancelled_upgrade extends event {
151
152
  /**
152
153
  * Called when a character corpse expires due to timeout or all of the items being removed from it.
153
154
  * @remarks
154
- * this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item | defines.events.on_pre_player_mined_item} to detect that.
155
+ * this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item | runtime:defines.events.on_pre_player_mined_item} to detect that.
155
156
  *
156
157
  */
157
- interface on_character_corpse_expired extends event {
158
+ interface on_character_corpse_expired extends event {
158
159
  /**
159
160
  * The corpse.
160
161
  */
@@ -163,7 +164,7 @@ interface on_character_corpse_expired extends event {
163
164
  /**
164
165
  * Called when a chart tag is created.
165
166
  */
166
- interface on_chart_tag_added extends event {
167
+ interface on_chart_tag_added extends event {
167
168
  force: LuaForce
168
169
  player_index?: number
169
170
  tag: LuaCustomChartTag
@@ -171,7 +172,7 @@ interface on_chart_tag_added extends event {
171
172
  /**
172
173
  * Called when a chart tag is modified by a player.
173
174
  */
174
- interface on_chart_tag_modified extends event {
175
+ interface on_chart_tag_modified extends event {
175
176
  force: LuaForce
176
177
  old_icon?: SignalID
177
178
  old_player?: number
@@ -182,7 +183,7 @@ interface on_chart_tag_modified extends event {
182
183
  /**
183
184
  * Called just before a chart tag is deleted.
184
185
  */
185
- interface on_chart_tag_removed extends event {
186
+ interface on_chart_tag_removed extends event {
186
187
  force: LuaForce
187
188
  player_index?: number
188
189
  tag: LuaCustomChartTag
@@ -190,7 +191,7 @@ interface on_chart_tag_removed extends event {
190
191
  /**
191
192
  * Called when a chunk is charted or re-charted.
192
193
  */
193
- interface on_chunk_charted extends event {
194
+ interface on_chunk_charted extends event {
194
195
  /**
195
196
  * Area of the chunk.
196
197
  */
@@ -200,9 +201,9 @@ interface on_chunk_charted extends event {
200
201
  surface_index: number
201
202
  }
202
203
  /**
203
- * Called when one or more chunks are deleted using {@link LuaSurface::delete_chunk | LuaSurface::delete_chunk}.
204
+ * Called when one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
204
205
  */
205
- interface on_chunk_deleted extends event {
206
+ interface on_chunk_deleted extends event {
206
207
  /**
207
208
  * The chunks deleted.
208
209
  */
@@ -212,7 +213,7 @@ interface on_chunk_deleted extends event {
212
213
  /**
213
214
  * Called when a chunk is generated.
214
215
  */
215
- interface on_chunk_generated extends event {
216
+ interface on_chunk_generated extends event {
216
217
  /**
217
218
  * Area of the chunk.
218
219
  */
@@ -229,7 +230,7 @@ interface on_chunk_generated extends event {
229
230
  /**
230
231
  * Called when a combat robot expires through a lack of energy, or timeout.
231
232
  */
232
- interface on_combat_robot_expired extends event {
233
+ interface on_combat_robot_expired extends event {
233
234
  /**
234
235
  * The entity that owns the robot if any.
235
236
  */
@@ -242,7 +243,7 @@ interface on_combat_robot_expired extends event {
242
243
  * This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
243
244
  *
244
245
  */
245
- interface on_console_chat extends event {
246
+ interface on_console_chat extends event {
246
247
  /**
247
248
  * The chat message that was sent.
248
249
  */
@@ -255,7 +256,7 @@ interface on_console_chat extends event {
255
256
  /**
256
257
  * Called when someone enters a command-like message regardless of it being a valid command.
257
258
  */
258
- interface on_console_command extends event {
259
+ interface on_console_command extends event {
259
260
  /**
260
261
  * The command as typed without the preceding forward slash ('/').
261
262
  */
@@ -272,7 +273,7 @@ interface on_console_command extends event {
272
273
  /**
273
274
  * Called when a cutscene is cancelled by the player or by script.
274
275
  */
275
- interface on_cutscene_cancelled extends event {
276
+ interface on_cutscene_cancelled extends event {
276
277
  /**
277
278
  * The player the cutscene was shown to.
278
279
  */
@@ -281,7 +282,7 @@ interface on_cutscene_cancelled extends event {
281
282
  /**
282
283
  * Called when a cutscene finishes naturally (was not cancelled).
283
284
  */
284
- interface on_cutscene_finished extends event {
285
+ interface on_cutscene_finished extends event {
285
286
  /**
286
287
  * The player the cutscene was shown to.
287
288
  */
@@ -290,7 +291,7 @@ interface on_cutscene_finished extends event {
290
291
  /**
291
292
  * Called when a cutscene starts.
292
293
  */
293
- interface on_cutscene_started extends event {
294
+ interface on_cutscene_started extends event {
294
295
  /**
295
296
  * The player the cutscene is being shown to.
296
297
  */
@@ -304,7 +305,7 @@ interface on_cutscene_started extends event {
304
305
  * Due to implementation omission, waypoint_index is 0-based.
305
306
  *
306
307
  */
307
- interface on_cutscene_waypoint_reached extends event {
308
+ interface on_cutscene_waypoint_reached extends event {
308
309
  /**
309
310
  * The player index of the player viewing the cutscene.
310
311
  */
@@ -320,36 +321,36 @@ interface on_cutscene_waypoint_reached extends event {
320
321
  * It's not guaranteed that both settings are changed - just that at least one has been changed.
321
322
  *
322
323
  */
323
- interface on_difficulty_settings_changed extends event {
324
+ interface on_difficulty_settings_changed extends event {
324
325
  old_recipe_difficulty: number
325
326
  old_technology_difficulty: number
326
327
  }
327
328
  /**
328
- * Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter | LuaEntityClonedEventFilter}.
329
+ * Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter | runtime:LuaEntityClonedEventFilter}.
329
330
  */
330
- interface on_entity_cloned extends event {
331
+ interface on_entity_cloned extends event {
331
332
  destination: LuaEntity
332
333
  source: LuaEntity
333
334
  }
334
335
  /**
335
336
  * Called after an entity has been recolored either by the player or through script.
336
337
  * @remarks
337
- * Automatic recoloring due to {@link LuaPlayer::color | LuaPlayer::color} will not raise events, as that is a separate mechanism.
338
+ * Automatic recoloring due to {@link LuaPlayer::color | runtime:LuaPlayer::color} will not raise events, as that is a separate mechanism.
338
339
  *
339
340
  */
340
- interface on_entity_color_changed extends event {
341
+ interface on_entity_color_changed extends event {
341
342
  /**
342
343
  * The entity that was recolored.
343
344
  */
344
345
  entity: LuaEntity
345
346
  }
346
347
  /**
347
- * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter | LuaEntityDamagedEventFilter}.
348
+ * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter | runtime:LuaEntityDamagedEventFilter}.
348
349
  * @remarks
349
350
  * This is not called when an entities health is set directly by another mod.
350
351
  *
351
352
  */
352
- interface on_entity_damaged extends event {
353
+ interface on_entity_damaged extends event {
353
354
  /**
354
355
  * The entity that did the attacking if available.
355
356
  */
@@ -374,25 +375,25 @@ interface on_entity_damaged extends event {
374
375
  original_damage_amount: number
375
376
  }
376
377
  /**
377
- * Called after an entity is destroyed that has been registered with {@link LuaBootstrap::register_on_entity_destroyed | LuaBootstrap::register_on_entity_destroyed}.
378
+ * Called after an entity is destroyed that has been registered with {@link LuaBootstrap::register_on_entity_destroyed | runtime:LuaBootstrap::register_on_entity_destroyed}.
378
379
  * @remarks
379
380
  * Depending on when a given entity is destroyed, this event will be fired at the end of the current tick or at the end of the next tick.
380
381
  *
381
382
  */
382
- interface on_entity_destroyed extends event {
383
+ interface on_entity_destroyed extends event {
383
384
  /**
384
- * The number returned by {@link register_on_entity_destroyed | LuaBootstrap::register_on_entity_destroyed} to uniquely identify this entity during this event.
385
+ * The number returned by {@link register_on_entity_destroyed | runtime:LuaBootstrap::register_on_entity_destroyed} to uniquely identify this entity during this event.
385
386
  */
386
387
  registration_number: number
387
388
  /**
388
- * The {@link LuaEntity::unit_number | LuaEntity::unit_number} of the destroyed entity, if it had one.
389
+ * The {@link LuaEntity::unit_number | runtime:LuaEntity::unit_number} of the destroyed entity, if it had one.
389
390
  */
390
391
  unit_number?: number
391
392
  }
392
393
  /**
393
- * Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter | LuaEntityDiedEventFilter}.
394
+ * Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter | runtime:LuaEntityDiedEventFilter}.
394
395
  */
395
- interface on_entity_died extends event {
396
+ interface on_entity_died extends event {
396
397
  /**
397
398
  * The entity that did the killing if available.
398
399
  */
@@ -420,7 +421,7 @@ interface on_entity_died extends event {
420
421
  * "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the request slots on logistic chests.
421
422
  *
422
423
  */
423
- interface on_entity_logistic_slot_changed extends event {
424
+ interface on_entity_logistic_slot_changed extends event {
424
425
  /**
425
426
  * The entity for whom a logistic slot was changed.
426
427
  */
@@ -437,7 +438,7 @@ interface on_entity_logistic_slot_changed extends event {
437
438
  /**
438
439
  * Called after an entity has been renamed either by the player or through script.
439
440
  */
440
- interface on_entity_renamed extends event {
441
+ interface on_entity_renamed extends event {
441
442
  by_script: boolean
442
443
  entity: LuaEntity
443
444
  old_name: string
@@ -449,7 +450,7 @@ interface on_entity_renamed extends event {
449
450
  /**
450
451
  * Called after entity copy-paste is done.
451
452
  */
452
- interface on_entity_settings_pasted extends event {
453
+ interface on_entity_settings_pasted extends event {
453
454
  /**
454
455
  * The destination entity settings were copied to.
455
456
  */
@@ -463,14 +464,14 @@ interface on_entity_settings_pasted extends event {
463
464
  /**
464
465
  * Called when an entity is spawned by a EnemySpawner
465
466
  */
466
- interface on_entity_spawned extends event {
467
+ interface on_entity_spawned extends event {
467
468
  entity: LuaEntity
468
469
  spawner: LuaEntity
469
470
  }
470
471
  /**
471
472
  * Called after equipment is inserted into an equipment grid.
472
473
  */
473
- interface on_equipment_inserted extends event {
474
+ interface on_equipment_inserted extends event {
474
475
  /**
475
476
  * The equipment inserted.
476
477
  */
@@ -483,7 +484,7 @@ interface on_equipment_inserted extends event {
483
484
  /**
484
485
  * Called after equipment is removed from an equipment grid.
485
486
  */
486
- interface on_equipment_removed extends event {
487
+ interface on_equipment_removed extends event {
487
488
  /**
488
489
  * The count of equipment removed.
489
490
  */
@@ -500,7 +501,7 @@ interface on_equipment_removed extends event {
500
501
  /**
501
502
  * Called when the a forces cease fire values change.
502
503
  */
503
- interface on_force_cease_fire_changed extends event {
504
+ interface on_force_cease_fire_changed extends event {
504
505
  /**
505
506
  * If the other force was added or removed.
506
507
  */
@@ -520,7 +521,7 @@ interface on_force_cease_fire_changed extends event {
520
521
  * This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
521
522
  *
522
523
  */
523
- interface on_force_created extends event {
524
+ interface on_force_created extends event {
524
525
  /**
525
526
  * The newly created force.
526
527
  */
@@ -529,7 +530,7 @@ interface on_force_created extends event {
529
530
  /**
530
531
  * Called when the a forces friends change.
531
532
  */
532
- interface on_force_friends_changed extends event {
533
+ interface on_force_friends_changed extends event {
533
534
  /**
534
535
  * If the other force was added or removed.
535
536
  */
@@ -544,9 +545,9 @@ interface on_force_friends_changed extends event {
544
545
  other_force: LuaForce
545
546
  }
546
547
  /**
547
- * Called when {@link LuaForce::reset | LuaForce::reset} is finished.
548
+ * Called when {@link LuaForce::reset | runtime:LuaForce::reset} is finished.
548
549
  */
549
- interface on_force_reset extends event {
550
+ interface on_force_reset extends event {
550
551
  force: LuaForce
551
552
  }
552
553
  /**
@@ -555,7 +556,7 @@ interface on_force_reset extends event {
555
556
  * The source force is invalidated before this event is called and the name can be re-used in this event if desired.
556
557
  *
557
558
  */
558
- interface on_forces_merged extends event {
559
+ interface on_forces_merged extends event {
559
560
  /**
560
561
  * The force entities where reassigned to.
561
562
  */
@@ -572,7 +573,7 @@ interface on_forces_merged extends event {
572
573
  /**
573
574
  * Called when two forces are about to be merged using `game.merge_forces()`.
574
575
  */
575
- interface on_forces_merging extends event {
576
+ interface on_forces_merging extends event {
576
577
  /**
577
578
  * The force to reassign entities to.
578
579
  */
@@ -583,17 +584,17 @@ interface on_forces_merging extends event {
583
584
  source: LuaForce
584
585
  }
585
586
  /**
586
- * 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 | LuaBootstrap::on_init} is not fired.
587
+ * 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.
587
588
  * @remarks
588
589
  * This event is not fired when the scenario is loaded via the map editor.
589
590
  *
590
591
  */
591
- interface on_game_created_from_scenario extends event {
592
+ interface on_game_created_from_scenario extends event {
592
593
  }
593
594
  /**
594
- * Called when {@link LuaGuiElement | LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
595
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
595
596
  */
596
- interface on_gui_checked_state_changed extends event {
597
+ interface on_gui_checked_state_changed extends event {
597
598
  /**
598
599
  * The element whose checked state changed.
599
600
  */
@@ -604,9 +605,9 @@ interface on_gui_checked_state_changed extends event {
604
605
  player_index: number
605
606
  }
606
607
  /**
607
- * Called when {@link LuaGuiElement | LuaGuiElement} is clicked.
608
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} is clicked.
608
609
  */
609
- interface on_gui_click extends event {
610
+ interface on_gui_click extends event {
610
611
  /**
611
612
  * If alt was pressed.
612
613
  */
@@ -644,7 +645,7 @@ interface on_gui_click extends event {
644
645
  * It's not advised to open any other GUI during this event because if this is run as a request to open a different GUI the game will force close the new opened GUI without notice to ensure the original requested GUI is opened.
645
646
  *
646
647
  */
647
- interface on_gui_closed extends event {
648
+ interface on_gui_closed extends event {
648
649
  /**
649
650
  * The custom GUI element that was open
650
651
  */
@@ -687,9 +688,9 @@ interface on_gui_closed extends event {
687
688
  tile_position?: TilePosition
688
689
  }
689
690
  /**
690
- * Called when a {@link LuaGuiElement | LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
691
+ * Called when a {@link LuaGuiElement | runtime:LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
691
692
  */
692
- interface on_gui_confirmed extends event {
693
+ interface on_gui_confirmed extends event {
693
694
  /**
694
695
  * If alt was pressed.
695
696
  */
@@ -712,9 +713,9 @@ interface on_gui_confirmed extends event {
712
713
  shift: boolean
713
714
  }
714
715
  /**
715
- * Called when {@link LuaGuiElement | LuaGuiElement} element value is changed (related to choose element buttons).
716
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} element value is changed (related to choose element buttons).
716
717
  */
717
- interface on_gui_elem_changed extends event {
718
+ interface on_gui_elem_changed extends event {
718
719
  /**
719
720
  * The element whose element value changed.
720
721
  */
@@ -725,9 +726,9 @@ interface on_gui_elem_changed extends event {
725
726
  player_index: number
726
727
  }
727
728
  /**
728
- * Called when {@link LuaGuiElement | LuaGuiElement} is hovered by the mouse.
729
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} is hovered by the mouse.
729
730
  */
730
- interface on_gui_hover extends event {
731
+ interface on_gui_hover extends event {
731
732
  /**
732
733
  * The element that is being hovered over.
733
734
  */
@@ -738,9 +739,9 @@ interface on_gui_hover extends event {
738
739
  player_index: number
739
740
  }
740
741
  /**
741
- * Called when the player's cursor leaves a {@link LuaGuiElement | LuaGuiElement} that was previously hovered.
742
+ * Called when the player's cursor leaves a {@link LuaGuiElement | runtime:LuaGuiElement} that was previously hovered.
742
743
  */
743
- interface on_gui_leave extends event {
744
+ interface on_gui_leave extends event {
744
745
  /**
745
746
  * The element that was being hovered.
746
747
  */
@@ -751,9 +752,9 @@ interface on_gui_leave extends event {
751
752
  player_index: number
752
753
  }
753
754
  /**
754
- * Called when {@link LuaGuiElement | LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
755
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
755
756
  */
756
- interface on_gui_location_changed extends event {
757
+ interface on_gui_location_changed extends event {
757
758
  /**
758
759
  * The element whose location changed.
759
760
  */
@@ -766,7 +767,7 @@ interface on_gui_location_changed extends event {
766
767
  /**
767
768
  * Called when the player opens a GUI.
768
769
  */
769
- interface on_gui_opened extends event {
770
+ interface on_gui_opened extends event {
770
771
  /**
771
772
  * The custom GUI element that was opened
772
773
  */
@@ -801,9 +802,9 @@ interface on_gui_opened extends event {
801
802
  player_index: number
802
803
  }
803
804
  /**
804
- * Called when {@link LuaGuiElement | LuaGuiElement} selected tab is changed (related to tabbed-panes).
805
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selected tab is changed (related to tabbed-panes).
805
806
  */
806
- interface on_gui_selected_tab_changed extends event {
807
+ interface on_gui_selected_tab_changed extends event {
807
808
  /**
808
809
  * The tabbed pane whose selected tab changed.
809
810
  */
@@ -814,9 +815,9 @@ interface on_gui_selected_tab_changed extends event {
814
815
  player_index: number
815
816
  }
816
817
  /**
817
- * Called when {@link LuaGuiElement | LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
818
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
818
819
  */
819
- interface on_gui_selection_state_changed extends event {
820
+ interface on_gui_selection_state_changed extends event {
820
821
  /**
821
822
  * The element whose selection state changed.
822
823
  */
@@ -827,9 +828,9 @@ interface on_gui_selection_state_changed extends event {
827
828
  player_index: number
828
829
  }
829
830
  /**
830
- * Called when {@link LuaGuiElement | LuaGuiElement} switch state is changed (related to switches).
831
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} switch state is changed (related to switches).
831
832
  */
832
- interface on_gui_switch_state_changed extends event {
833
+ interface on_gui_switch_state_changed extends event {
833
834
  /**
834
835
  * The switch whose switch state changed.
835
836
  */
@@ -840,9 +841,9 @@ interface on_gui_switch_state_changed extends event {
840
841
  player_index: number
841
842
  }
842
843
  /**
843
- * Called when {@link LuaGuiElement | LuaGuiElement} text is changed by the player.
844
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} text is changed by the player.
844
845
  */
845
- interface on_gui_text_changed extends event {
846
+ interface on_gui_text_changed extends event {
846
847
  /**
847
848
  * The edited element.
848
849
  */
@@ -857,9 +858,9 @@ interface on_gui_text_changed extends event {
857
858
  text: string
858
859
  }
859
860
  /**
860
- * Called when {@link LuaGuiElement | LuaGuiElement} slider value is changed (related to the slider element).
861
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} slider value is changed (related to the slider element).
861
862
  */
862
- interface on_gui_value_changed extends event {
863
+ interface on_gui_value_changed extends event {
863
864
  /**
864
865
  * The element whose value changed.
865
866
  */
@@ -872,13 +873,13 @@ interface on_gui_value_changed extends event {
872
873
  /**
873
874
  * Called when a land mine is armed.
874
875
  */
875
- interface on_land_mine_armed extends event {
876
+ interface on_land_mine_armed extends event {
876
877
  mine: LuaEntity
877
878
  }
878
879
  /**
879
880
  * Called when a custom Lua shortcut is pressed.
880
881
  */
881
- interface on_lua_shortcut extends event {
882
+ interface on_lua_shortcut extends event {
882
883
  player_index: number
883
884
  /**
884
885
  * Shortcut prototype name of the shortcut that was clicked.
@@ -886,16 +887,16 @@ interface on_lua_shortcut extends event {
886
887
  prototype_name: string
887
888
  }
888
889
  /**
889
- * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter | LuaEntityMarkedForDeconstructionEventFilter}.
890
+ * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter | runtime:LuaEntityMarkedForDeconstructionEventFilter}.
890
891
  */
891
- interface on_marked_for_deconstruction extends event {
892
+ interface on_marked_for_deconstruction extends event {
892
893
  entity: LuaEntity
893
894
  player_index?: number
894
895
  }
895
896
  /**
896
- * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter | LuaEntityMarkedForUpgradeEventFilter}.
897
+ * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter | runtime:LuaEntityMarkedForUpgradeEventFilter}.
897
898
  */
898
- interface on_marked_for_upgrade extends event {
899
+ interface on_marked_for_upgrade extends event {
899
900
  /**
900
901
  * The new direction (if any)
901
902
  */
@@ -907,7 +908,7 @@ interface on_marked_for_upgrade extends event {
907
908
  /**
908
909
  * Called after a player purchases some offer from a `market` entity.
909
910
  */
910
- interface on_market_item_purchased extends event {
911
+ interface on_market_item_purchased extends event {
911
912
  /**
912
913
  * The amount of offers purchased.
913
914
  */
@@ -928,7 +929,7 @@ interface on_market_item_purchased extends event {
928
929
  /**
929
930
  * Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
930
931
  */
931
- interface on_mod_item_opened extends event {
932
+ interface on_mod_item_opened extends event {
932
933
  /**
933
934
  * The item clicked on.
934
935
  */
@@ -941,7 +942,7 @@ interface on_mod_item_opened extends event {
941
942
  /**
942
943
  * Called directly after a permission group is added.
943
944
  */
944
- interface on_permission_group_added extends event {
945
+ interface on_permission_group_added extends event {
945
946
  /**
946
947
  * The group added.
947
948
  */
@@ -954,7 +955,7 @@ interface on_permission_group_added extends event {
954
955
  /**
955
956
  * Called directly after a permission group is deleted.
956
957
  */
957
- interface on_permission_group_deleted extends event {
958
+ interface on_permission_group_deleted extends event {
958
959
  /**
959
960
  * The group that was deleted.
960
961
  */
@@ -971,7 +972,7 @@ interface on_permission_group_deleted extends event {
971
972
  /**
972
973
  * Called directly after a permission group is edited in some way.
973
974
  */
974
- interface on_permission_group_edited extends event {
975
+ interface on_permission_group_edited extends event {
975
976
  /**
976
977
  * The action when the `type` is "add-permission" or "remove-permission".
977
978
  */
@@ -1004,7 +1005,7 @@ interface on_permission_group_edited extends event {
1004
1005
  /**
1005
1006
  * Called directly after a permission string is imported.
1006
1007
  */
1007
- interface on_permission_string_imported extends event {
1008
+ interface on_permission_string_imported extends event {
1008
1009
  /**
1009
1010
  * The player that imported the string.
1010
1011
  */
@@ -1013,14 +1014,14 @@ interface on_permission_string_imported extends event {
1013
1014
  /**
1014
1015
  * Called when a player picks up an item.
1015
1016
  */
1016
- interface on_picked_up_item extends event {
1017
+ interface on_picked_up_item extends event {
1017
1018
  item_stack: SimpleItemStack
1018
1019
  player_index: number
1019
1020
  }
1020
1021
  /**
1021
1022
  * Called after a player alt-reverse-selects an area with a selection-tool item.
1022
1023
  */
1023
- interface on_player_alt_reverse_selected_area extends event {
1024
+ interface on_player_alt_reverse_selected_area extends event {
1024
1025
  /**
1025
1026
  * The area selected.
1026
1027
  */
@@ -1049,7 +1050,7 @@ interface on_player_alt_reverse_selected_area extends event {
1049
1050
  /**
1050
1051
  * Called after a player alt-selects an area with a selection-tool item.
1051
1052
  */
1052
- interface on_player_alt_selected_area extends event {
1053
+ interface on_player_alt_selected_area extends event {
1053
1054
  /**
1054
1055
  * The area selected.
1055
1056
  */
@@ -1078,19 +1079,19 @@ interface on_player_alt_selected_area extends event {
1078
1079
  /**
1079
1080
  * Called after a players ammo inventory changed in some way.
1080
1081
  */
1081
- interface on_player_ammo_inventory_changed extends event {
1082
+ interface on_player_ammo_inventory_changed extends event {
1082
1083
  player_index: number
1083
1084
  }
1084
1085
  /**
1085
1086
  * Called after a players armor inventory changed in some way.
1086
1087
  */
1087
- interface on_player_armor_inventory_changed extends event {
1088
+ interface on_player_armor_inventory_changed extends event {
1088
1089
  player_index: number
1089
1090
  }
1090
1091
  /**
1091
1092
  * Called when a player is banned.
1092
1093
  */
1093
- interface on_player_banned extends event {
1094
+ interface on_player_banned extends event {
1094
1095
  /**
1095
1096
  * The player that did the banning if any.
1096
1097
  */
@@ -1111,7 +1112,7 @@ interface on_player_banned extends event {
1111
1112
  /**
1112
1113
  * Called after a player builds tiles.
1113
1114
  */
1114
- interface on_player_built_tile extends event {
1115
+ interface on_player_built_tile extends event {
1115
1116
  /**
1116
1117
  * The item type used to build the tiles
1117
1118
  */
@@ -1137,7 +1138,7 @@ interface on_player_built_tile extends event {
1137
1138
  /**
1138
1139
  * Called when a player cancels crafting.
1139
1140
  */
1140
- interface on_player_cancelled_crafting extends event {
1141
+ interface on_player_cancelled_crafting extends event {
1141
1142
  /**
1142
1143
  * The number of crafts that have been cancelled.
1143
1144
  */
@@ -1158,7 +1159,7 @@ interface on_player_cancelled_crafting extends event {
1158
1159
  /**
1159
1160
  * Called after a player changes forces.
1160
1161
  */
1161
- interface on_player_changed_force extends event {
1162
+ interface on_player_changed_force extends event {
1162
1163
  /**
1163
1164
  * The old force.
1164
1165
  */
@@ -1171,7 +1172,7 @@ interface on_player_changed_force extends event {
1171
1172
  /**
1172
1173
  * Called when the tile position a player is located at changes.
1173
1174
  */
1174
- interface on_player_changed_position extends event {
1175
+ interface on_player_changed_position extends event {
1175
1176
  /**
1176
1177
  * The player.
1177
1178
  */
@@ -1183,7 +1184,7 @@ interface on_player_changed_position extends event {
1183
1184
  * In the instance a player is moved off a surface due to it being deleted this is not called.
1184
1185
  *
1185
1186
  */
1186
- interface on_player_changed_surface extends event {
1187
+ interface on_player_changed_surface extends event {
1187
1188
  /**
1188
1189
  * The player who changed surfaces.
1189
1190
  */
@@ -1196,7 +1197,7 @@ interface on_player_changed_surface extends event {
1196
1197
  /**
1197
1198
  * Called when cheat mode is disabled on a player.
1198
1199
  */
1199
- interface on_player_cheat_mode_disabled extends event {
1200
+ interface on_player_cheat_mode_disabled extends event {
1200
1201
  /**
1201
1202
  * The player.
1202
1203
  */
@@ -1205,7 +1206,7 @@ interface on_player_cheat_mode_disabled extends event {
1205
1206
  /**
1206
1207
  * Called when cheat mode is enabled on a player.
1207
1208
  */
1208
- interface on_player_cheat_mode_enabled extends event {
1209
+ interface on_player_cheat_mode_enabled extends event {
1209
1210
  /**
1210
1211
  * The player.
1211
1212
  */
@@ -1214,7 +1215,7 @@ interface on_player_cheat_mode_enabled extends event {
1214
1215
  /**
1215
1216
  * Called when a player clicks a gps tag
1216
1217
  */
1217
- interface on_player_clicked_gps_tag extends event {
1218
+ interface on_player_clicked_gps_tag extends event {
1218
1219
  /**
1219
1220
  * Index of the player
1220
1221
  */
@@ -1231,7 +1232,7 @@ interface on_player_clicked_gps_tag extends event {
1231
1232
  /**
1232
1233
  * Called when a player clicks the "confirm" button in the configure Blueprint GUI.
1233
1234
  */
1234
- interface on_player_configured_blueprint extends event {
1235
+ interface on_player_configured_blueprint extends event {
1235
1236
  /**
1236
1237
  * The player.
1237
1238
  */
@@ -1240,7 +1241,7 @@ interface on_player_configured_blueprint extends event {
1240
1241
  /**
1241
1242
  * Called when a player configures spidertron remote to be connected with a given spidertron
1242
1243
  */
1243
- interface on_player_configured_spider_remote extends event {
1244
+ interface on_player_configured_spider_remote extends event {
1244
1245
  /**
1245
1246
  * The player that configured the remote.
1246
1247
  */
@@ -1251,9 +1252,9 @@ interface on_player_configured_spider_remote extends event {
1251
1252
  vehicle: LuaEntity
1252
1253
  }
1253
1254
  /**
1254
- * 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 | on_pre_player_crafted_item}).
1255
+ * 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}).
1255
1256
  */
1256
- interface on_player_crafted_item extends event {
1257
+ interface on_player_crafted_item extends event {
1257
1258
  /**
1258
1259
  * The item that has been crafted.
1259
1260
  */
@@ -1270,19 +1271,19 @@ interface on_player_crafted_item extends event {
1270
1271
  /**
1271
1272
  * Called after the player was created.
1272
1273
  */
1273
- interface on_player_created extends event {
1274
+ interface on_player_created extends event {
1274
1275
  player_index: number
1275
1276
  }
1276
1277
  /**
1277
- * Called after a player's {@link cursor stack | LuaControl::cursor_stack} changed in some way.
1278
+ * Called after a player's {@link cursor stack | runtime:LuaControl::cursor_stack} changed in some way.
1278
1279
  */
1279
- interface on_player_cursor_stack_changed extends event {
1280
+ interface on_player_cursor_stack_changed extends event {
1280
1281
  player_index: number
1281
1282
  }
1282
1283
  /**
1283
1284
  * Called when a player selects an area with a deconstruction planner.
1284
1285
  */
1285
- interface on_player_deconstructed_area extends event {
1286
+ interface on_player_deconstructed_area extends event {
1286
1287
  /**
1287
1288
  * If normal selection or alt selection was used.
1288
1289
  */
@@ -1307,7 +1308,7 @@ interface on_player_deconstructed_area extends event {
1307
1308
  /**
1308
1309
  * Called when a player is demoted.
1309
1310
  */
1310
- interface on_player_demoted extends event {
1311
+ interface on_player_demoted extends event {
1311
1312
  /**
1312
1313
  * The player.
1313
1314
  */
@@ -1316,14 +1317,14 @@ interface on_player_demoted extends event {
1316
1317
  /**
1317
1318
  * Called after a player dies.
1318
1319
  */
1319
- interface on_player_died extends event {
1320
+ interface on_player_died extends event {
1320
1321
  cause?: LuaEntity
1321
1322
  player_index: number
1322
1323
  }
1323
1324
  /**
1324
1325
  * Called when the display resolution changes for a given player.
1325
1326
  */
1326
- interface on_player_display_resolution_changed extends event {
1327
+ interface on_player_display_resolution_changed extends event {
1327
1328
  /**
1328
1329
  * The old display resolution
1329
1330
  */
@@ -1336,7 +1337,7 @@ interface on_player_display_resolution_changed extends event {
1336
1337
  /**
1337
1338
  * Called when the display scale changes for a given player.
1338
1339
  */
1339
- interface on_player_display_scale_changed extends event {
1340
+ interface on_player_display_scale_changed extends event {
1340
1341
  /**
1341
1342
  * The old display scale
1342
1343
  */
@@ -1352,7 +1353,7 @@ interface on_player_display_scale_changed extends event {
1352
1353
  * This event is not raised when the player is ejected from a vehicle due to it being destroyed.
1353
1354
  *
1354
1355
  */
1355
- interface on_player_driving_changed_state extends event {
1356
+ interface on_player_driving_changed_state extends event {
1356
1357
  /**
1357
1358
  * The vehicle if any.
1358
1359
  */
@@ -1362,7 +1363,7 @@ interface on_player_driving_changed_state extends event {
1362
1363
  /**
1363
1364
  * Called when a player drops an item on the ground.
1364
1365
  */
1365
- interface on_player_dropped_item extends event {
1366
+ interface on_player_dropped_item extends event {
1366
1367
  /**
1367
1368
  * The item-on-ground entity.
1368
1369
  */
@@ -1372,7 +1373,7 @@ interface on_player_dropped_item extends event {
1372
1373
  /**
1373
1374
  * Called when a player fast-transfers something to or from an entity.
1374
1375
  */
1375
- interface on_player_fast_transferred extends event {
1376
+ interface on_player_fast_transferred extends event {
1376
1377
  /**
1377
1378
  * The entity transferred from or to.
1378
1379
  */
@@ -1393,7 +1394,7 @@ interface on_player_fast_transferred extends event {
1393
1394
  /**
1394
1395
  * Called after player flushed fluid
1395
1396
  */
1396
- interface on_player_flushed_fluid extends event {
1397
+ interface on_player_flushed_fluid extends event {
1397
1398
  /**
1398
1399
  * Amount of fluid that was removed
1399
1400
  */
@@ -1418,16 +1419,16 @@ interface on_player_flushed_fluid extends event {
1418
1419
  /**
1419
1420
  * Called after a players gun inventory changed in some way.
1420
1421
  */
1421
- interface on_player_gun_inventory_changed extends event {
1422
+ interface on_player_gun_inventory_changed extends event {
1422
1423
  player_index: number
1423
1424
  }
1424
1425
  /**
1425
1426
  * Called when a player's input method changes.
1426
1427
  * @remarks
1427
- * See {@link LuaPlayer::input_method | LuaPlayer::input_method}.
1428
+ * See {@link LuaPlayer::input_method | runtime:LuaPlayer::input_method}.
1428
1429
  *
1429
1430
  */
1430
- interface on_player_input_method_changed extends event {
1431
+ interface on_player_input_method_changed extends event {
1431
1432
  /**
1432
1433
  * The player whose input method changed.
1433
1434
  */
@@ -1436,13 +1437,13 @@ interface on_player_input_method_changed extends event {
1436
1437
  /**
1437
1438
  * 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.
1438
1439
  */
1439
- interface on_player_joined_game extends event {
1440
+ interface on_player_joined_game extends event {
1440
1441
  player_index: number
1441
1442
  }
1442
1443
  /**
1443
1444
  * Called when a player is kicked.
1444
1445
  */
1445
- interface on_player_kicked extends event {
1446
+ interface on_player_kicked extends event {
1446
1447
  /**
1447
1448
  * The player that did the kicking if any.
1448
1449
  */
@@ -1459,23 +1460,23 @@ interface on_player_kicked extends event {
1459
1460
  /**
1460
1461
  * 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.
1461
1462
  */
1462
- interface on_player_left_game extends event {
1463
+ interface on_player_left_game extends event {
1463
1464
  player_index: number
1464
1465
  reason: defines.disconnect_reason
1465
1466
  }
1466
1467
  /**
1467
1468
  * Called after a players main inventory changed in some way.
1468
1469
  */
1469
- interface on_player_main_inventory_changed extends event {
1470
+ interface on_player_main_inventory_changed extends event {
1470
1471
  player_index: number
1471
1472
  }
1472
1473
  /**
1473
- * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using {@link LuaPlayerMinedEntityEventFilter | LuaPlayerMinedEntityEventFilter}.
1474
+ * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using {@link LuaPlayerMinedEntityEventFilter | runtime:LuaPlayerMinedEntityEventFilter}.
1474
1475
  * @remarks
1475
1476
  * The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
1476
1477
  *
1477
1478
  */
1478
- interface on_player_mined_entity extends event {
1479
+ interface on_player_mined_entity extends event {
1479
1480
  /**
1480
1481
  * The temporary inventory that holds the result of mining the entity.
1481
1482
  */
@@ -1492,7 +1493,7 @@ interface on_player_mined_entity extends event {
1492
1493
  /**
1493
1494
  * Called when the player mines something.
1494
1495
  */
1495
- interface on_player_mined_item extends event {
1496
+ interface on_player_mined_item extends event {
1496
1497
  /**
1497
1498
  * The item given to the player
1498
1499
  */
@@ -1502,7 +1503,7 @@ interface on_player_mined_item extends event {
1502
1503
  /**
1503
1504
  * Called after a player mines tiles.
1504
1505
  */
1505
- interface on_player_mined_tile extends event {
1506
+ interface on_player_mined_tile extends event {
1506
1507
  player_index: number
1507
1508
  /**
1508
1509
  * The surface the tile(s) were mined from.
@@ -1516,7 +1517,7 @@ interface on_player_mined_tile extends event {
1516
1517
  /**
1517
1518
  * Called when a player is muted.
1518
1519
  */
1519
- interface on_player_muted extends event {
1520
+ interface on_player_muted extends event {
1520
1521
  /**
1521
1522
  * The player.
1522
1523
  */
@@ -1525,7 +1526,7 @@ interface on_player_muted extends event {
1525
1526
  /**
1526
1527
  * Called when a player invokes the "smart pipette" over an entity.
1527
1528
  */
1528
- interface on_player_pipette extends event {
1529
+ interface on_player_pipette extends event {
1529
1530
  /**
1530
1531
  * The item put in the cursor
1531
1532
  */
@@ -1542,7 +1543,7 @@ interface on_player_pipette extends event {
1542
1543
  /**
1543
1544
  * Called after the player puts equipment in an equipment grid
1544
1545
  */
1545
- interface on_player_placed_equipment extends event {
1546
+ interface on_player_placed_equipment extends event {
1546
1547
  /**
1547
1548
  * The equipment put in the equipment grid.
1548
1549
  */
@@ -1556,16 +1557,16 @@ interface on_player_placed_equipment extends event {
1556
1557
  /**
1557
1558
  * Called when a player is promoted.
1558
1559
  */
1559
- interface on_player_promoted extends event {
1560
+ interface on_player_promoted extends event {
1560
1561
  /**
1561
1562
  * The player.
1562
1563
  */
1563
1564
  player_index: number
1564
1565
  }
1565
1566
  /**
1566
- * Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | on_player_left_game} the game, and instead behaves like the player never existed in the save file.
1567
+ * 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.
1567
1568
  */
1568
- interface on_player_removed extends event {
1569
+ interface on_player_removed extends event {
1569
1570
  /**
1570
1571
  * The index of the removed player.
1571
1572
  */
@@ -1574,7 +1575,7 @@ interface on_player_removed extends event {
1574
1575
  /**
1575
1576
  * Called after the player removes equipment from an equipment grid
1576
1577
  */
1577
- interface on_player_removed_equipment extends event {
1578
+ interface on_player_removed_equipment extends event {
1578
1579
  /**
1579
1580
  * The count of equipment removed.
1580
1581
  */
@@ -1590,16 +1591,16 @@ interface on_player_removed_equipment extends event {
1590
1591
  player_index: number
1591
1592
  }
1592
1593
  /**
1593
- * Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter | LuaPlayerRepairedEntityEventFilter}.
1594
+ * Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter | runtime:LuaPlayerRepairedEntityEventFilter}.
1594
1595
  */
1595
- interface on_player_repaired_entity extends event {
1596
+ interface on_player_repaired_entity extends event {
1596
1597
  entity: LuaEntity
1597
1598
  player_index: number
1598
1599
  }
1599
1600
  /**
1600
1601
  * Called after a player respawns.
1601
1602
  */
1602
- interface on_player_respawned extends event {
1603
+ interface on_player_respawned extends event {
1603
1604
  player_index: number
1604
1605
  /**
1605
1606
  * The player port used to respawn if one was used.
@@ -1609,7 +1610,7 @@ interface on_player_respawned extends event {
1609
1610
  /**
1610
1611
  * Called after a player reverse-selects an area with a selection-tool item.
1611
1612
  */
1612
- interface on_player_reverse_selected_area extends event {
1613
+ interface on_player_reverse_selected_area extends event {
1613
1614
  /**
1614
1615
  * The area selected.
1615
1616
  */
@@ -1638,7 +1639,7 @@ interface on_player_reverse_selected_area extends event {
1638
1639
  /**
1639
1640
  * Called when the player rotates an entity. This event is only fired when the entity actually changes its orientation -- pressing the rotate key on an entity that can't be rotated won't fire this event.
1640
1641
  */
1641
- interface on_player_rotated_entity extends event {
1642
+ interface on_player_rotated_entity extends event {
1642
1643
  /**
1643
1644
  * The rotated entity.
1644
1645
  */
@@ -1652,7 +1653,7 @@ interface on_player_rotated_entity extends event {
1652
1653
  /**
1653
1654
  * Called after a player selects an area with a selection-tool item.
1654
1655
  */
1655
- interface on_player_selected_area extends event {
1656
+ interface on_player_selected_area extends event {
1656
1657
  /**
1657
1658
  * The area selected.
1658
1659
  */
@@ -1681,13 +1682,13 @@ interface on_player_selected_area extends event {
1681
1682
  /**
1682
1683
  * Called when a player sets a quickbar slot to anything (new value, or set to empty).
1683
1684
  */
1684
- interface on_player_set_quick_bar_slot extends event {
1685
+ interface on_player_set_quick_bar_slot extends event {
1685
1686
  player_index: number
1686
1687
  }
1687
1688
  /**
1688
1689
  * Called when a player selects an area with a blueprint.
1689
1690
  */
1690
- interface on_player_setup_blueprint extends event {
1691
+ interface on_player_setup_blueprint extends event {
1691
1692
  /**
1692
1693
  * If normal selection or alt selection was used.
1693
1694
  */
@@ -1716,9 +1717,9 @@ interface on_player_setup_blueprint extends event {
1716
1717
  /**
1717
1718
  * Called when a player toggles alt mode, also known as "show entity info".
1718
1719
  */
1719
- interface on_player_toggled_alt_mode extends event {
1720
+ interface on_player_toggled_alt_mode extends event {
1720
1721
  /**
1721
- * The new alt mode value. This value is a shortcut for accessing {@link GameViewSettings::show_entity_info | GameViewSettings::show_entity_info} on the player.
1722
+ * The new alt mode value. This value is a shortcut for accessing {@link GameViewSettings::show_entity_info | runtime:GameViewSettings::show_entity_info} on the player.
1722
1723
  */
1723
1724
  alt_mode: boolean
1724
1725
  player_index: number
@@ -1726,19 +1727,19 @@ interface on_player_toggled_alt_mode extends event {
1726
1727
  /**
1727
1728
  * Called when a player toggles the map editor on or off.
1728
1729
  */
1729
- interface on_player_toggled_map_editor extends event {
1730
+ interface on_player_toggled_map_editor extends event {
1730
1731
  player_index: number
1731
1732
  }
1732
1733
  /**
1733
1734
  * Called after a players trash inventory changed in some way.
1734
1735
  */
1735
- interface on_player_trash_inventory_changed extends event {
1736
+ interface on_player_trash_inventory_changed extends event {
1736
1737
  player_index: number
1737
1738
  }
1738
1739
  /**
1739
1740
  * Called when a player is un-banned.
1740
1741
  */
1741
- interface on_player_unbanned extends event {
1742
+ interface on_player_unbanned extends event {
1742
1743
  /**
1743
1744
  * The player that did the un-banning if any.
1744
1745
  */
@@ -1759,7 +1760,7 @@ interface on_player_unbanned extends event {
1759
1760
  /**
1760
1761
  * Called when a player is unmuted.
1761
1762
  */
1762
- interface on_player_unmuted extends event {
1763
+ interface on_player_unmuted extends event {
1763
1764
  /**
1764
1765
  * The player.
1765
1766
  */
@@ -1768,7 +1769,7 @@ interface on_player_unmuted extends event {
1768
1769
  /**
1769
1770
  * Called when a player uses a capsule that results in some game action.
1770
1771
  */
1771
- interface on_player_used_capsule extends event {
1772
+ interface on_player_used_capsule extends event {
1772
1773
  /**
1773
1774
  * The capsule item used.
1774
1775
  */
@@ -1785,7 +1786,7 @@ interface on_player_used_capsule extends event {
1785
1786
  /**
1786
1787
  * Called when a player uses spidertron remote to send a spidertron to a given position
1787
1788
  */
1788
- interface on_player_used_spider_remote extends event {
1789
+ interface on_player_used_spider_remote extends event {
1789
1790
  /**
1790
1791
  * The player that used the remote.
1791
1792
  */
@@ -1804,9 +1805,9 @@ interface on_player_used_spider_remote extends event {
1804
1805
  vehicle: LuaEntity
1805
1806
  }
1806
1807
  /**
1807
- * Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter | LuaPostEntityDiedEventFilter}.
1808
+ * Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter | runtime:LuaPostEntityDiedEventFilter}.
1808
1809
  */
1809
- interface on_post_entity_died extends event {
1810
+ interface on_post_entity_died extends event {
1810
1811
  /**
1811
1812
  * The corpses created by the entity dying if any.
1812
1813
  */
@@ -1841,9 +1842,9 @@ interface on_post_entity_died extends event {
1841
1842
  unit_number?: number
1842
1843
  }
1843
1844
  /**
1844
- * Called when players uses an item to build something. Called before {@link on_built_entity | on_built_entity}.
1845
+ * Called when players uses an item to build something. Called before {@link on_built_entity | runtime:on_built_entity}.
1845
1846
  */
1846
- interface on_pre_build extends event {
1847
+ interface on_pre_build extends event {
1847
1848
  /**
1848
1849
  * Whether the item was placed while moving.
1849
1850
  */
@@ -1874,9 +1875,9 @@ interface on_pre_build extends event {
1874
1875
  shift_build: boolean
1875
1876
  }
1876
1877
  /**
1877
- * Called before one or more chunks are deleted using {@link LuaSurface::delete_chunk | LuaSurface::delete_chunk}.
1878
+ * Called before one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
1878
1879
  */
1879
- interface on_pre_chunk_deleted extends event {
1880
+ interface on_pre_chunk_deleted extends event {
1880
1881
  /**
1881
1882
  * The chunks to be deleted.
1882
1883
  */
@@ -1886,7 +1887,7 @@ interface on_pre_chunk_deleted extends event {
1886
1887
  /**
1887
1888
  * Called before entity copy-paste is done.
1888
1889
  */
1889
- interface on_pre_entity_settings_pasted extends event {
1890
+ interface on_pre_entity_settings_pasted extends event {
1890
1891
  /**
1891
1892
  * The destination entity settings will be copied to.
1892
1893
  */
@@ -1898,9 +1899,9 @@ interface on_pre_entity_settings_pasted extends event {
1898
1899
  source: LuaEntity
1899
1900
  }
1900
1901
  /**
1901
- * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter | LuaPreGhostDeconstructedEventFilter}.
1902
+ * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter | runtime:LuaPreGhostDeconstructedEventFilter}.
1902
1903
  */
1903
- interface on_pre_ghost_deconstructed extends event {
1904
+ interface on_pre_ghost_deconstructed extends event {
1904
1905
  ghost: LuaEntity
1905
1906
  /**
1906
1907
  * The player that did the deconstruction if any.
@@ -1908,9 +1909,9 @@ interface on_pre_ghost_deconstructed extends event {
1908
1909
  player_index?: number
1909
1910
  }
1910
1911
  /**
1911
- * Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter | LuaPreGhostUpgradedEventFilter}.
1912
+ * Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter | runtime:LuaPreGhostUpgradedEventFilter}.
1912
1913
  */
1913
- interface on_pre_ghost_upgraded extends event {
1914
+ interface on_pre_ghost_upgraded extends event {
1914
1915
  ghost: LuaEntity
1915
1916
  /**
1916
1917
  * The player that did the upgrade if any.
@@ -1921,7 +1922,7 @@ interface on_pre_ghost_upgraded extends event {
1921
1922
  /**
1922
1923
  * Called directly before a permission group is deleted.
1923
1924
  */
1924
- interface on_pre_permission_group_deleted extends event {
1925
+ interface on_pre_permission_group_deleted extends event {
1925
1926
  /**
1926
1927
  * The group to be deleted.
1927
1928
  */
@@ -1934,7 +1935,7 @@ interface on_pre_permission_group_deleted extends event {
1934
1935
  /**
1935
1936
  * Called directly before a permission string is imported.
1936
1937
  */
1937
- interface on_pre_permission_string_imported extends event {
1938
+ interface on_pre_permission_string_imported extends event {
1938
1939
  /**
1939
1940
  * The player importing the string.
1940
1941
  */
@@ -1943,7 +1944,7 @@ interface on_pre_permission_string_imported extends event {
1943
1944
  /**
1944
1945
  * Called when a player queues something to be crafted.
1945
1946
  */
1946
- interface on_pre_player_crafted_item extends event {
1947
+ interface on_pre_player_crafted_item extends event {
1947
1948
  /**
1948
1949
  * The items removed from the players inventory to do the crafting.
1949
1950
  */
@@ -1964,21 +1965,21 @@ interface on_pre_player_crafted_item extends event {
1964
1965
  /**
1965
1966
  * Called before a players dies.
1966
1967
  */
1967
- interface on_pre_player_died extends event {
1968
+ interface on_pre_player_died extends event {
1968
1969
  cause?: LuaEntity
1969
1970
  player_index: number
1970
1971
  }
1971
1972
  /**
1972
1973
  * Called before a player leaves the game.
1973
1974
  */
1974
- interface on_pre_player_left_game extends event {
1975
+ interface on_pre_player_left_game extends event {
1975
1976
  player_index: number
1976
1977
  reason: defines.disconnect_reason
1977
1978
  }
1978
1979
  /**
1979
- * 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. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter | LuaPrePlayerMinedEntityEventFilter}.
1980
+ * 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. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter | runtime:LuaPrePlayerMinedEntityEventFilter}.
1980
1981
  */
1981
- interface on_pre_player_mined_item extends event {
1982
+ interface on_pre_player_mined_item extends event {
1982
1983
  /**
1983
1984
  * The entity being mined
1984
1985
  */
@@ -1986,9 +1987,9 @@ interface on_pre_player_mined_item extends event {
1986
1987
  player_index: number
1987
1988
  }
1988
1989
  /**
1989
- * Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | on_player_left_game} the game, and instead behaves like the player never existed in the save file.
1990
+ * 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.
1990
1991
  */
1991
- interface on_pre_player_removed extends event {
1992
+ interface on_pre_player_removed extends event {
1992
1993
  /**
1993
1994
  * The index of the removed player.
1994
1995
  */
@@ -1997,13 +1998,13 @@ interface on_pre_player_removed extends event {
1997
1998
  /**
1998
1999
  * Called before a player toggles the map editor on or off.
1999
2000
  */
2000
- interface on_pre_player_toggled_map_editor extends event {
2001
+ interface on_pre_player_toggled_map_editor extends event {
2001
2002
  player_index: number
2002
2003
  }
2003
2004
  /**
2004
2005
  * Called directly before a robot explodes cliffs.
2005
2006
  */
2006
- interface on_pre_robot_exploded_cliff extends event {
2007
+ interface on_pre_robot_exploded_cliff extends event {
2007
2008
  cliff: LuaEntity
2008
2009
  /**
2009
2010
  * The cliff explosive used.
@@ -2014,7 +2015,7 @@ interface on_pre_robot_exploded_cliff extends event {
2014
2015
  /**
2015
2016
  * Called just before a script inventory is resized.
2016
2017
  */
2017
- interface on_pre_script_inventory_resized extends event {
2018
+ interface on_pre_script_inventory_resized extends event {
2018
2019
  inventory: LuaInventory
2019
2020
  /**
2020
2021
  * The mod that did the resizing. This will be `"core"` if done by console command or scenario script.
@@ -2036,19 +2037,19 @@ interface on_pre_script_inventory_resized extends event {
2036
2037
  /**
2037
2038
  * Called just before a surface is cleared (all entities removed and all chunks deleted).
2038
2039
  */
2039
- interface on_pre_surface_cleared extends event {
2040
+ interface on_pre_surface_cleared extends event {
2040
2041
  surface_index: number
2041
2042
  }
2042
2043
  /**
2043
2044
  * Called just before a surface is deleted.
2044
2045
  */
2045
- interface on_pre_surface_deleted extends event {
2046
+ interface on_pre_surface_deleted extends event {
2046
2047
  surface_index: number
2047
2048
  }
2048
2049
  /**
2049
2050
  * Called when research is cancelled.
2050
2051
  */
2051
- interface on_research_cancelled extends event {
2052
+ interface on_research_cancelled extends event {
2052
2053
  /**
2053
2054
  * The force whose research was cancelled.
2054
2055
  */
@@ -2061,7 +2062,7 @@ interface on_research_cancelled extends event {
2061
2062
  /**
2062
2063
  * Called when a research finishes.
2063
2064
  */
2064
- interface on_research_finished extends event {
2065
+ interface on_research_finished extends event {
2065
2066
  /**
2066
2067
  * If the technology was researched by script.
2067
2068
  */
@@ -2074,7 +2075,7 @@ interface on_research_finished extends event {
2074
2075
  /**
2075
2076
  * Called when a research is reversed (unresearched).
2076
2077
  */
2077
- interface on_research_reversed extends event {
2078
+ interface on_research_reversed extends event {
2078
2079
  /**
2079
2080
  * If the technology was un-researched by script.
2080
2081
  */
@@ -2087,7 +2088,7 @@ interface on_research_reversed extends event {
2087
2088
  /**
2088
2089
  * Called when a technology research starts.
2089
2090
  */
2090
- interface on_research_started extends event {
2091
+ interface on_research_started extends event {
2091
2092
  last_research?: LuaTechnology
2092
2093
  /**
2093
2094
  * The technology being researched
@@ -2097,13 +2098,13 @@ interface on_research_started extends event {
2097
2098
  /**
2098
2099
  * Called when a resource entity reaches 0 or its minimum yield for infinite resources.
2099
2100
  */
2100
- interface on_resource_depleted extends event {
2101
+ interface on_resource_depleted extends event {
2101
2102
  entity: LuaEntity
2102
2103
  }
2103
2104
  /**
2104
- * Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter | LuaRobotBuiltEntityEventFilter}.
2105
+ * Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter | runtime:LuaRobotBuiltEntityEventFilter}.
2105
2106
  */
2106
- interface on_robot_built_entity extends event {
2107
+ interface on_robot_built_entity extends event {
2107
2108
  /**
2108
2109
  * The entity built.
2109
2110
  */
@@ -2124,7 +2125,7 @@ interface on_robot_built_entity extends event {
2124
2125
  /**
2125
2126
  * Called after a robot builds tiles.
2126
2127
  */
2127
- interface on_robot_built_tile extends event {
2128
+ interface on_robot_built_tile extends event {
2128
2129
  /**
2129
2130
  * The item type used to build the tiles.
2130
2131
  */
@@ -2153,7 +2154,7 @@ interface on_robot_built_tile extends event {
2153
2154
  /**
2154
2155
  * Called directly after a robot explodes cliffs.
2155
2156
  */
2156
- interface on_robot_exploded_cliff extends event {
2157
+ interface on_robot_exploded_cliff extends event {
2157
2158
  /**
2158
2159
  * The cliff explosive used.
2159
2160
  */
@@ -2163,7 +2164,7 @@ interface on_robot_exploded_cliff extends event {
2163
2164
  /**
2164
2165
  * Called when a robot mines an entity.
2165
2166
  */
2166
- interface on_robot_mined extends event {
2167
+ interface on_robot_mined extends event {
2167
2168
  /**
2168
2169
  * The entity the robot just picked up.
2169
2170
  */
@@ -2174,12 +2175,12 @@ interface on_robot_mined extends event {
2174
2175
  robot: LuaEntity
2175
2176
  }
2176
2177
  /**
2177
- * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using {@link LuaRobotMinedEntityEventFilter | LuaRobotMinedEntityEventFilter}.
2178
+ * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using {@link LuaRobotMinedEntityEventFilter | runtime:LuaRobotMinedEntityEventFilter}.
2178
2179
  * @remarks
2179
2180
  * The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
2180
2181
  *
2181
2182
  */
2182
- interface on_robot_mined_entity extends event {
2183
+ interface on_robot_mined_entity extends event {
2183
2184
  /**
2184
2185
  * The temporary inventory that holds the result of mining the entity.
2185
2186
  */
@@ -2196,7 +2197,7 @@ interface on_robot_mined_entity extends event {
2196
2197
  /**
2197
2198
  * Called after a robot mines tiles.
2198
2199
  */
2199
- interface on_robot_mined_tile extends event {
2200
+ interface on_robot_mined_tile extends event {
2200
2201
  /**
2201
2202
  * The robot.
2202
2203
  */
@@ -2211,9 +2212,9 @@ interface on_robot_mined_tile extends event {
2211
2212
  tiles: OldTileAndPosition[]
2212
2213
  }
2213
2214
  /**
2214
- * Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter | LuaPreRobotMinedEntityEventFilter}.
2215
+ * Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter | runtime:LuaPreRobotMinedEntityEventFilter}.
2215
2216
  */
2216
- interface on_robot_pre_mined extends event {
2217
+ interface on_robot_pre_mined extends event {
2217
2218
  /**
2218
2219
  * The entity which is about to be mined.
2219
2220
  */
@@ -2226,7 +2227,7 @@ interface on_robot_pre_mined extends event {
2226
2227
  /**
2227
2228
  * Called when a rocket silo is ordered to be launched.
2228
2229
  */
2229
- interface on_rocket_launch_ordered extends event {
2230
+ interface on_rocket_launch_ordered extends event {
2230
2231
  /**
2231
2232
  * The player that is riding the rocket, if any.
2232
2233
  */
@@ -2237,7 +2238,7 @@ interface on_rocket_launch_ordered extends event {
2237
2238
  /**
2238
2239
  * Called when the rocket is launched.
2239
2240
  */
2240
- interface on_rocket_launched extends event {
2241
+ interface on_rocket_launched extends event {
2241
2242
  /**
2242
2243
  * The player that is riding the rocket, if any.
2243
2244
  */
@@ -2248,7 +2249,7 @@ interface on_rocket_launched extends event {
2248
2249
  /**
2249
2250
  * Called when a runtime mod setting is changed by a player.
2250
2251
  */
2251
- interface on_runtime_mod_setting_changed extends event {
2252
+ interface on_runtime_mod_setting_changed extends event {
2252
2253
  /**
2253
2254
  * If the `setting_type` is `"global"` and it was changed through the mod settings GUI, this is the index of the player that changed the global setting. If the `setting_type` is `"runtime-per-user"` and it changed a current setting of the player, this is the index of the player whose setting was changed. In all other cases, this is `nil`.
2254
2255
  */
@@ -2265,7 +2266,7 @@ interface on_runtime_mod_setting_changed extends event {
2265
2266
  /**
2266
2267
  * Called just after a script inventory is resized.
2267
2268
  */
2268
- interface on_script_inventory_resized extends event {
2269
+ interface on_script_inventory_resized extends event {
2269
2270
  inventory: LuaInventory
2270
2271
  /**
2271
2272
  * The mod that did the resizing. This will be `"core"` if done by console command or scenario script.
@@ -2289,11 +2290,11 @@ interface on_script_inventory_resized extends event {
2289
2290
  player_index?: number
2290
2291
  }
2291
2292
  /**
2292
- * Called when a {@link LuaSurface::request_path | LuaSurface::request_path} call completes.
2293
+ * Called when a {@link LuaSurface::request_path | runtime:LuaSurface::request_path} call completes.
2293
2294
  */
2294
- interface on_script_path_request_finished extends event {
2295
+ interface on_script_path_request_finished extends event {
2295
2296
  /**
2296
- * Handle to associate the callback with a particular call to {@link LuaSurface::request_path | LuaSurface::request_path}.
2297
+ * Handle to associate the callback with a particular call to {@link LuaSurface::request_path | runtime:LuaSurface::request_path}.
2297
2298
  */
2298
2299
  id: number
2299
2300
  /**
@@ -2308,7 +2309,7 @@ interface on_script_path_request_finished extends event {
2308
2309
  /**
2309
2310
  * Called when a script trigger effect is triggered.
2310
2311
  */
2311
- interface on_script_trigger_effect extends event {
2312
+ interface on_script_trigger_effect extends event {
2312
2313
  /**
2313
2314
  * The effect_id specified in the trigger effect.
2314
2315
  */
@@ -2323,9 +2324,9 @@ interface on_script_trigger_effect extends event {
2323
2324
  target_position?: MapPosition
2324
2325
  }
2325
2326
  /**
2326
- * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter | LuaSectorScannedEventFilter}.
2327
+ * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter | runtime:LuaSectorScannedEventFilter}.
2327
2328
  */
2328
- interface on_sector_scanned extends event {
2329
+ interface on_sector_scanned extends event {
2329
2330
  /**
2330
2331
  * Area of the scanned chunk.
2331
2332
  */
@@ -2342,7 +2343,7 @@ interface on_sector_scanned extends event {
2342
2343
  /**
2343
2344
  * Called after the selected entity changes for a given player.
2344
2345
  */
2345
- interface on_selected_entity_changed extends event {
2346
+ interface on_selected_entity_changed extends event {
2346
2347
  /**
2347
2348
  * The last selected entity if it still exists and there was one.
2348
2349
  */
@@ -2355,16 +2356,16 @@ interface on_selected_entity_changed extends event {
2355
2356
  /**
2356
2357
  * Called when a spider finishes moving to its autopilot position.
2357
2358
  */
2358
- interface on_spider_command_completed extends event {
2359
+ interface on_spider_command_completed extends event {
2359
2360
  /**
2360
2361
  * Spider vehicle which was requested to move.
2361
2362
  */
2362
2363
  vehicle: LuaEntity
2363
2364
  }
2364
2365
  /**
2365
- * Called when a translation request generated through {@link LuaPlayer::request_translation | LuaPlayer::request_translation} or {@link LuaPlayer::request_translations | LuaPlayer::request_translations} has been completed.
2366
+ * Called when a translation request generated through {@link LuaPlayer::request_translation | runtime:LuaPlayer::request_translation} or {@link LuaPlayer::request_translations | runtime:LuaPlayer::request_translations} has been completed.
2366
2367
  */
2367
- interface on_string_translated extends event {
2368
+ interface on_string_translated extends event {
2368
2369
  /**
2369
2370
  * The unique id for this translation request.
2370
2371
  */
@@ -2389,7 +2390,7 @@ interface on_string_translated extends event {
2389
2390
  /**
2390
2391
  * Called just after a surface is cleared (all entities removed and all chunks deleted).
2391
2392
  */
2392
- interface on_surface_cleared extends event {
2393
+ interface on_surface_cleared extends event {
2393
2394
  surface_index: number
2394
2395
  }
2395
2396
  /**
@@ -2398,19 +2399,19 @@ interface on_surface_cleared extends event {
2398
2399
  * This is not called when the default surface is created as it will always exist.
2399
2400
  *
2400
2401
  */
2401
- interface on_surface_created extends event {
2402
+ interface on_surface_created extends event {
2402
2403
  surface_index: number
2403
2404
  }
2404
2405
  /**
2405
2406
  * Called after a surface is deleted.
2406
2407
  */
2407
- interface on_surface_deleted extends event {
2408
+ interface on_surface_deleted extends event {
2408
2409
  surface_index: number
2409
2410
  }
2410
2411
  /**
2411
2412
  * Called after a surface is imported via the map editor.
2412
2413
  */
2413
- interface on_surface_imported extends event {
2414
+ interface on_surface_imported extends event {
2414
2415
  /**
2415
2416
  * The original surface name.
2416
2417
  */
@@ -2420,33 +2421,33 @@ interface on_surface_imported extends event {
2420
2421
  /**
2421
2422
  * Called when a surface is renamed.
2422
2423
  */
2423
- interface on_surface_renamed extends event {
2424
+ interface on_surface_renamed extends event {
2424
2425
  new_name: string
2425
2426
  old_name: string
2426
2427
  surface_index: number
2427
2428
  }
2428
2429
  /**
2429
- * Called when {@link LuaForce::reset_technology_effects | LuaForce::reset_technology_effects} is finished.
2430
+ * Called when {@link LuaForce::reset_technology_effects | runtime:LuaForce::reset_technology_effects} is finished.
2430
2431
  */
2431
- interface on_technology_effects_reset extends event {
2432
+ interface on_technology_effects_reset extends event {
2432
2433
  force: LuaForce
2433
2434
  }
2434
2435
  /**
2435
2436
  * It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
2436
2437
  */
2437
- interface on_tick extends event {
2438
+ interface on_tick extends event {
2438
2439
  }
2439
2440
  /**
2440
2441
  * Called when a train changes state (started to stopped and vice versa)
2441
2442
  */
2442
- interface on_train_changed_state extends event {
2443
+ interface on_train_changed_state extends event {
2443
2444
  old_state: defines.train_state
2444
2445
  train: LuaTrain
2445
2446
  }
2446
2447
  /**
2447
2448
  * Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
2448
2449
  */
2449
- interface on_train_created extends event {
2450
+ interface on_train_created extends event {
2450
2451
  /**
2451
2452
  * The first old train id when splitting/merging trains.
2452
2453
  */
@@ -2460,7 +2461,7 @@ interface on_train_created extends event {
2460
2461
  /**
2461
2462
  * Called when a trains schedule is changed either by the player or through script.
2462
2463
  */
2463
- interface on_train_schedule_changed extends event {
2464
+ interface on_train_schedule_changed extends event {
2464
2465
  /**
2465
2466
  * The player who made the change if any.
2466
2467
  */
@@ -2470,71 +2471,71 @@ interface on_train_schedule_changed extends event {
2470
2471
  /**
2471
2472
  * Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity="true"`.
2472
2473
  */
2473
- interface on_trigger_created_entity extends event {
2474
+ interface on_trigger_created_entity extends event {
2474
2475
  entity: LuaEntity
2475
2476
  source?: LuaEntity
2476
2477
  }
2477
2478
  /**
2478
2479
  * Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery="true"`.
2479
2480
  */
2480
- interface on_trigger_fired_artillery extends event {
2481
+ interface on_trigger_fired_artillery extends event {
2481
2482
  entity: LuaEntity
2482
2483
  source?: LuaEntity
2483
2484
  }
2484
2485
  /**
2485
2486
  * Called when a unit is added to a unit group.
2486
2487
  */
2487
- interface on_unit_added_to_group extends event {
2488
+ interface on_unit_added_to_group extends event {
2488
2489
  group: LuaUnitGroup
2489
2490
  unit: LuaEntity
2490
2491
  }
2491
2492
  /**
2492
2493
  * Called when a new unit group is created, before any members are added to it.
2493
2494
  */
2494
- interface on_unit_group_created extends event {
2495
+ interface on_unit_group_created extends event {
2495
2496
  group: LuaUnitGroup
2496
2497
  }
2497
2498
  /**
2498
2499
  * Called when a unit group finishes gathering and starts executing its command.
2499
2500
  */
2500
- interface on_unit_group_finished_gathering extends event {
2501
+ interface on_unit_group_finished_gathering extends event {
2501
2502
  group: LuaUnitGroup
2502
2503
  }
2503
2504
  /**
2504
2505
  * Called when a unit is removed from a unit group.
2505
2506
  */
2506
- interface on_unit_removed_from_group extends event {
2507
+ interface on_unit_removed_from_group extends event {
2507
2508
  group: LuaUnitGroup
2508
2509
  unit: LuaEntity
2509
2510
  }
2510
2511
  /**
2511
2512
  * Called when a worker (construction or logistic) robot expires through a lack of energy.
2512
2513
  */
2513
- interface on_worker_robot_expired extends event {
2514
+ interface on_worker_robot_expired extends event {
2514
2515
  robot: LuaEntity
2515
2516
  }
2516
2517
  /**
2517
- * 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 | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_built | LuaBootstrap::raise_script_built}, or when `raise_built` is passed to {@link LuaSurface::create_entity | LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter | LuaScriptRaisedBuiltEventFilter}.
2518
+ * 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}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter | runtime:LuaScriptRaisedBuiltEventFilter}.
2518
2519
  */
2519
- interface script_raised_built extends event {
2520
+ interface script_raised_built extends event {
2520
2521
  /**
2521
2522
  * The entity that has been built.
2522
2523
  */
2523
2524
  entity: LuaEntity
2524
2525
  }
2525
2526
  /**
2526
- * 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 | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_destroy | LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to {@link LuaEntity::destroy | LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter | LuaScriptRaisedDestroyEventFilter}.
2527
+ * 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}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter | runtime:LuaScriptRaisedDestroyEventFilter}.
2527
2528
  */
2528
- interface script_raised_destroy extends event {
2529
+ interface script_raised_destroy extends event {
2529
2530
  /**
2530
2531
  * The entity that was destroyed.
2531
2532
  */
2532
2533
  entity: LuaEntity
2533
2534
  }
2534
2535
  /**
2535
- * 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 | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_revive | LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity::revive | LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter | LuaScriptRaisedReviveEventFilter}.
2536
+ * 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}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter | runtime:LuaScriptRaisedReviveEventFilter}.
2536
2537
  */
2537
- interface script_raised_revive extends event {
2538
+ interface script_raised_revive extends event {
2538
2539
  /**
2539
2540
  * The entity that was revived.
2540
2541
  */
@@ -2545,9 +2546,9 @@ interface script_raised_revive extends event {
2545
2546
  tags?: Tags
2546
2547
  }
2547
2548
  /**
2548
- * 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 | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_set_tiles | LuaBootstrap::raise_script_set_tiles}, or when `raise_event` is passed to {@link LuaSurface::set_tiles | LuaSurface::set_tiles}.
2549
+ * 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}.
2549
2550
  */
2550
- interface script_raised_set_tiles extends event {
2551
+ interface script_raised_set_tiles extends event {
2551
2552
  /**
2552
2553
  * The surface whose tiles were changed.
2553
2554
  */
@@ -2558,9 +2559,9 @@ interface script_raised_set_tiles extends event {
2558
2559
  tiles: Tile[]
2559
2560
  }
2560
2561
  /**
2561
- * A static event mods can use to tell other mods they teleported something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_teleported | LuaBootstrap::raise_script_teleported}, or when `raise_teleported` is passed to {@link LuaControl::teleport | LuaControl::teleport}. Can be filtered using {@link LuaScriptRaisedTeleportedEventFilter | LuaScriptRaisedTeleportedEventFilter}.
2562
+ * A static event mods can use to tell other mods they teleported 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_teleported | runtime:LuaBootstrap::raise_script_teleported}, or when `raise_teleported` is passed to {@link LuaControl::teleport | runtime:LuaControl::teleport}. Can be filtered using {@link LuaScriptRaisedTeleportedEventFilter | runtime:LuaScriptRaisedTeleportedEventFilter}.
2562
2563
  */
2563
- interface script_raised_teleported extends event {
2564
+ interface script_raised_teleported extends event {
2564
2565
  /**
2565
2566
  * The entity that was teleported.
2566
2567
  */
@@ -2574,3 +2575,5 @@ interface script_raised_teleported extends event {
2574
2575
  */
2575
2576
  old_surface_index: number
2576
2577
  }
2578
+
2579
+ }