factorio-types 0.0.39 → 0.0.41

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.89
5
+ // Factorio version 1.1.90
6
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
  */
@@ -23,8 +24,16 @@ interface event {
23
24
  }
24
25
  /**
25
26
  * Called when a {@link CustomInputPrototype | prototype:CustomInputPrototype} is activated.
27
+ * @example
28
+ * This will be raised when a custom input with the name "my-potato-control" and action "lua" is pressed
29
+ * ```
30
+ * script.on_event("my-potato-control", function(event)
31
+ * game.print("Keyboard shortcut pressed on tick: " ..tostring(event.tick))
32
+ * end)
33
+ * ```
34
+ *
26
35
  */
27
- interface CustomInputEvent extends event {
36
+ interface CustomInputEvent extends event {
28
37
  /**
29
38
  * The mouse cursor display location when the custom input was activated.
30
39
  */
@@ -49,7 +58,7 @@ interface CustomInputEvent extends event {
49
58
  /**
50
59
  * Called when a unit/group completes a command.
51
60
  */
52
- interface on_ai_command_completed extends event {
61
+ interface on_ai_command_completed extends event {
53
62
  result: defines.behavior_result
54
63
  /**
55
64
  * unit_number/group_number of the unit/group which just completed a command.
@@ -63,7 +72,7 @@ interface on_ai_command_completed extends event {
63
72
  /**
64
73
  * Called when an area of the map is cloned.
65
74
  */
66
- interface on_area_cloned extends event {
75
+ interface on_area_cloned extends event {
67
76
  clear_destination_decoratives: boolean
68
77
  clear_destination_entities: boolean
69
78
  clone_decoratives: boolean
@@ -81,7 +90,7 @@ interface on_area_cloned extends event {
81
90
  * This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
82
91
  *
83
92
  */
84
- interface on_biter_base_built extends event {
93
+ interface on_biter_base_built extends event {
85
94
  /**
86
95
  * The entity that was built.
87
96
  */
@@ -90,7 +99,7 @@ interface on_biter_base_built extends event {
90
99
  /**
91
100
  * Called when a set of positions on the map is cloned.
92
101
  */
93
- interface on_brush_cloned extends event {
102
+ interface on_brush_cloned extends event {
94
103
  clear_destination_decoratives: boolean
95
104
  clear_destination_entities: boolean
96
105
  clone_decoratives: boolean
@@ -106,7 +115,7 @@ interface on_brush_cloned extends event {
106
115
  /**
107
116
  * Called when a {@link defines.command.build_base | runtime:defines.command.build_base} command reaches its destination, and before building starts.
108
117
  */
109
- interface on_build_base_arrived extends event {
118
+ interface on_build_base_arrived extends event {
110
119
  /**
111
120
  * The unit group the command was assigned to.
112
121
  */
@@ -119,7 +128,7 @@ interface on_build_base_arrived extends event {
119
128
  /**
120
129
  * Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter | runtime:LuaPlayerBuiltEntityEventFilter}.
121
130
  */
122
- interface on_built_entity extends event {
131
+ interface on_built_entity extends event {
123
132
  created_entity: LuaEntity
124
133
  /**
125
134
  * The item prototype used to build the entity. Note this won't exist in some situations (built from blueprint, undo, etc).
@@ -135,14 +144,14 @@ interface on_built_entity extends event {
135
144
  /**
136
145
  * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter | runtime:LuaEntityDeconstructionCancelledEventFilter}.
137
146
  */
138
- interface on_cancelled_deconstruction extends event {
147
+ interface on_cancelled_deconstruction extends event {
139
148
  entity: LuaEntity
140
149
  player_index?: number
141
150
  }
142
151
  /**
143
152
  * Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter | runtime:LuaUpgradeCancelledEventFilter}.
144
153
  */
145
- interface on_cancelled_upgrade extends event {
154
+ interface on_cancelled_upgrade extends event {
146
155
  direction?: defines.direction
147
156
  entity: LuaEntity
148
157
  player_index?: number
@@ -154,7 +163,7 @@ interface on_cancelled_upgrade extends event {
154
163
  * 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
164
  *
156
165
  */
157
- interface on_character_corpse_expired extends event {
166
+ interface on_character_corpse_expired extends event {
158
167
  /**
159
168
  * The corpse.
160
169
  */
@@ -163,7 +172,7 @@ interface on_character_corpse_expired extends event {
163
172
  /**
164
173
  * Called when a chart tag is created.
165
174
  */
166
- interface on_chart_tag_added extends event {
175
+ interface on_chart_tag_added extends event {
167
176
  force: LuaForce
168
177
  player_index?: number
169
178
  tag: LuaCustomChartTag
@@ -171,7 +180,7 @@ interface on_chart_tag_added extends event {
171
180
  /**
172
181
  * Called when a chart tag is modified by a player.
173
182
  */
174
- interface on_chart_tag_modified extends event {
183
+ interface on_chart_tag_modified extends event {
175
184
  force: LuaForce
176
185
  old_icon?: SignalID
177
186
  old_player?: number
@@ -182,7 +191,7 @@ interface on_chart_tag_modified extends event {
182
191
  /**
183
192
  * Called just before a chart tag is deleted.
184
193
  */
185
- interface on_chart_tag_removed extends event {
194
+ interface on_chart_tag_removed extends event {
186
195
  force: LuaForce
187
196
  player_index?: number
188
197
  tag: LuaCustomChartTag
@@ -190,7 +199,7 @@ interface on_chart_tag_removed extends event {
190
199
  /**
191
200
  * Called when a chunk is charted or re-charted.
192
201
  */
193
- interface on_chunk_charted extends event {
202
+ interface on_chunk_charted extends event {
194
203
  /**
195
204
  * Area of the chunk.
196
205
  */
@@ -202,7 +211,7 @@ interface on_chunk_charted extends event {
202
211
  /**
203
212
  * Called when one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
204
213
  */
205
- interface on_chunk_deleted extends event {
214
+ interface on_chunk_deleted extends event {
206
215
  /**
207
216
  * The chunks deleted.
208
217
  */
@@ -212,7 +221,7 @@ interface on_chunk_deleted extends event {
212
221
  /**
213
222
  * Called when a chunk is generated.
214
223
  */
215
- interface on_chunk_generated extends event {
224
+ interface on_chunk_generated extends event {
216
225
  /**
217
226
  * Area of the chunk.
218
227
  */
@@ -229,7 +238,7 @@ interface on_chunk_generated extends event {
229
238
  /**
230
239
  * Called when a combat robot expires through a lack of energy, or timeout.
231
240
  */
232
- interface on_combat_robot_expired extends event {
241
+ interface on_combat_robot_expired extends event {
233
242
  /**
234
243
  * The entity that owns the robot if any.
235
244
  */
@@ -242,7 +251,7 @@ interface on_combat_robot_expired extends event {
242
251
  * This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
243
252
  *
244
253
  */
245
- interface on_console_chat extends event {
254
+ interface on_console_chat extends event {
246
255
  /**
247
256
  * The chat message that was sent.
248
257
  */
@@ -255,7 +264,7 @@ interface on_console_chat extends event {
255
264
  /**
256
265
  * Called when someone enters a command-like message regardless of it being a valid command.
257
266
  */
258
- interface on_console_command extends event {
267
+ interface on_console_command extends event {
259
268
  /**
260
269
  * The command as typed without the preceding forward slash ('/').
261
270
  */
@@ -272,7 +281,7 @@ interface on_console_command extends event {
272
281
  /**
273
282
  * Called when a cutscene is cancelled by the player or by script.
274
283
  */
275
- interface on_cutscene_cancelled extends event {
284
+ interface on_cutscene_cancelled extends event {
276
285
  /**
277
286
  * The player the cutscene was shown to.
278
287
  */
@@ -281,7 +290,7 @@ interface on_cutscene_cancelled extends event {
281
290
  /**
282
291
  * Called when a cutscene finishes naturally (was not cancelled).
283
292
  */
284
- interface on_cutscene_finished extends event {
293
+ interface on_cutscene_finished extends event {
285
294
  /**
286
295
  * The player the cutscene was shown to.
287
296
  */
@@ -290,7 +299,7 @@ interface on_cutscene_finished extends event {
290
299
  /**
291
300
  * Called when a cutscene starts.
292
301
  */
293
- interface on_cutscene_started extends event {
302
+ interface on_cutscene_started extends event {
294
303
  /**
295
304
  * The player the cutscene is being shown to.
296
305
  */
@@ -304,7 +313,7 @@ interface on_cutscene_started extends event {
304
313
  * Due to implementation omission, waypoint_index is 0-based.
305
314
  *
306
315
  */
307
- interface on_cutscene_waypoint_reached extends event {
316
+ interface on_cutscene_waypoint_reached extends event {
308
317
  /**
309
318
  * The player index of the player viewing the cutscene.
310
319
  */
@@ -320,14 +329,14 @@ interface on_cutscene_waypoint_reached extends event {
320
329
  * It's not guaranteed that both settings are changed - just that at least one has been changed.
321
330
  *
322
331
  */
323
- interface on_difficulty_settings_changed extends event {
332
+ interface on_difficulty_settings_changed extends event {
324
333
  old_recipe_difficulty: number
325
334
  old_technology_difficulty: number
326
335
  }
327
336
  /**
328
337
  * Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter | runtime:LuaEntityClonedEventFilter}.
329
338
  */
330
- interface on_entity_cloned extends event {
339
+ interface on_entity_cloned extends event {
331
340
  destination: LuaEntity
332
341
  source: LuaEntity
333
342
  }
@@ -337,7 +346,7 @@ interface on_entity_cloned extends event {
337
346
  * Automatic recoloring due to {@link LuaPlayer::color | runtime:LuaPlayer::color} will not raise events, as that is a separate mechanism.
338
347
  *
339
348
  */
340
- interface on_entity_color_changed extends event {
349
+ interface on_entity_color_changed extends event {
341
350
  /**
342
351
  * The entity that was recolored.
343
352
  */
@@ -349,7 +358,7 @@ interface on_entity_color_changed extends event {
349
358
  * This is not called when an entities health is set directly by another mod.
350
359
  *
351
360
  */
352
- interface on_entity_damaged extends event {
361
+ interface on_entity_damaged extends event {
353
362
  /**
354
363
  * The entity that did the attacking if available.
355
364
  */
@@ -379,7 +388,7 @@ interface on_entity_damaged extends event {
379
388
  * 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
389
  *
381
390
  */
382
- interface on_entity_destroyed extends event {
391
+ interface on_entity_destroyed extends event {
383
392
  /**
384
393
  * The number returned by {@link register_on_entity_destroyed | runtime:LuaBootstrap::register_on_entity_destroyed} to uniquely identify this entity during this event.
385
394
  */
@@ -392,7 +401,7 @@ interface on_entity_destroyed extends event {
392
401
  /**
393
402
  * Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter | runtime:LuaEntityDiedEventFilter}.
394
403
  */
395
- interface on_entity_died extends event {
404
+ interface on_entity_died extends event {
396
405
  /**
397
406
  * The entity that did the killing if available.
398
407
  */
@@ -420,7 +429,7 @@ interface on_entity_died extends event {
420
429
  * "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the request slots on logistic chests.
421
430
  *
422
431
  */
423
- interface on_entity_logistic_slot_changed extends event {
432
+ interface on_entity_logistic_slot_changed extends event {
424
433
  /**
425
434
  * The entity for whom a logistic slot was changed.
426
435
  */
@@ -437,7 +446,7 @@ interface on_entity_logistic_slot_changed extends event {
437
446
  /**
438
447
  * Called after an entity has been renamed either by the player or through script.
439
448
  */
440
- interface on_entity_renamed extends event {
449
+ interface on_entity_renamed extends event {
441
450
  by_script: boolean
442
451
  entity: LuaEntity
443
452
  old_name: string
@@ -449,7 +458,7 @@ interface on_entity_renamed extends event {
449
458
  /**
450
459
  * Called after entity copy-paste is done.
451
460
  */
452
- interface on_entity_settings_pasted extends event {
461
+ interface on_entity_settings_pasted extends event {
453
462
  /**
454
463
  * The destination entity settings were copied to.
455
464
  */
@@ -463,14 +472,14 @@ interface on_entity_settings_pasted extends event {
463
472
  /**
464
473
  * Called when an entity is spawned by a EnemySpawner
465
474
  */
466
- interface on_entity_spawned extends event {
475
+ interface on_entity_spawned extends event {
467
476
  entity: LuaEntity
468
477
  spawner: LuaEntity
469
478
  }
470
479
  /**
471
480
  * Called after equipment is inserted into an equipment grid.
472
481
  */
473
- interface on_equipment_inserted extends event {
482
+ interface on_equipment_inserted extends event {
474
483
  /**
475
484
  * The equipment inserted.
476
485
  */
@@ -483,7 +492,7 @@ interface on_equipment_inserted extends event {
483
492
  /**
484
493
  * Called after equipment is removed from an equipment grid.
485
494
  */
486
- interface on_equipment_removed extends event {
495
+ interface on_equipment_removed extends event {
487
496
  /**
488
497
  * The count of equipment removed.
489
498
  */
@@ -500,7 +509,7 @@ interface on_equipment_removed extends event {
500
509
  /**
501
510
  * Called when the a forces cease fire values change.
502
511
  */
503
- interface on_force_cease_fire_changed extends event {
512
+ interface on_force_cease_fire_changed extends event {
504
513
  /**
505
514
  * If the other force was added or removed.
506
515
  */
@@ -520,7 +529,7 @@ interface on_force_cease_fire_changed extends event {
520
529
  * This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
521
530
  *
522
531
  */
523
- interface on_force_created extends event {
532
+ interface on_force_created extends event {
524
533
  /**
525
534
  * The newly created force.
526
535
  */
@@ -529,7 +538,7 @@ interface on_force_created extends event {
529
538
  /**
530
539
  * Called when the a forces friends change.
531
540
  */
532
- interface on_force_friends_changed extends event {
541
+ interface on_force_friends_changed extends event {
533
542
  /**
534
543
  * If the other force was added or removed.
535
544
  */
@@ -546,7 +555,7 @@ interface on_force_friends_changed extends event {
546
555
  /**
547
556
  * Called when {@link LuaForce::reset | runtime:LuaForce::reset} is finished.
548
557
  */
549
- interface on_force_reset extends event {
558
+ interface on_force_reset extends event {
550
559
  force: LuaForce
551
560
  }
552
561
  /**
@@ -555,7 +564,7 @@ interface on_force_reset extends event {
555
564
  * The source force is invalidated before this event is called and the name can be re-used in this event if desired.
556
565
  *
557
566
  */
558
- interface on_forces_merged extends event {
567
+ interface on_forces_merged extends event {
559
568
  /**
560
569
  * The force entities where reassigned to.
561
570
  */
@@ -572,7 +581,7 @@ interface on_forces_merged extends event {
572
581
  /**
573
582
  * Called when two forces are about to be merged using `game.merge_forces()`.
574
583
  */
575
- interface on_forces_merging extends event {
584
+ interface on_forces_merging extends event {
576
585
  /**
577
586
  * The force to reassign entities to.
578
587
  */
@@ -588,12 +597,12 @@ interface on_forces_merging extends event {
588
597
  * This event is not fired when the scenario is loaded via the map editor.
589
598
  *
590
599
  */
591
- interface on_game_created_from_scenario extends event {
600
+ interface on_game_created_from_scenario extends event {
592
601
  }
593
602
  /**
594
603
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
595
604
  */
596
- interface on_gui_checked_state_changed extends event {
605
+ interface on_gui_checked_state_changed extends event {
597
606
  /**
598
607
  * The element whose checked state changed.
599
608
  */
@@ -606,7 +615,7 @@ interface on_gui_checked_state_changed extends event {
606
615
  /**
607
616
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} is clicked.
608
617
  */
609
- interface on_gui_click extends event {
618
+ interface on_gui_click extends event {
610
619
  /**
611
620
  * If alt was pressed.
612
621
  */
@@ -644,7 +653,7 @@ interface on_gui_click extends event {
644
653
  * 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
654
  *
646
655
  */
647
- interface on_gui_closed extends event {
656
+ interface on_gui_closed extends event {
648
657
  /**
649
658
  * The custom GUI element that was open
650
659
  */
@@ -689,7 +698,7 @@ interface on_gui_closed extends event {
689
698
  /**
690
699
  * Called when a {@link LuaGuiElement | runtime:LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
691
700
  */
692
- interface on_gui_confirmed extends event {
701
+ interface on_gui_confirmed extends event {
693
702
  /**
694
703
  * If alt was pressed.
695
704
  */
@@ -714,7 +723,7 @@ interface on_gui_confirmed extends event {
714
723
  /**
715
724
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} element value is changed (related to choose element buttons).
716
725
  */
717
- interface on_gui_elem_changed extends event {
726
+ interface on_gui_elem_changed extends event {
718
727
  /**
719
728
  * The element whose element value changed.
720
729
  */
@@ -727,7 +736,7 @@ interface on_gui_elem_changed extends event {
727
736
  /**
728
737
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} is hovered by the mouse.
729
738
  */
730
- interface on_gui_hover extends event {
739
+ interface on_gui_hover extends event {
731
740
  /**
732
741
  * The element that is being hovered over.
733
742
  */
@@ -740,7 +749,7 @@ interface on_gui_hover extends event {
740
749
  /**
741
750
  * Called when the player's cursor leaves a {@link LuaGuiElement | runtime:LuaGuiElement} that was previously hovered.
742
751
  */
743
- interface on_gui_leave extends event {
752
+ interface on_gui_leave extends event {
744
753
  /**
745
754
  * The element that was being hovered.
746
755
  */
@@ -753,7 +762,7 @@ interface on_gui_leave extends event {
753
762
  /**
754
763
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
755
764
  */
756
- interface on_gui_location_changed extends event {
765
+ interface on_gui_location_changed extends event {
757
766
  /**
758
767
  * The element whose location changed.
759
768
  */
@@ -766,7 +775,7 @@ interface on_gui_location_changed extends event {
766
775
  /**
767
776
  * Called when the player opens a GUI.
768
777
  */
769
- interface on_gui_opened extends event {
778
+ interface on_gui_opened extends event {
770
779
  /**
771
780
  * The custom GUI element that was opened
772
781
  */
@@ -803,7 +812,7 @@ interface on_gui_opened extends event {
803
812
  /**
804
813
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selected tab is changed (related to tabbed-panes).
805
814
  */
806
- interface on_gui_selected_tab_changed extends event {
815
+ interface on_gui_selected_tab_changed extends event {
807
816
  /**
808
817
  * The tabbed pane whose selected tab changed.
809
818
  */
@@ -816,7 +825,7 @@ interface on_gui_selected_tab_changed extends event {
816
825
  /**
817
826
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
818
827
  */
819
- interface on_gui_selection_state_changed extends event {
828
+ interface on_gui_selection_state_changed extends event {
820
829
  /**
821
830
  * The element whose selection state changed.
822
831
  */
@@ -829,7 +838,7 @@ interface on_gui_selection_state_changed extends event {
829
838
  /**
830
839
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} switch state is changed (related to switches).
831
840
  */
832
- interface on_gui_switch_state_changed extends event {
841
+ interface on_gui_switch_state_changed extends event {
833
842
  /**
834
843
  * The switch whose switch state changed.
835
844
  */
@@ -842,7 +851,7 @@ interface on_gui_switch_state_changed extends event {
842
851
  /**
843
852
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} text is changed by the player.
844
853
  */
845
- interface on_gui_text_changed extends event {
854
+ interface on_gui_text_changed extends event {
846
855
  /**
847
856
  * The edited element.
848
857
  */
@@ -859,7 +868,7 @@ interface on_gui_text_changed extends event {
859
868
  /**
860
869
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} slider value is changed (related to the slider element).
861
870
  */
862
- interface on_gui_value_changed extends event {
871
+ interface on_gui_value_changed extends event {
863
872
  /**
864
873
  * The element whose value changed.
865
874
  */
@@ -872,13 +881,13 @@ interface on_gui_value_changed extends event {
872
881
  /**
873
882
  * Called when a land mine is armed.
874
883
  */
875
- interface on_land_mine_armed extends event {
884
+ interface on_land_mine_armed extends event {
876
885
  mine: LuaEntity
877
886
  }
878
887
  /**
879
- * Called when a custom Lua shortcut is pressed.
888
+ * Called when a custom {@link Lua shortcut | prototype:ShortcutPrototype} is pressed.
880
889
  */
881
- interface on_lua_shortcut extends event {
890
+ interface on_lua_shortcut extends event {
882
891
  player_index: number
883
892
  /**
884
893
  * Shortcut prototype name of the shortcut that was clicked.
@@ -888,14 +897,14 @@ interface on_lua_shortcut extends event {
888
897
  /**
889
898
  * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter | runtime:LuaEntityMarkedForDeconstructionEventFilter}.
890
899
  */
891
- interface on_marked_for_deconstruction extends event {
900
+ interface on_marked_for_deconstruction extends event {
892
901
  entity: LuaEntity
893
902
  player_index?: number
894
903
  }
895
904
  /**
896
905
  * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter | runtime:LuaEntityMarkedForUpgradeEventFilter}.
897
906
  */
898
- interface on_marked_for_upgrade extends event {
907
+ interface on_marked_for_upgrade extends event {
899
908
  /**
900
909
  * The new direction (if any)
901
910
  */
@@ -907,7 +916,7 @@ interface on_marked_for_upgrade extends event {
907
916
  /**
908
917
  * Called after a player purchases some offer from a `market` entity.
909
918
  */
910
- interface on_market_item_purchased extends event {
919
+ interface on_market_item_purchased extends event {
911
920
  /**
912
921
  * The amount of offers purchased.
913
922
  */
@@ -928,7 +937,7 @@ interface on_market_item_purchased extends event {
928
937
  /**
929
938
  * Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
930
939
  */
931
- interface on_mod_item_opened extends event {
940
+ interface on_mod_item_opened extends event {
932
941
  /**
933
942
  * The item clicked on.
934
943
  */
@@ -941,7 +950,7 @@ interface on_mod_item_opened extends event {
941
950
  /**
942
951
  * Called directly after a permission group is added.
943
952
  */
944
- interface on_permission_group_added extends event {
953
+ interface on_permission_group_added extends event {
945
954
  /**
946
955
  * The group added.
947
956
  */
@@ -954,7 +963,7 @@ interface on_permission_group_added extends event {
954
963
  /**
955
964
  * Called directly after a permission group is deleted.
956
965
  */
957
- interface on_permission_group_deleted extends event {
966
+ interface on_permission_group_deleted extends event {
958
967
  /**
959
968
  * The group that was deleted.
960
969
  */
@@ -971,7 +980,7 @@ interface on_permission_group_deleted extends event {
971
980
  /**
972
981
  * Called directly after a permission group is edited in some way.
973
982
  */
974
- interface on_permission_group_edited extends event {
983
+ interface on_permission_group_edited extends event {
975
984
  /**
976
985
  * The action when the `type` is "add-permission" or "remove-permission".
977
986
  */
@@ -1004,7 +1013,7 @@ interface on_permission_group_edited extends event {
1004
1013
  /**
1005
1014
  * Called directly after a permission string is imported.
1006
1015
  */
1007
- interface on_permission_string_imported extends event {
1016
+ interface on_permission_string_imported extends event {
1008
1017
  /**
1009
1018
  * The player that imported the string.
1010
1019
  */
@@ -1013,14 +1022,14 @@ interface on_permission_string_imported extends event {
1013
1022
  /**
1014
1023
  * Called when a player picks up an item.
1015
1024
  */
1016
- interface on_picked_up_item extends event {
1025
+ interface on_picked_up_item extends event {
1017
1026
  item_stack: SimpleItemStack
1018
1027
  player_index: number
1019
1028
  }
1020
1029
  /**
1021
1030
  * Called after a player alt-reverse-selects an area with a selection-tool item.
1022
1031
  */
1023
- interface on_player_alt_reverse_selected_area extends event {
1032
+ interface on_player_alt_reverse_selected_area extends event {
1024
1033
  /**
1025
1034
  * The area selected.
1026
1035
  */
@@ -1049,7 +1058,7 @@ interface on_player_alt_reverse_selected_area extends event {
1049
1058
  /**
1050
1059
  * Called after a player alt-selects an area with a selection-tool item.
1051
1060
  */
1052
- interface on_player_alt_selected_area extends event {
1061
+ interface on_player_alt_selected_area extends event {
1053
1062
  /**
1054
1063
  * The area selected.
1055
1064
  */
@@ -1078,19 +1087,19 @@ interface on_player_alt_selected_area extends event {
1078
1087
  /**
1079
1088
  * Called after a players ammo inventory changed in some way.
1080
1089
  */
1081
- interface on_player_ammo_inventory_changed extends event {
1090
+ interface on_player_ammo_inventory_changed extends event {
1082
1091
  player_index: number
1083
1092
  }
1084
1093
  /**
1085
1094
  * Called after a players armor inventory changed in some way.
1086
1095
  */
1087
- interface on_player_armor_inventory_changed extends event {
1096
+ interface on_player_armor_inventory_changed extends event {
1088
1097
  player_index: number
1089
1098
  }
1090
1099
  /**
1091
1100
  * Called when a player is banned.
1092
1101
  */
1093
- interface on_player_banned extends event {
1102
+ interface on_player_banned extends event {
1094
1103
  /**
1095
1104
  * The player that did the banning if any.
1096
1105
  */
@@ -1111,7 +1120,7 @@ interface on_player_banned extends event {
1111
1120
  /**
1112
1121
  * Called after a player builds tiles.
1113
1122
  */
1114
- interface on_player_built_tile extends event {
1123
+ interface on_player_built_tile extends event {
1115
1124
  /**
1116
1125
  * The item type used to build the tiles
1117
1126
  */
@@ -1137,7 +1146,7 @@ interface on_player_built_tile extends event {
1137
1146
  /**
1138
1147
  * Called when a player cancels crafting.
1139
1148
  */
1140
- interface on_player_cancelled_crafting extends event {
1149
+ interface on_player_cancelled_crafting extends event {
1141
1150
  /**
1142
1151
  * The number of crafts that have been cancelled.
1143
1152
  */
@@ -1158,7 +1167,7 @@ interface on_player_cancelled_crafting extends event {
1158
1167
  /**
1159
1168
  * Called after a player changes forces.
1160
1169
  */
1161
- interface on_player_changed_force extends event {
1170
+ interface on_player_changed_force extends event {
1162
1171
  /**
1163
1172
  * The old force.
1164
1173
  */
@@ -1171,7 +1180,7 @@ interface on_player_changed_force extends event {
1171
1180
  /**
1172
1181
  * Called when the tile position a player is located at changes.
1173
1182
  */
1174
- interface on_player_changed_position extends event {
1183
+ interface on_player_changed_position extends event {
1175
1184
  /**
1176
1185
  * The player.
1177
1186
  */
@@ -1183,7 +1192,7 @@ interface on_player_changed_position extends event {
1183
1192
  * In the instance a player is moved off a surface due to it being deleted this is not called.
1184
1193
  *
1185
1194
  */
1186
- interface on_player_changed_surface extends event {
1195
+ interface on_player_changed_surface extends event {
1187
1196
  /**
1188
1197
  * The player who changed surfaces.
1189
1198
  */
@@ -1196,7 +1205,7 @@ interface on_player_changed_surface extends event {
1196
1205
  /**
1197
1206
  * Called when cheat mode is disabled on a player.
1198
1207
  */
1199
- interface on_player_cheat_mode_disabled extends event {
1208
+ interface on_player_cheat_mode_disabled extends event {
1200
1209
  /**
1201
1210
  * The player.
1202
1211
  */
@@ -1205,7 +1214,7 @@ interface on_player_cheat_mode_disabled extends event {
1205
1214
  /**
1206
1215
  * Called when cheat mode is enabled on a player.
1207
1216
  */
1208
- interface on_player_cheat_mode_enabled extends event {
1217
+ interface on_player_cheat_mode_enabled extends event {
1209
1218
  /**
1210
1219
  * The player.
1211
1220
  */
@@ -1214,7 +1223,7 @@ interface on_player_cheat_mode_enabled extends event {
1214
1223
  /**
1215
1224
  * Called when a player clicks a gps tag
1216
1225
  */
1217
- interface on_player_clicked_gps_tag extends event {
1226
+ interface on_player_clicked_gps_tag extends event {
1218
1227
  /**
1219
1228
  * Index of the player
1220
1229
  */
@@ -1231,7 +1240,7 @@ interface on_player_clicked_gps_tag extends event {
1231
1240
  /**
1232
1241
  * Called when a player clicks the "confirm" button in the configure Blueprint GUI.
1233
1242
  */
1234
- interface on_player_configured_blueprint extends event {
1243
+ interface on_player_configured_blueprint extends event {
1235
1244
  /**
1236
1245
  * The player.
1237
1246
  */
@@ -1240,7 +1249,7 @@ interface on_player_configured_blueprint extends event {
1240
1249
  /**
1241
1250
  * Called when a player configures spidertron remote to be connected with a given spidertron
1242
1251
  */
1243
- interface on_player_configured_spider_remote extends event {
1252
+ interface on_player_configured_spider_remote extends event {
1244
1253
  /**
1245
1254
  * The player that configured the remote.
1246
1255
  */
@@ -1253,7 +1262,7 @@ interface on_player_configured_spider_remote extends event {
1253
1262
  /**
1254
1263
  * 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
1264
  */
1256
- interface on_player_crafted_item extends event {
1265
+ interface on_player_crafted_item extends event {
1257
1266
  /**
1258
1267
  * The item that has been crafted.
1259
1268
  */
@@ -1270,19 +1279,19 @@ interface on_player_crafted_item extends event {
1270
1279
  /**
1271
1280
  * Called after the player was created.
1272
1281
  */
1273
- interface on_player_created extends event {
1282
+ interface on_player_created extends event {
1274
1283
  player_index: number
1275
1284
  }
1276
1285
  /**
1277
1286
  * Called after a player's {@link cursor stack | runtime:LuaControl::cursor_stack} changed in some way.
1278
1287
  */
1279
- interface on_player_cursor_stack_changed extends event {
1288
+ interface on_player_cursor_stack_changed extends event {
1280
1289
  player_index: number
1281
1290
  }
1282
1291
  /**
1283
1292
  * Called when a player selects an area with a deconstruction planner.
1284
1293
  */
1285
- interface on_player_deconstructed_area extends event {
1294
+ interface on_player_deconstructed_area extends event {
1286
1295
  /**
1287
1296
  * If normal selection or alt selection was used.
1288
1297
  */
@@ -1307,7 +1316,7 @@ interface on_player_deconstructed_area extends event {
1307
1316
  /**
1308
1317
  * Called when a player is demoted.
1309
1318
  */
1310
- interface on_player_demoted extends event {
1319
+ interface on_player_demoted extends event {
1311
1320
  /**
1312
1321
  * The player.
1313
1322
  */
@@ -1316,14 +1325,14 @@ interface on_player_demoted extends event {
1316
1325
  /**
1317
1326
  * Called after a player dies.
1318
1327
  */
1319
- interface on_player_died extends event {
1328
+ interface on_player_died extends event {
1320
1329
  cause?: LuaEntity
1321
1330
  player_index: number
1322
1331
  }
1323
1332
  /**
1324
1333
  * Called when the display resolution changes for a given player.
1325
1334
  */
1326
- interface on_player_display_resolution_changed extends event {
1335
+ interface on_player_display_resolution_changed extends event {
1327
1336
  /**
1328
1337
  * The old display resolution
1329
1338
  */
@@ -1336,7 +1345,7 @@ interface on_player_display_resolution_changed extends event {
1336
1345
  /**
1337
1346
  * Called when the display scale changes for a given player.
1338
1347
  */
1339
- interface on_player_display_scale_changed extends event {
1348
+ interface on_player_display_scale_changed extends event {
1340
1349
  /**
1341
1350
  * The old display scale
1342
1351
  */
@@ -1352,7 +1361,7 @@ interface on_player_display_scale_changed extends event {
1352
1361
  * This event is not raised when the player is ejected from a vehicle due to it being destroyed.
1353
1362
  *
1354
1363
  */
1355
- interface on_player_driving_changed_state extends event {
1364
+ interface on_player_driving_changed_state extends event {
1356
1365
  /**
1357
1366
  * The vehicle if any.
1358
1367
  */
@@ -1362,7 +1371,7 @@ interface on_player_driving_changed_state extends event {
1362
1371
  /**
1363
1372
  * Called when a player drops an item on the ground.
1364
1373
  */
1365
- interface on_player_dropped_item extends event {
1374
+ interface on_player_dropped_item extends event {
1366
1375
  /**
1367
1376
  * The item-on-ground entity.
1368
1377
  */
@@ -1372,7 +1381,7 @@ interface on_player_dropped_item extends event {
1372
1381
  /**
1373
1382
  * Called when a player fast-transfers something to or from an entity.
1374
1383
  */
1375
- interface on_player_fast_transferred extends event {
1384
+ interface on_player_fast_transferred extends event {
1376
1385
  /**
1377
1386
  * The entity transferred from or to.
1378
1387
  */
@@ -1393,7 +1402,7 @@ interface on_player_fast_transferred extends event {
1393
1402
  /**
1394
1403
  * Called after player flushed fluid
1395
1404
  */
1396
- interface on_player_flushed_fluid extends event {
1405
+ interface on_player_flushed_fluid extends event {
1397
1406
  /**
1398
1407
  * Amount of fluid that was removed
1399
1408
  */
@@ -1418,7 +1427,7 @@ interface on_player_flushed_fluid extends event {
1418
1427
  /**
1419
1428
  * Called after a players gun inventory changed in some way.
1420
1429
  */
1421
- interface on_player_gun_inventory_changed extends event {
1430
+ interface on_player_gun_inventory_changed extends event {
1422
1431
  player_index: number
1423
1432
  }
1424
1433
  /**
@@ -1427,7 +1436,7 @@ interface on_player_gun_inventory_changed extends event {
1427
1436
  * See {@link LuaPlayer::input_method | runtime:LuaPlayer::input_method}.
1428
1437
  *
1429
1438
  */
1430
- interface on_player_input_method_changed extends event {
1439
+ interface on_player_input_method_changed extends event {
1431
1440
  /**
1432
1441
  * The player whose input method changed.
1433
1442
  */
@@ -1436,13 +1445,13 @@ interface on_player_input_method_changed extends event {
1436
1445
  /**
1437
1446
  * 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
1447
  */
1439
- interface on_player_joined_game extends event {
1448
+ interface on_player_joined_game extends event {
1440
1449
  player_index: number
1441
1450
  }
1442
1451
  /**
1443
1452
  * Called when a player is kicked.
1444
1453
  */
1445
- interface on_player_kicked extends event {
1454
+ interface on_player_kicked extends event {
1446
1455
  /**
1447
1456
  * The player that did the kicking if any.
1448
1457
  */
@@ -1459,14 +1468,14 @@ interface on_player_kicked extends event {
1459
1468
  /**
1460
1469
  * 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
1470
  */
1462
- interface on_player_left_game extends event {
1471
+ interface on_player_left_game extends event {
1463
1472
  player_index: number
1464
1473
  reason: defines.disconnect_reason
1465
1474
  }
1466
1475
  /**
1467
1476
  * Called after a players main inventory changed in some way.
1468
1477
  */
1469
- interface on_player_main_inventory_changed extends event {
1478
+ interface on_player_main_inventory_changed extends event {
1470
1479
  player_index: number
1471
1480
  }
1472
1481
  /**
@@ -1475,7 +1484,7 @@ interface on_player_main_inventory_changed extends event {
1475
1484
  * 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
1485
  *
1477
1486
  */
1478
- interface on_player_mined_entity extends event {
1487
+ interface on_player_mined_entity extends event {
1479
1488
  /**
1480
1489
  * The temporary inventory that holds the result of mining the entity.
1481
1490
  */
@@ -1492,7 +1501,7 @@ interface on_player_mined_entity extends event {
1492
1501
  /**
1493
1502
  * Called when the player mines something.
1494
1503
  */
1495
- interface on_player_mined_item extends event {
1504
+ interface on_player_mined_item extends event {
1496
1505
  /**
1497
1506
  * The item given to the player
1498
1507
  */
@@ -1502,7 +1511,7 @@ interface on_player_mined_item extends event {
1502
1511
  /**
1503
1512
  * Called after a player mines tiles.
1504
1513
  */
1505
- interface on_player_mined_tile extends event {
1514
+ interface on_player_mined_tile extends event {
1506
1515
  player_index: number
1507
1516
  /**
1508
1517
  * The surface the tile(s) were mined from.
@@ -1516,7 +1525,7 @@ interface on_player_mined_tile extends event {
1516
1525
  /**
1517
1526
  * Called when a player is muted.
1518
1527
  */
1519
- interface on_player_muted extends event {
1528
+ interface on_player_muted extends event {
1520
1529
  /**
1521
1530
  * The player.
1522
1531
  */
@@ -1525,7 +1534,7 @@ interface on_player_muted extends event {
1525
1534
  /**
1526
1535
  * Called when a player invokes the "smart pipette" over an entity.
1527
1536
  */
1528
- interface on_player_pipette extends event {
1537
+ interface on_player_pipette extends event {
1529
1538
  /**
1530
1539
  * The item put in the cursor
1531
1540
  */
@@ -1542,7 +1551,7 @@ interface on_player_pipette extends event {
1542
1551
  /**
1543
1552
  * Called after the player puts equipment in an equipment grid
1544
1553
  */
1545
- interface on_player_placed_equipment extends event {
1554
+ interface on_player_placed_equipment extends event {
1546
1555
  /**
1547
1556
  * The equipment put in the equipment grid.
1548
1557
  */
@@ -1556,7 +1565,7 @@ interface on_player_placed_equipment extends event {
1556
1565
  /**
1557
1566
  * Called when a player is promoted.
1558
1567
  */
1559
- interface on_player_promoted extends event {
1568
+ interface on_player_promoted extends event {
1560
1569
  /**
1561
1570
  * The player.
1562
1571
  */
@@ -1565,7 +1574,7 @@ interface on_player_promoted extends event {
1565
1574
  /**
1566
1575
  * 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
1576
  */
1568
- interface on_player_removed extends event {
1577
+ interface on_player_removed extends event {
1569
1578
  /**
1570
1579
  * The index of the removed player.
1571
1580
  */
@@ -1574,7 +1583,7 @@ interface on_player_removed extends event {
1574
1583
  /**
1575
1584
  * Called after the player removes equipment from an equipment grid
1576
1585
  */
1577
- interface on_player_removed_equipment extends event {
1586
+ interface on_player_removed_equipment extends event {
1578
1587
  /**
1579
1588
  * The count of equipment removed.
1580
1589
  */
@@ -1592,14 +1601,14 @@ interface on_player_removed_equipment extends event {
1592
1601
  /**
1593
1602
  * Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter | runtime:LuaPlayerRepairedEntityEventFilter}.
1594
1603
  */
1595
- interface on_player_repaired_entity extends event {
1604
+ interface on_player_repaired_entity extends event {
1596
1605
  entity: LuaEntity
1597
1606
  player_index: number
1598
1607
  }
1599
1608
  /**
1600
1609
  * Called after a player respawns.
1601
1610
  */
1602
- interface on_player_respawned extends event {
1611
+ interface on_player_respawned extends event {
1603
1612
  player_index: number
1604
1613
  /**
1605
1614
  * The player port used to respawn if one was used.
@@ -1609,7 +1618,7 @@ interface on_player_respawned extends event {
1609
1618
  /**
1610
1619
  * Called after a player reverse-selects an area with a selection-tool item.
1611
1620
  */
1612
- interface on_player_reverse_selected_area extends event {
1621
+ interface on_player_reverse_selected_area extends event {
1613
1622
  /**
1614
1623
  * The area selected.
1615
1624
  */
@@ -1638,7 +1647,7 @@ interface on_player_reverse_selected_area extends event {
1638
1647
  /**
1639
1648
  * 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
1649
  */
1641
- interface on_player_rotated_entity extends event {
1650
+ interface on_player_rotated_entity extends event {
1642
1651
  /**
1643
1652
  * The rotated entity.
1644
1653
  */
@@ -1652,7 +1661,7 @@ interface on_player_rotated_entity extends event {
1652
1661
  /**
1653
1662
  * Called after a player selects an area with a selection-tool item.
1654
1663
  */
1655
- interface on_player_selected_area extends event {
1664
+ interface on_player_selected_area extends event {
1656
1665
  /**
1657
1666
  * The area selected.
1658
1667
  */
@@ -1681,13 +1690,13 @@ interface on_player_selected_area extends event {
1681
1690
  /**
1682
1691
  * Called when a player sets a quickbar slot to anything (new value, or set to empty).
1683
1692
  */
1684
- interface on_player_set_quick_bar_slot extends event {
1693
+ interface on_player_set_quick_bar_slot extends event {
1685
1694
  player_index: number
1686
1695
  }
1687
1696
  /**
1688
1697
  * Called when a player selects an area with a blueprint.
1689
1698
  */
1690
- interface on_player_setup_blueprint extends event {
1699
+ interface on_player_setup_blueprint extends event {
1691
1700
  /**
1692
1701
  * If normal selection or alt selection was used.
1693
1702
  */
@@ -1716,7 +1725,7 @@ interface on_player_setup_blueprint extends event {
1716
1725
  /**
1717
1726
  * Called when a player toggles alt mode, also known as "show entity info".
1718
1727
  */
1719
- interface on_player_toggled_alt_mode extends event {
1728
+ interface on_player_toggled_alt_mode extends event {
1720
1729
  /**
1721
1730
  * 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
1731
  */
@@ -1726,19 +1735,19 @@ interface on_player_toggled_alt_mode extends event {
1726
1735
  /**
1727
1736
  * Called when a player toggles the map editor on or off.
1728
1737
  */
1729
- interface on_player_toggled_map_editor extends event {
1738
+ interface on_player_toggled_map_editor extends event {
1730
1739
  player_index: number
1731
1740
  }
1732
1741
  /**
1733
1742
  * Called after a players trash inventory changed in some way.
1734
1743
  */
1735
- interface on_player_trash_inventory_changed extends event {
1744
+ interface on_player_trash_inventory_changed extends event {
1736
1745
  player_index: number
1737
1746
  }
1738
1747
  /**
1739
1748
  * Called when a player is un-banned.
1740
1749
  */
1741
- interface on_player_unbanned extends event {
1750
+ interface on_player_unbanned extends event {
1742
1751
  /**
1743
1752
  * The player that did the un-banning if any.
1744
1753
  */
@@ -1759,7 +1768,7 @@ interface on_player_unbanned extends event {
1759
1768
  /**
1760
1769
  * Called when a player is unmuted.
1761
1770
  */
1762
- interface on_player_unmuted extends event {
1771
+ interface on_player_unmuted extends event {
1763
1772
  /**
1764
1773
  * The player.
1765
1774
  */
@@ -1768,7 +1777,7 @@ interface on_player_unmuted extends event {
1768
1777
  /**
1769
1778
  * Called when a player uses a capsule that results in some game action.
1770
1779
  */
1771
- interface on_player_used_capsule extends event {
1780
+ interface on_player_used_capsule extends event {
1772
1781
  /**
1773
1782
  * The capsule item used.
1774
1783
  */
@@ -1785,7 +1794,7 @@ interface on_player_used_capsule extends event {
1785
1794
  /**
1786
1795
  * Called when a player uses spidertron remote to send a spidertron to a given position
1787
1796
  */
1788
- interface on_player_used_spider_remote extends event {
1797
+ interface on_player_used_spider_remote extends event {
1789
1798
  /**
1790
1799
  * The player that used the remote.
1791
1800
  */
@@ -1806,7 +1815,7 @@ interface on_player_used_spider_remote extends event {
1806
1815
  /**
1807
1816
  * Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter | runtime:LuaPostEntityDiedEventFilter}.
1808
1817
  */
1809
- interface on_post_entity_died extends event {
1818
+ interface on_post_entity_died extends event {
1810
1819
  /**
1811
1820
  * The corpses created by the entity dying if any.
1812
1821
  */
@@ -1843,7 +1852,7 @@ interface on_post_entity_died extends event {
1843
1852
  /**
1844
1853
  * Called when players uses an item to build something. Called before {@link on_built_entity | runtime:on_built_entity}.
1845
1854
  */
1846
- interface on_pre_build extends event {
1855
+ interface on_pre_build extends event {
1847
1856
  /**
1848
1857
  * Whether the item was placed while moving.
1849
1858
  */
@@ -1876,7 +1885,7 @@ interface on_pre_build extends event {
1876
1885
  /**
1877
1886
  * Called before one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
1878
1887
  */
1879
- interface on_pre_chunk_deleted extends event {
1888
+ interface on_pre_chunk_deleted extends event {
1880
1889
  /**
1881
1890
  * The chunks to be deleted.
1882
1891
  */
@@ -1886,7 +1895,7 @@ interface on_pre_chunk_deleted extends event {
1886
1895
  /**
1887
1896
  * Called before entity copy-paste is done.
1888
1897
  */
1889
- interface on_pre_entity_settings_pasted extends event {
1898
+ interface on_pre_entity_settings_pasted extends event {
1890
1899
  /**
1891
1900
  * The destination entity settings will be copied to.
1892
1901
  */
@@ -1900,7 +1909,7 @@ interface on_pre_entity_settings_pasted extends event {
1900
1909
  /**
1901
1910
  * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter | runtime:LuaPreGhostDeconstructedEventFilter}.
1902
1911
  */
1903
- interface on_pre_ghost_deconstructed extends event {
1912
+ interface on_pre_ghost_deconstructed extends event {
1904
1913
  ghost: LuaEntity
1905
1914
  /**
1906
1915
  * The player that did the deconstruction if any.
@@ -1910,7 +1919,7 @@ interface on_pre_ghost_deconstructed extends event {
1910
1919
  /**
1911
1920
  * Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter | runtime:LuaPreGhostUpgradedEventFilter}.
1912
1921
  */
1913
- interface on_pre_ghost_upgraded extends event {
1922
+ interface on_pre_ghost_upgraded extends event {
1914
1923
  ghost: LuaEntity
1915
1924
  /**
1916
1925
  * The player that did the upgrade if any.
@@ -1921,7 +1930,7 @@ interface on_pre_ghost_upgraded extends event {
1921
1930
  /**
1922
1931
  * Called directly before a permission group is deleted.
1923
1932
  */
1924
- interface on_pre_permission_group_deleted extends event {
1933
+ interface on_pre_permission_group_deleted extends event {
1925
1934
  /**
1926
1935
  * The group to be deleted.
1927
1936
  */
@@ -1934,7 +1943,7 @@ interface on_pre_permission_group_deleted extends event {
1934
1943
  /**
1935
1944
  * Called directly before a permission string is imported.
1936
1945
  */
1937
- interface on_pre_permission_string_imported extends event {
1946
+ interface on_pre_permission_string_imported extends event {
1938
1947
  /**
1939
1948
  * The player importing the string.
1940
1949
  */
@@ -1943,7 +1952,7 @@ interface on_pre_permission_string_imported extends event {
1943
1952
  /**
1944
1953
  * Called when a player queues something to be crafted.
1945
1954
  */
1946
- interface on_pre_player_crafted_item extends event {
1955
+ interface on_pre_player_crafted_item extends event {
1947
1956
  /**
1948
1957
  * The items removed from the players inventory to do the crafting.
1949
1958
  */
@@ -1964,21 +1973,21 @@ interface on_pre_player_crafted_item extends event {
1964
1973
  /**
1965
1974
  * Called before a players dies.
1966
1975
  */
1967
- interface on_pre_player_died extends event {
1976
+ interface on_pre_player_died extends event {
1968
1977
  cause?: LuaEntity
1969
1978
  player_index: number
1970
1979
  }
1971
1980
  /**
1972
1981
  * Called before a player leaves the game.
1973
1982
  */
1974
- interface on_pre_player_left_game extends event {
1983
+ interface on_pre_player_left_game extends event {
1975
1984
  player_index: number
1976
1985
  reason: defines.disconnect_reason
1977
1986
  }
1978
1987
  /**
1979
1988
  * 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
1989
  */
1981
- interface on_pre_player_mined_item extends event {
1990
+ interface on_pre_player_mined_item extends event {
1982
1991
  /**
1983
1992
  * The entity being mined
1984
1993
  */
@@ -1988,7 +1997,7 @@ interface on_pre_player_mined_item extends event {
1988
1997
  /**
1989
1998
  * 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
1999
  */
1991
- interface on_pre_player_removed extends event {
2000
+ interface on_pre_player_removed extends event {
1992
2001
  /**
1993
2002
  * The index of the removed player.
1994
2003
  */
@@ -1997,13 +2006,13 @@ interface on_pre_player_removed extends event {
1997
2006
  /**
1998
2007
  * Called before a player toggles the map editor on or off.
1999
2008
  */
2000
- interface on_pre_player_toggled_map_editor extends event {
2009
+ interface on_pre_player_toggled_map_editor extends event {
2001
2010
  player_index: number
2002
2011
  }
2003
2012
  /**
2004
2013
  * Called directly before a robot explodes cliffs.
2005
2014
  */
2006
- interface on_pre_robot_exploded_cliff extends event {
2015
+ interface on_pre_robot_exploded_cliff extends event {
2007
2016
  cliff: LuaEntity
2008
2017
  /**
2009
2018
  * The cliff explosive used.
@@ -2014,7 +2023,7 @@ interface on_pre_robot_exploded_cliff extends event {
2014
2023
  /**
2015
2024
  * Called just before a script inventory is resized.
2016
2025
  */
2017
- interface on_pre_script_inventory_resized extends event {
2026
+ interface on_pre_script_inventory_resized extends event {
2018
2027
  inventory: LuaInventory
2019
2028
  /**
2020
2029
  * The mod that did the resizing. This will be `"core"` if done by console command or scenario script.
@@ -2036,19 +2045,19 @@ interface on_pre_script_inventory_resized extends event {
2036
2045
  /**
2037
2046
  * Called just before a surface is cleared (all entities removed and all chunks deleted).
2038
2047
  */
2039
- interface on_pre_surface_cleared extends event {
2048
+ interface on_pre_surface_cleared extends event {
2040
2049
  surface_index: number
2041
2050
  }
2042
2051
  /**
2043
2052
  * Called just before a surface is deleted.
2044
2053
  */
2045
- interface on_pre_surface_deleted extends event {
2054
+ interface on_pre_surface_deleted extends event {
2046
2055
  surface_index: number
2047
2056
  }
2048
2057
  /**
2049
2058
  * Called when research is cancelled.
2050
2059
  */
2051
- interface on_research_cancelled extends event {
2060
+ interface on_research_cancelled extends event {
2052
2061
  /**
2053
2062
  * The force whose research was cancelled.
2054
2063
  */
@@ -2061,7 +2070,7 @@ interface on_research_cancelled extends event {
2061
2070
  /**
2062
2071
  * Called when a research finishes.
2063
2072
  */
2064
- interface on_research_finished extends event {
2073
+ interface on_research_finished extends event {
2065
2074
  /**
2066
2075
  * If the technology was researched by script.
2067
2076
  */
@@ -2074,7 +2083,7 @@ interface on_research_finished extends event {
2074
2083
  /**
2075
2084
  * Called when a research is reversed (unresearched).
2076
2085
  */
2077
- interface on_research_reversed extends event {
2086
+ interface on_research_reversed extends event {
2078
2087
  /**
2079
2088
  * If the technology was un-researched by script.
2080
2089
  */
@@ -2087,7 +2096,7 @@ interface on_research_reversed extends event {
2087
2096
  /**
2088
2097
  * Called when a technology research starts.
2089
2098
  */
2090
- interface on_research_started extends event {
2099
+ interface on_research_started extends event {
2091
2100
  last_research?: LuaTechnology
2092
2101
  /**
2093
2102
  * The technology being researched
@@ -2097,13 +2106,13 @@ interface on_research_started extends event {
2097
2106
  /**
2098
2107
  * Called when a resource entity reaches 0 or its minimum yield for infinite resources.
2099
2108
  */
2100
- interface on_resource_depleted extends event {
2109
+ interface on_resource_depleted extends event {
2101
2110
  entity: LuaEntity
2102
2111
  }
2103
2112
  /**
2104
2113
  * Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter | runtime:LuaRobotBuiltEntityEventFilter}.
2105
2114
  */
2106
- interface on_robot_built_entity extends event {
2115
+ interface on_robot_built_entity extends event {
2107
2116
  /**
2108
2117
  * The entity built.
2109
2118
  */
@@ -2124,7 +2133,7 @@ interface on_robot_built_entity extends event {
2124
2133
  /**
2125
2134
  * Called after a robot builds tiles.
2126
2135
  */
2127
- interface on_robot_built_tile extends event {
2136
+ interface on_robot_built_tile extends event {
2128
2137
  /**
2129
2138
  * The item type used to build the tiles.
2130
2139
  */
@@ -2153,7 +2162,7 @@ interface on_robot_built_tile extends event {
2153
2162
  /**
2154
2163
  * Called directly after a robot explodes cliffs.
2155
2164
  */
2156
- interface on_robot_exploded_cliff extends event {
2165
+ interface on_robot_exploded_cliff extends event {
2157
2166
  /**
2158
2167
  * The cliff explosive used.
2159
2168
  */
@@ -2163,7 +2172,7 @@ interface on_robot_exploded_cliff extends event {
2163
2172
  /**
2164
2173
  * Called when a robot mines an entity.
2165
2174
  */
2166
- interface on_robot_mined extends event {
2175
+ interface on_robot_mined extends event {
2167
2176
  /**
2168
2177
  * The entity the robot just picked up.
2169
2178
  */
@@ -2179,7 +2188,7 @@ interface on_robot_mined extends event {
2179
2188
  * 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
2189
  *
2181
2190
  */
2182
- interface on_robot_mined_entity extends event {
2191
+ interface on_robot_mined_entity extends event {
2183
2192
  /**
2184
2193
  * The temporary inventory that holds the result of mining the entity.
2185
2194
  */
@@ -2196,7 +2205,7 @@ interface on_robot_mined_entity extends event {
2196
2205
  /**
2197
2206
  * Called after a robot mines tiles.
2198
2207
  */
2199
- interface on_robot_mined_tile extends event {
2208
+ interface on_robot_mined_tile extends event {
2200
2209
  /**
2201
2210
  * The robot.
2202
2211
  */
@@ -2213,7 +2222,7 @@ interface on_robot_mined_tile extends event {
2213
2222
  /**
2214
2223
  * Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter | runtime:LuaPreRobotMinedEntityEventFilter}.
2215
2224
  */
2216
- interface on_robot_pre_mined extends event {
2225
+ interface on_robot_pre_mined extends event {
2217
2226
  /**
2218
2227
  * The entity which is about to be mined.
2219
2228
  */
@@ -2226,7 +2235,7 @@ interface on_robot_pre_mined extends event {
2226
2235
  /**
2227
2236
  * Called when a rocket silo is ordered to be launched.
2228
2237
  */
2229
- interface on_rocket_launch_ordered extends event {
2238
+ interface on_rocket_launch_ordered extends event {
2230
2239
  /**
2231
2240
  * The player that is riding the rocket, if any.
2232
2241
  */
@@ -2237,7 +2246,7 @@ interface on_rocket_launch_ordered extends event {
2237
2246
  /**
2238
2247
  * Called when the rocket is launched.
2239
2248
  */
2240
- interface on_rocket_launched extends event {
2249
+ interface on_rocket_launched extends event {
2241
2250
  /**
2242
2251
  * The player that is riding the rocket, if any.
2243
2252
  */
@@ -2248,7 +2257,7 @@ interface on_rocket_launched extends event {
2248
2257
  /**
2249
2258
  * Called when a runtime mod setting is changed by a player.
2250
2259
  */
2251
- interface on_runtime_mod_setting_changed extends event {
2260
+ interface on_runtime_mod_setting_changed extends event {
2252
2261
  /**
2253
2262
  * 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
2263
  */
@@ -2265,7 +2274,7 @@ interface on_runtime_mod_setting_changed extends event {
2265
2274
  /**
2266
2275
  * Called just after a script inventory is resized.
2267
2276
  */
2268
- interface on_script_inventory_resized extends event {
2277
+ interface on_script_inventory_resized extends event {
2269
2278
  inventory: LuaInventory
2270
2279
  /**
2271
2280
  * The mod that did the resizing. This will be `"core"` if done by console command or scenario script.
@@ -2291,7 +2300,7 @@ interface on_script_inventory_resized extends event {
2291
2300
  /**
2292
2301
  * Called when a {@link LuaSurface::request_path | runtime:LuaSurface::request_path} call completes.
2293
2302
  */
2294
- interface on_script_path_request_finished extends event {
2303
+ interface on_script_path_request_finished extends event {
2295
2304
  /**
2296
2305
  * Handle to associate the callback with a particular call to {@link LuaSurface::request_path | runtime:LuaSurface::request_path}.
2297
2306
  */
@@ -2308,7 +2317,7 @@ interface on_script_path_request_finished extends event {
2308
2317
  /**
2309
2318
  * Called when a script trigger effect is triggered.
2310
2319
  */
2311
- interface on_script_trigger_effect extends event {
2320
+ interface on_script_trigger_effect extends event {
2312
2321
  /**
2313
2322
  * The effect_id specified in the trigger effect.
2314
2323
  */
@@ -2325,7 +2334,7 @@ interface on_script_trigger_effect extends event {
2325
2334
  /**
2326
2335
  * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter | runtime:LuaSectorScannedEventFilter}.
2327
2336
  */
2328
- interface on_sector_scanned extends event {
2337
+ interface on_sector_scanned extends event {
2329
2338
  /**
2330
2339
  * Area of the scanned chunk.
2331
2340
  */
@@ -2342,7 +2351,7 @@ interface on_sector_scanned extends event {
2342
2351
  /**
2343
2352
  * Called after the selected entity changes for a given player.
2344
2353
  */
2345
- interface on_selected_entity_changed extends event {
2354
+ interface on_selected_entity_changed extends event {
2346
2355
  /**
2347
2356
  * The last selected entity if it still exists and there was one.
2348
2357
  */
@@ -2355,7 +2364,7 @@ interface on_selected_entity_changed extends event {
2355
2364
  /**
2356
2365
  * Called when a spider finishes moving to its autopilot position.
2357
2366
  */
2358
- interface on_spider_command_completed extends event {
2367
+ interface on_spider_command_completed extends event {
2359
2368
  /**
2360
2369
  * Spider vehicle which was requested to move.
2361
2370
  */
@@ -2364,7 +2373,7 @@ interface on_spider_command_completed extends event {
2364
2373
  /**
2365
2374
  * 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
2375
  */
2367
- interface on_string_translated extends event {
2376
+ interface on_string_translated extends event {
2368
2377
  /**
2369
2378
  * The unique id for this translation request.
2370
2379
  */
@@ -2389,7 +2398,7 @@ interface on_string_translated extends event {
2389
2398
  /**
2390
2399
  * Called just after a surface is cleared (all entities removed and all chunks deleted).
2391
2400
  */
2392
- interface on_surface_cleared extends event {
2401
+ interface on_surface_cleared extends event {
2393
2402
  surface_index: number
2394
2403
  }
2395
2404
  /**
@@ -2398,19 +2407,19 @@ interface on_surface_cleared extends event {
2398
2407
  * This is not called when the default surface is created as it will always exist.
2399
2408
  *
2400
2409
  */
2401
- interface on_surface_created extends event {
2410
+ interface on_surface_created extends event {
2402
2411
  surface_index: number
2403
2412
  }
2404
2413
  /**
2405
2414
  * Called after a surface is deleted.
2406
2415
  */
2407
- interface on_surface_deleted extends event {
2416
+ interface on_surface_deleted extends event {
2408
2417
  surface_index: number
2409
2418
  }
2410
2419
  /**
2411
2420
  * Called after a surface is imported via the map editor.
2412
2421
  */
2413
- interface on_surface_imported extends event {
2422
+ interface on_surface_imported extends event {
2414
2423
  /**
2415
2424
  * The original surface name.
2416
2425
  */
@@ -2420,7 +2429,7 @@ interface on_surface_imported extends event {
2420
2429
  /**
2421
2430
  * Called when a surface is renamed.
2422
2431
  */
2423
- interface on_surface_renamed extends event {
2432
+ interface on_surface_renamed extends event {
2424
2433
  new_name: string
2425
2434
  old_name: string
2426
2435
  surface_index: number
@@ -2428,25 +2437,25 @@ interface on_surface_renamed extends event {
2428
2437
  /**
2429
2438
  * Called when {@link LuaForce::reset_technology_effects | runtime:LuaForce::reset_technology_effects} is finished.
2430
2439
  */
2431
- interface on_technology_effects_reset extends event {
2440
+ interface on_technology_effects_reset extends event {
2432
2441
  force: LuaForce
2433
2442
  }
2434
2443
  /**
2435
2444
  * It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
2436
2445
  */
2437
- interface on_tick extends event {
2446
+ interface on_tick extends event {
2438
2447
  }
2439
2448
  /**
2440
2449
  * Called when a train changes state (started to stopped and vice versa)
2441
2450
  */
2442
- interface on_train_changed_state extends event {
2451
+ interface on_train_changed_state extends event {
2443
2452
  old_state: defines.train_state
2444
2453
  train: LuaTrain
2445
2454
  }
2446
2455
  /**
2447
2456
  * Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
2448
2457
  */
2449
- interface on_train_created extends event {
2458
+ interface on_train_created extends event {
2450
2459
  /**
2451
2460
  * The first old train id when splitting/merging trains.
2452
2461
  */
@@ -2460,7 +2469,7 @@ interface on_train_created extends event {
2460
2469
  /**
2461
2470
  * Called when a trains schedule is changed either by the player or through script.
2462
2471
  */
2463
- interface on_train_schedule_changed extends event {
2472
+ interface on_train_schedule_changed extends event {
2464
2473
  /**
2465
2474
  * The player who made the change if any.
2466
2475
  */
@@ -2470,53 +2479,53 @@ interface on_train_schedule_changed extends event {
2470
2479
  /**
2471
2480
  * Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity="true"`.
2472
2481
  */
2473
- interface on_trigger_created_entity extends event {
2482
+ interface on_trigger_created_entity extends event {
2474
2483
  entity: LuaEntity
2475
2484
  source?: LuaEntity
2476
2485
  }
2477
2486
  /**
2478
2487
  * 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
2488
  */
2480
- interface on_trigger_fired_artillery extends event {
2489
+ interface on_trigger_fired_artillery extends event {
2481
2490
  entity: LuaEntity
2482
2491
  source?: LuaEntity
2483
2492
  }
2484
2493
  /**
2485
2494
  * Called when a unit is added to a unit group.
2486
2495
  */
2487
- interface on_unit_added_to_group extends event {
2496
+ interface on_unit_added_to_group extends event {
2488
2497
  group: LuaUnitGroup
2489
2498
  unit: LuaEntity
2490
2499
  }
2491
2500
  /**
2492
2501
  * Called when a new unit group is created, before any members are added to it.
2493
2502
  */
2494
- interface on_unit_group_created extends event {
2503
+ interface on_unit_group_created extends event {
2495
2504
  group: LuaUnitGroup
2496
2505
  }
2497
2506
  /**
2498
2507
  * Called when a unit group finishes gathering and starts executing its command.
2499
2508
  */
2500
- interface on_unit_group_finished_gathering extends event {
2509
+ interface on_unit_group_finished_gathering extends event {
2501
2510
  group: LuaUnitGroup
2502
2511
  }
2503
2512
  /**
2504
2513
  * Called when a unit is removed from a unit group.
2505
2514
  */
2506
- interface on_unit_removed_from_group extends event {
2515
+ interface on_unit_removed_from_group extends event {
2507
2516
  group: LuaUnitGroup
2508
2517
  unit: LuaEntity
2509
2518
  }
2510
2519
  /**
2511
2520
  * Called when a worker (construction or logistic) robot expires through a lack of energy.
2512
2521
  */
2513
- interface on_worker_robot_expired extends event {
2522
+ interface on_worker_robot_expired extends event {
2514
2523
  robot: LuaEntity
2515
2524
  }
2516
2525
  /**
2517
2526
  * 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
2527
  */
2519
- interface script_raised_built extends event {
2528
+ interface script_raised_built extends event {
2520
2529
  /**
2521
2530
  * The entity that has been built.
2522
2531
  */
@@ -2525,7 +2534,7 @@ interface script_raised_built extends event {
2525
2534
  /**
2526
2535
  * 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
2536
  */
2528
- interface script_raised_destroy extends event {
2537
+ interface script_raised_destroy extends event {
2529
2538
  /**
2530
2539
  * The entity that was destroyed.
2531
2540
  */
@@ -2534,7 +2543,7 @@ interface script_raised_destroy extends event {
2534
2543
  /**
2535
2544
  * 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
2545
  */
2537
- interface script_raised_revive extends event {
2546
+ interface script_raised_revive extends event {
2538
2547
  /**
2539
2548
  * The entity that was revived.
2540
2549
  */
@@ -2547,7 +2556,7 @@ interface script_raised_revive extends event {
2547
2556
  /**
2548
2557
  * 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
2558
  */
2550
- interface script_raised_set_tiles extends event {
2559
+ interface script_raised_set_tiles extends event {
2551
2560
  /**
2552
2561
  * The surface whose tiles were changed.
2553
2562
  */
@@ -2560,7 +2569,7 @@ interface script_raised_set_tiles extends event {
2560
2569
  /**
2561
2570
  * 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
2571
  */
2563
- interface script_raised_teleported extends event {
2572
+ interface script_raised_teleported extends event {
2564
2573
  /**
2565
2574
  * The entity that was teleported.
2566
2575
  */
@@ -2574,3 +2583,5 @@ interface script_raised_teleported extends event {
2574
2583
  */
2575
2584
  old_surface_index: number
2576
2585
  }
2586
+
2587
+ }