typed-factorio 1.4.0 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -4,8 +4,7 @@
4
4
 
5
5
  /**
6
6
  * Called when a {@linkplain https://wiki.factorio.com/Prototype/CustomInput CustomInput} is activated.
7
- *
8
- * {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent View documentation}
7
+ * @see {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent Online documentation}
9
8
  */
10
9
  interface CustomInputEvent extends EventData {
11
10
  /**
@@ -19,7 +18,7 @@ interface CustomInputEvent extends EventData {
19
18
  /**
20
19
  * The mouse cursor position when the custom input was activated.
21
20
  */
22
- readonly cursor_position: MapPositionTable
21
+ readonly cursor_position: MapPosition
23
22
  /**
24
23
  * Information about the prototype that is selected when the custom input is used. Needs to be enabled on the custom input's prototype. `nil` if none is selected.
25
24
  */
@@ -36,8 +35,7 @@ interface CustomInputEvent extends EventData {
36
35
 
37
36
  /**
38
37
  * Called when a unit/group completes a command.
39
- *
40
- * {@link https://lua-api.factorio.com/latest/events.html#on_ai_command_completed View documentation}
38
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_ai_command_completed Online documentation}
41
39
  */
42
40
  interface OnAiCommandCompletedEvent extends EventData {
43
41
  /**
@@ -61,14 +59,13 @@ interface OnAiCommandCompletedEvent extends EventData {
61
59
 
62
60
  /**
63
61
  * Called when an area of the map is cloned.
64
- *
65
- * {@link https://lua-api.factorio.com/latest/events.html#on_area_cloned View documentation}
62
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_area_cloned Online documentation}
66
63
  */
67
64
  interface OnAreaClonedEvent extends EventData {
68
65
  readonly source_surface: LuaSurface
69
- readonly source_area: BoundingBoxRead
66
+ readonly source_area: BoundingBox
70
67
  readonly destination_surface: LuaSurface
71
- readonly destination_area: BoundingBoxRead
68
+ readonly destination_area: BoundingBox
72
69
  readonly destination_force?: LuaForce
73
70
  readonly clone_tiles: boolean
74
71
  readonly clone_entities: boolean
@@ -87,12 +84,8 @@ interface OnAreaClonedEvent extends EventData {
87
84
 
88
85
  /**
89
86
  * Called when a biter migration builds a base.
90
- *
91
- * **Note**
92
- *
93
- * This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
94
- *
95
- * {@link https://lua-api.factorio.com/latest/events.html#on_biter_base_built View documentation}
87
+ * @remarks This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
88
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_biter_base_built Online documentation}
96
89
  */
97
90
  interface OnBiterBaseBuiltEvent extends EventData {
98
91
  /**
@@ -111,14 +104,13 @@ interface OnBiterBaseBuiltEvent extends EventData {
111
104
 
112
105
  /**
113
106
  * Called when a set of positions on the map is cloned.
114
- *
115
- * {@link https://lua-api.factorio.com/latest/events.html#on_brush_cloned View documentation}
107
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_brush_cloned Online documentation}
116
108
  */
117
109
  interface OnBrushClonedEvent extends EventData {
118
- readonly source_offset: TilePositionTable
119
- readonly destination_offset: TilePositionTable
110
+ readonly source_offset: TilePosition
111
+ readonly destination_offset: TilePosition
120
112
  readonly source_surface: LuaSurface
121
- readonly source_positions: TilePositionTable[]
113
+ readonly source_positions: TilePosition[]
122
114
  readonly destination_surface: LuaSurface
123
115
  readonly destination_force?: LuaForce
124
116
  readonly clone_tiles: boolean
@@ -138,8 +130,7 @@ interface OnBrushClonedEvent extends EventData {
138
130
 
139
131
  /**
140
132
  * Called when a {@link defines.command.build_base} command reaches its destination, and before building starts.
141
- *
142
- * {@link https://lua-api.factorio.com/latest/events.html#on_build_base_arrived View documentation}
133
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_build_base_arrived Online documentation}
143
134
  */
144
135
  interface OnBuildBaseArrivedEvent extends EventData {
145
136
  /**
@@ -162,8 +153,7 @@ interface OnBuildBaseArrivedEvent extends EventData {
162
153
 
163
154
  /**
164
155
  * Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter}.
165
- *
166
- * {@link https://lua-api.factorio.com/latest/events.html#on_built_entity View documentation}
156
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_built_entity Online documentation}
167
157
  */
168
158
  interface OnBuiltEntityEvent extends EventData {
169
159
  readonly created_entity: LuaEntity
@@ -189,8 +179,7 @@ interface OnBuiltEntityEvent extends EventData {
189
179
 
190
180
  /**
191
181
  * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter}.
192
- *
193
- * {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_deconstruction View documentation}
182
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_deconstruction Online documentation}
194
183
  */
195
184
  interface OnCancelledDeconstructionEvent extends EventData {
196
185
  readonly entity: LuaEntity
@@ -207,12 +196,13 @@ interface OnCancelledDeconstructionEvent extends EventData {
207
196
 
208
197
  /**
209
198
  * Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter}.
210
- *
211
- * {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_upgrade View documentation}
199
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_upgrade Online documentation}
212
200
  */
213
201
  interface OnCancelledUpgradeEvent extends EventData {
214
202
  readonly entity: LuaEntity
215
203
  readonly player_index?: PlayerIndex
204
+ readonly target: LuaEntityPrototype
205
+ readonly direction?: defines.direction
216
206
  /**
217
207
  * Identifier of the event
218
208
  */
@@ -225,12 +215,8 @@ interface OnCancelledUpgradeEvent extends EventData {
225
215
 
226
216
  /**
227
217
  * Called when a character corpse expires due to timeout or all of the items being removed from it.
228
- *
229
- * **Note**
230
- *
231
- * this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
232
- *
233
- * {@link https://lua-api.factorio.com/latest/events.html#on_character_corpse_expired View documentation}
218
+ * @remarks this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
219
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_character_corpse_expired Online documentation}
234
220
  */
235
221
  interface OnCharacterCorpseExpiredEvent extends EventData {
236
222
  /**
@@ -249,8 +235,7 @@ interface OnCharacterCorpseExpiredEvent extends EventData {
249
235
 
250
236
  /**
251
237
  * Called when a chart tag is created.
252
- *
253
- * {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_added View documentation}
238
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_added Online documentation}
254
239
  */
255
240
  interface OnChartTagAddedEvent extends EventData {
256
241
  readonly tag: LuaCustomChartTag
@@ -268,8 +253,7 @@ interface OnChartTagAddedEvent extends EventData {
268
253
 
269
254
  /**
270
255
  * Called when a chart tag is modified by a player.
271
- *
272
- * {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_modified View documentation}
256
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_modified Online documentation}
273
257
  */
274
258
  interface OnChartTagModifiedEvent extends EventData {
275
259
  readonly tag: LuaCustomChartTag
@@ -290,8 +274,7 @@ interface OnChartTagModifiedEvent extends EventData {
290
274
 
291
275
  /**
292
276
  * Called just before a chart tag is deleted.
293
- *
294
- * {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_removed View documentation}
277
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_removed Online documentation}
295
278
  */
296
279
  interface OnChartTagRemovedEvent extends EventData {
297
280
  readonly tag: LuaCustomChartTag
@@ -309,16 +292,15 @@ interface OnChartTagRemovedEvent extends EventData {
309
292
 
310
293
  /**
311
294
  * Called when a chunk is charted or re-charted.
312
- *
313
- * {@link https://lua-api.factorio.com/latest/events.html#on_chunk_charted View documentation}
295
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_chunk_charted Online documentation}
314
296
  */
315
297
  interface OnChunkChartedEvent extends EventData {
316
298
  readonly surface_index: SurfaceIndex
317
- readonly position: ChunkPositionTable
299
+ readonly position: ChunkPosition
318
300
  /**
319
301
  * Area of the chunk.
320
302
  */
321
- readonly area: BoundingBoxRead
303
+ readonly area: BoundingBox
322
304
  readonly force: LuaForce
323
305
  /**
324
306
  * Identifier of the event
@@ -332,15 +314,14 @@ interface OnChunkChartedEvent extends EventData {
332
314
 
333
315
  /**
334
316
  * Called when one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
335
- *
336
- * {@link https://lua-api.factorio.com/latest/events.html#on_chunk_deleted View documentation}
317
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_chunk_deleted Online documentation}
337
318
  */
338
319
  interface OnChunkDeletedEvent extends EventData {
339
320
  readonly surface_index: SurfaceIndex
340
321
  /**
341
322
  * The chunks deleted.
342
323
  */
343
- readonly positions: ChunkPositionTable[]
324
+ readonly positions: ChunkPosition[]
344
325
  /**
345
326
  * Identifier of the event
346
327
  */
@@ -353,18 +334,17 @@ interface OnChunkDeletedEvent extends EventData {
353
334
 
354
335
  /**
355
336
  * Called when a chunk is generated.
356
- *
357
- * {@link https://lua-api.factorio.com/latest/events.html#on_chunk_generated View documentation}
337
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_chunk_generated Online documentation}
358
338
  */
359
339
  interface OnChunkGeneratedEvent extends EventData {
360
340
  /**
361
341
  * Area of the chunk.
362
342
  */
363
- readonly area: BoundingBoxRead
343
+ readonly area: BoundingBox
364
344
  /**
365
345
  * Position of the chunk.
366
346
  */
367
- readonly position: ChunkPositionTable
347
+ readonly position: ChunkPosition
368
348
  /**
369
349
  * The surface the chunk is on.
370
350
  */
@@ -381,8 +361,7 @@ interface OnChunkGeneratedEvent extends EventData {
381
361
 
382
362
  /**
383
363
  * Called when a combat robot expires through a lack of energy, or timeout.
384
- *
385
- * {@link https://lua-api.factorio.com/latest/events.html#on_combat_robot_expired View documentation}
364
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_combat_robot_expired Online documentation}
386
365
  */
387
366
  interface OnCombatRobotExpiredEvent extends EventData {
388
367
  readonly robot: LuaEntity
@@ -402,12 +381,8 @@ interface OnCombatRobotExpiredEvent extends EventData {
402
381
 
403
382
  /**
404
383
  * Called when a message is sent to the in-game console, either by a player or through the server interface.
405
- *
406
- * **Note**
407
- *
408
- * This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
409
- *
410
- * {@link https://lua-api.factorio.com/latest/events.html#on_console_chat View documentation}
384
+ * @remarks This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
385
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_console_chat Online documentation}
411
386
  */
412
387
  interface OnConsoleChatEvent extends EventData {
413
388
  /**
@@ -430,8 +405,7 @@ interface OnConsoleChatEvent extends EventData {
430
405
 
431
406
  /**
432
407
  * Called when someone enters a command-like message regardless of it being a valid command.
433
- *
434
- * {@link https://lua-api.factorio.com/latest/events.html#on_console_command View documentation}
408
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_console_command Online documentation}
435
409
  */
436
410
  interface OnConsoleCommandEvent extends EventData {
437
411
  /**
@@ -458,8 +432,7 @@ interface OnConsoleCommandEvent extends EventData {
458
432
 
459
433
  /**
460
434
  * Called when a cutscene is cancelled by the player or by script.
461
- *
462
- * {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_cancelled View documentation}
435
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_cancelled Online documentation}
463
436
  */
464
437
  interface OnCutsceneCancelledEvent extends EventData {
465
438
  /**
@@ -480,12 +453,8 @@ interface OnCutsceneCancelledEvent extends EventData {
480
453
  * Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.
481
454
  *
482
455
  * This refers to an index in the table previously passed to set_controller which started the cutscene.
483
- *
484
- * **Note**
485
- *
486
- * Due to implementation omission, waypoint_index is 0-based.
487
- *
488
- * {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_waypoint_reached View documentation}
456
+ * @remarks Due to implementation omission, waypoint_index is 0-based.
457
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_waypoint_reached Online documentation}
489
458
  */
490
459
  interface OnCutsceneWaypointReachedEvent extends EventData {
491
460
  /**
@@ -508,12 +477,8 @@ interface OnCutsceneWaypointReachedEvent extends EventData {
508
477
 
509
478
  /**
510
479
  * Called when the map difficulty settings are changed.
511
- *
512
- * **Note**
513
- *
514
- * It's not guaranteed that both settings are changed - just that at least one has been changed.
515
- *
516
- * {@link https://lua-api.factorio.com/latest/events.html#on_difficulty_settings_changed View documentation}
480
+ * @remarks It's not guaranteed that both settings are changed - just that at least one has been changed.
481
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_difficulty_settings_changed Online documentation}
517
482
  */
518
483
  interface OnDifficultySettingsChangedEvent extends EventData {
519
484
  readonly old_recipe_difficulty: uint
@@ -530,8 +495,7 @@ interface OnDifficultySettingsChangedEvent extends EventData {
530
495
 
531
496
  /**
532
497
  * Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter}.
533
- *
534
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_cloned View documentation}
498
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_cloned Online documentation}
535
499
  */
536
500
  interface OnEntityClonedEvent extends EventData {
537
501
  readonly source: LuaEntity
@@ -548,12 +512,8 @@ interface OnEntityClonedEvent extends EventData {
548
512
 
549
513
  /**
550
514
  * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter}.
551
- *
552
- * **Note**
553
- *
554
- * This is not called when an entities health is set directly by another mod.
555
- *
556
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_damaged View documentation}
515
+ * @remarks This is not called when an entities health is set directly by another mod.
516
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_damaged Online documentation}
557
517
  */
558
518
  interface OnEntityDamagedEvent extends EventData {
559
519
  readonly entity: LuaEntity
@@ -590,12 +550,8 @@ interface OnEntityDamagedEvent extends EventData {
590
550
 
591
551
  /**
592
552
  * Called after an entity is destroyed that has been registered with {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap::register_on_entity_destroyed}.
593
- *
594
- * **Note**
595
- *
596
- * 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.
597
- *
598
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_destroyed View documentation}
553
+ * @remarks 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.
554
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_destroyed Online documentation}
599
555
  */
600
556
  interface OnEntityDestroyedEvent extends EventData {
601
557
  /**
@@ -618,8 +574,7 @@ interface OnEntityDestroyedEvent extends EventData {
618
574
 
619
575
  /**
620
576
  * Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter}.
621
- *
622
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_died View documentation}
577
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_died Online documentation}
623
578
  */
624
579
  interface OnEntityDiedEvent extends EventData {
625
580
  /**
@@ -654,12 +609,8 @@ interface OnEntityDiedEvent extends EventData {
654
609
 
655
610
  /**
656
611
  * Called when one of an entity's personal logistic slots changes.
657
- *
658
- * **Note**
659
- *
660
- * "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the request slots on logistic chests.
661
- *
662
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_logistic_slot_changed View documentation}
612
+ * @remarks "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the request slots on logistic chests.
613
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_logistic_slot_changed Online documentation}
663
614
  */
664
615
  interface OnEntityLogisticSlotChangedEvent extends EventData {
665
616
  /**
@@ -686,8 +637,7 @@ interface OnEntityLogisticSlotChangedEvent extends EventData {
686
637
 
687
638
  /**
688
639
  * Called after an entity has been renamed either by the player or through script.
689
- *
690
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_renamed View documentation}
640
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_renamed Online documentation}
691
641
  */
692
642
  interface OnEntityRenamedEvent extends EventData {
693
643
  /**
@@ -709,8 +659,7 @@ interface OnEntityRenamedEvent extends EventData {
709
659
 
710
660
  /**
711
661
  * Called after entity copy-paste is done.
712
- *
713
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted View documentation}
662
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted Online documentation}
714
663
  */
715
664
  interface OnEntitySettingsPastedEvent extends EventData {
716
665
  readonly player_index: PlayerIndex
@@ -734,8 +683,7 @@ interface OnEntitySettingsPastedEvent extends EventData {
734
683
 
735
684
  /**
736
685
  * Called when an entity is spawned by a EnemySpawner
737
- *
738
- * {@link https://lua-api.factorio.com/latest/events.html#on_entity_spawned View documentation}
686
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_spawned Online documentation}
739
687
  */
740
688
  interface OnEntitySpawnedEvent extends EventData {
741
689
  readonly spawner: LuaEntity
@@ -752,8 +700,7 @@ interface OnEntitySpawnedEvent extends EventData {
752
700
 
753
701
  /**
754
702
  * Called after equipment is inserted into an equipment grid.
755
- *
756
- * {@link https://lua-api.factorio.com/latest/events.html#on_equipment_inserted View documentation}
703
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_equipment_inserted Online documentation}
757
704
  */
758
705
  interface OnEquipmentInsertedEvent extends EventData {
759
706
  /**
@@ -776,8 +723,7 @@ interface OnEquipmentInsertedEvent extends EventData {
776
723
 
777
724
  /**
778
725
  * Called after equipment is removed from an equipment grid.
779
- *
780
- * {@link https://lua-api.factorio.com/latest/events.html#on_equipment_removed View documentation}
726
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_equipment_removed Online documentation}
781
727
  */
782
728
  interface OnEquipmentRemovedEvent extends EventData {
783
729
  /**
@@ -804,8 +750,7 @@ interface OnEquipmentRemovedEvent extends EventData {
804
750
 
805
751
  /**
806
752
  * Called when the a forces cease fire values change.
807
- *
808
- * {@link https://lua-api.factorio.com/latest/events.html#on_force_cease_fire_changed View documentation}
753
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_force_cease_fire_changed Online documentation}
809
754
  */
810
755
  interface OnForceCeaseFireChangedEvent extends EventData {
811
756
  /**
@@ -832,12 +777,8 @@ interface OnForceCeaseFireChangedEvent extends EventData {
832
777
 
833
778
  /**
834
779
  * Called when a new force is created using `game.create_force()`
835
- *
836
- * **Note**
837
- *
838
- * This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
839
- *
840
- * {@link https://lua-api.factorio.com/latest/events.html#on_force_created View documentation}
780
+ * @remarks This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
781
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_force_created Online documentation}
841
782
  */
842
783
  interface OnForceCreatedEvent extends EventData {
843
784
  /**
@@ -856,8 +797,7 @@ interface OnForceCreatedEvent extends EventData {
856
797
 
857
798
  /**
858
799
  * Called when the a forces friends change.
859
- *
860
- * {@link https://lua-api.factorio.com/latest/events.html#on_force_friends_changed View documentation}
800
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_force_friends_changed Online documentation}
861
801
  */
862
802
  interface OnForceFriendsChangedEvent extends EventData {
863
803
  /**
@@ -884,8 +824,7 @@ interface OnForceFriendsChangedEvent extends EventData {
884
824
 
885
825
  /**
886
826
  * Called when {@link LuaForce#reset LuaForce::reset} is finished.
887
- *
888
- * {@link https://lua-api.factorio.com/latest/events.html#on_force_reset View documentation}
827
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_force_reset Online documentation}
889
828
  */
890
829
  interface OnForceResetEvent extends EventData {
891
830
  readonly force: LuaForce
@@ -901,12 +840,8 @@ interface OnForceResetEvent extends EventData {
901
840
 
902
841
  /**
903
842
  * Called after two forces have been merged using `game.merge_forces()`.
904
- *
905
- * **Note**
906
- *
907
- * The source force is invalidated before this event is called and the name can be re-used in this event if desired.
908
- *
909
- * {@link https://lua-api.factorio.com/latest/events.html#on_forces_merged View documentation}
843
+ * @remarks The source force is invalidated before this event is called and the name can be re-used in this event if desired.
844
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_forces_merged Online documentation}
910
845
  */
911
846
  interface OnForcesMergedEvent extends EventData {
912
847
  /**
@@ -933,8 +868,7 @@ interface OnForcesMergedEvent extends EventData {
933
868
 
934
869
  /**
935
870
  * Called when two forces are about to be merged using `game.merge_forces()`.
936
- *
937
- * {@link https://lua-api.factorio.com/latest/events.html#on_forces_merging View documentation}
871
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_forces_merging Online documentation}
938
872
  */
939
873
  interface OnForcesMergingEvent extends EventData {
940
874
  /**
@@ -957,12 +891,8 @@ interface OnForcesMergingEvent extends EventData {
957
891
 
958
892
  /**
959
893
  * 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.
960
- *
961
- * **Note**
962
- *
963
- * This event is not fired when the scenario is loaded via the map editor.
964
- *
965
- * {@link https://lua-api.factorio.com/latest/events.html#on_game_created_from_scenario View documentation}
894
+ * @remarks This event is not fired when the scenario is loaded via the map editor.
895
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_game_created_from_scenario Online documentation}
966
896
  */
967
897
  interface OnGameCreatedFromScenarioEvent extends EventData {
968
898
  /**
@@ -977,8 +907,7 @@ interface OnGameCreatedFromScenarioEvent extends EventData {
977
907
 
978
908
  /**
979
909
  * Called when {@link LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
980
- *
981
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_checked_state_changed View documentation}
910
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_checked_state_changed Online documentation}
982
911
  */
983
912
  interface OnGuiCheckedStateChangedEvent extends EventData {
984
913
  /**
@@ -1001,8 +930,7 @@ interface OnGuiCheckedStateChangedEvent extends EventData {
1001
930
 
1002
931
  /**
1003
932
  * Called when {@link LuaGuiElement} is clicked.
1004
- *
1005
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_click View documentation}
933
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_click Online documentation}
1006
934
  */
1007
935
  interface OnGuiClickEvent extends EventData {
1008
936
  /**
@@ -1043,12 +971,8 @@ interface OnGuiClickEvent extends EventData {
1043
971
  * Called when the player closes the GUI they have open.
1044
972
  *
1045
973
  * This can only be raised when the GUI's player controller is still valid. If a GUI is thus closed due to the player disconnecting, dying, or becoming a spectator in other ways, it won't cause this event to be raised.
1046
- *
1047
- * **Note**
1048
- *
1049
- * 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.
1050
- *
1051
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_closed View documentation}
974
+ * @remarks 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.
975
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_closed Online documentation}
1052
976
  */
1053
977
  interface OnGuiClosedEvent extends EventData {
1054
978
  /**
@@ -1086,7 +1010,11 @@ interface OnGuiClosedEvent extends EventData {
1086
1010
  /**
1087
1011
  * The tile position that was open
1088
1012
  */
1089
- readonly tile_position?: TilePositionTable
1013
+ readonly tile_position?: TilePosition
1014
+ /**
1015
+ * The script inventory that was open
1016
+ */
1017
+ readonly inventory?: LuaInventory
1090
1018
  /**
1091
1019
  * Identifier of the event
1092
1020
  */
@@ -1099,8 +1027,7 @@ interface OnGuiClosedEvent extends EventData {
1099
1027
 
1100
1028
  /**
1101
1029
  * Called when a {@link LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
1102
- *
1103
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_confirmed View documentation}
1030
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_confirmed Online documentation}
1104
1031
  */
1105
1032
  interface OnGuiConfirmedEvent extends EventData {
1106
1033
  /**
@@ -1135,8 +1062,7 @@ interface OnGuiConfirmedEvent extends EventData {
1135
1062
 
1136
1063
  /**
1137
1064
  * Called when {@link LuaGuiElement} element value is changed (related to choose element buttons).
1138
- *
1139
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_elem_changed View documentation}
1065
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_elem_changed Online documentation}
1140
1066
  */
1141
1067
  interface OnGuiElemChangedEvent extends EventData {
1142
1068
  /**
@@ -1159,8 +1085,7 @@ interface OnGuiElemChangedEvent extends EventData {
1159
1085
 
1160
1086
  /**
1161
1087
  * Called when {@link LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
1162
- *
1163
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_location_changed View documentation}
1088
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_location_changed Online documentation}
1164
1089
  */
1165
1090
  interface OnGuiLocationChangedEvent extends EventData {
1166
1091
  /**
@@ -1183,8 +1108,7 @@ interface OnGuiLocationChangedEvent extends EventData {
1183
1108
 
1184
1109
  /**
1185
1110
  * Called when the player opens a GUI.
1186
- *
1187
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_opened View documentation}
1111
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_opened Online documentation}
1188
1112
  */
1189
1113
  interface OnGuiOpenedEvent extends EventData {
1190
1114
  /**
@@ -1215,6 +1139,10 @@ interface OnGuiOpenedEvent extends EventData {
1215
1139
  * The custom GUI element that was opened
1216
1140
  */
1217
1141
  readonly element?: LuaGuiElement
1142
+ /**
1143
+ * The script inventory that was opened
1144
+ */
1145
+ readonly inventory?: LuaInventory
1218
1146
  /**
1219
1147
  * Identifier of the event
1220
1148
  */
@@ -1227,8 +1155,7 @@ interface OnGuiOpenedEvent extends EventData {
1227
1155
 
1228
1156
  /**
1229
1157
  * Called when {@link LuaGuiElement} selected tab is changed (related to tabbed-panes).
1230
- *
1231
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_selected_tab_changed View documentation}
1158
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_selected_tab_changed Online documentation}
1232
1159
  */
1233
1160
  interface OnGuiSelectedTabChangedEvent extends EventData {
1234
1161
  /**
@@ -1251,8 +1178,7 @@ interface OnGuiSelectedTabChangedEvent extends EventData {
1251
1178
 
1252
1179
  /**
1253
1180
  * Called when {@link LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
1254
- *
1255
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_selection_state_changed View documentation}
1181
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_selection_state_changed Online documentation}
1256
1182
  */
1257
1183
  interface OnGuiSelectionStateChangedEvent extends EventData {
1258
1184
  /**
@@ -1275,8 +1201,7 @@ interface OnGuiSelectionStateChangedEvent extends EventData {
1275
1201
 
1276
1202
  /**
1277
1203
  * Called when {@link LuaGuiElement} switch state is changed (related to switches).
1278
- *
1279
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_switch_state_changed View documentation}
1204
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_switch_state_changed Online documentation}
1280
1205
  */
1281
1206
  interface OnGuiSwitchStateChangedEvent extends EventData {
1282
1207
  /**
@@ -1299,8 +1224,7 @@ interface OnGuiSwitchStateChangedEvent extends EventData {
1299
1224
 
1300
1225
  /**
1301
1226
  * Called when {@link LuaGuiElement} text is changed by the player.
1302
- *
1303
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_text_changed View documentation}
1227
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_text_changed Online documentation}
1304
1228
  */
1305
1229
  interface OnGuiTextChangedEvent extends EventData {
1306
1230
  /**
@@ -1327,8 +1251,7 @@ interface OnGuiTextChangedEvent extends EventData {
1327
1251
 
1328
1252
  /**
1329
1253
  * Called when {@link LuaGuiElement} slider value is changed (related to the slider element).
1330
- *
1331
- * {@link https://lua-api.factorio.com/latest/events.html#on_gui_value_changed View documentation}
1254
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_value_changed Online documentation}
1332
1255
  */
1333
1256
  interface OnGuiValueChangedEvent extends EventData {
1334
1257
  /**
@@ -1351,8 +1274,7 @@ interface OnGuiValueChangedEvent extends EventData {
1351
1274
 
1352
1275
  /**
1353
1276
  * Called when a land mine is armed.
1354
- *
1355
- * {@link https://lua-api.factorio.com/latest/events.html#on_land_mine_armed View documentation}
1277
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_land_mine_armed Online documentation}
1356
1278
  */
1357
1279
  interface OnLandMineArmedEvent extends EventData {
1358
1280
  readonly mine: LuaEntity
@@ -1368,8 +1290,7 @@ interface OnLandMineArmedEvent extends EventData {
1368
1290
 
1369
1291
  /**
1370
1292
  * Called when a custom Lua shortcut is pressed.
1371
- *
1372
- * {@link https://lua-api.factorio.com/latest/events.html#on_lua_shortcut View documentation}
1293
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_lua_shortcut Online documentation}
1373
1294
  */
1374
1295
  interface OnLuaShortcutEvent extends EventData {
1375
1296
  readonly player_index: PlayerIndex
@@ -1389,8 +1310,7 @@ interface OnLuaShortcutEvent extends EventData {
1389
1310
 
1390
1311
  /**
1391
1312
  * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter}.
1392
- *
1393
- * {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_deconstruction View documentation}
1313
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_deconstruction Online documentation}
1394
1314
  */
1395
1315
  interface OnMarkedForDeconstructionEvent extends EventData {
1396
1316
  readonly entity: LuaEntity
@@ -1407,8 +1327,7 @@ interface OnMarkedForDeconstructionEvent extends EventData {
1407
1327
 
1408
1328
  /**
1409
1329
  * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter}.
1410
- *
1411
- * {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_upgrade View documentation}
1330
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_upgrade Online documentation}
1412
1331
  */
1413
1332
  interface OnMarkedForUpgradeEvent extends EventData {
1414
1333
  readonly entity: LuaEntity
@@ -1430,8 +1349,7 @@ interface OnMarkedForUpgradeEvent extends EventData {
1430
1349
 
1431
1350
  /**
1432
1351
  * Called after a player purchases some offer from a `market` entity.
1433
- *
1434
- * {@link https://lua-api.factorio.com/latest/events.html#on_market_item_purchased View documentation}
1352
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_market_item_purchased Online documentation}
1435
1353
  */
1436
1354
  interface OnMarketItemPurchasedEvent extends EventData {
1437
1355
  /**
@@ -1462,8 +1380,7 @@ interface OnMarketItemPurchasedEvent extends EventData {
1462
1380
 
1463
1381
  /**
1464
1382
  * Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
1465
- *
1466
- * {@link https://lua-api.factorio.com/latest/events.html#on_mod_item_opened View documentation}
1383
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_mod_item_opened Online documentation}
1467
1384
  */
1468
1385
  interface OnModItemOpenedEvent extends EventData {
1469
1386
  /**
@@ -1486,8 +1403,7 @@ interface OnModItemOpenedEvent extends EventData {
1486
1403
 
1487
1404
  /**
1488
1405
  * Called directly after a permission group is added.
1489
- *
1490
- * {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_added View documentation}
1406
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_added Online documentation}
1491
1407
  */
1492
1408
  interface OnPermissionGroupAddedEvent extends EventData {
1493
1409
  /**
@@ -1510,8 +1426,7 @@ interface OnPermissionGroupAddedEvent extends EventData {
1510
1426
 
1511
1427
  /**
1512
1428
  * Called directly after a permission group is deleted.
1513
- *
1514
- * {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_deleted View documentation}
1429
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_deleted Online documentation}
1515
1430
  */
1516
1431
  interface OnPermissionGroupDeletedEvent extends EventData {
1517
1432
  /**
@@ -1538,8 +1453,7 @@ interface OnPermissionGroupDeletedEvent extends EventData {
1538
1453
 
1539
1454
  /**
1540
1455
  * Called directly after a permission group is edited in some way.
1541
- *
1542
- * {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_edited View documentation}
1456
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_edited Online documentation}
1543
1457
  */
1544
1458
  interface OnPermissionGroupEditedEvent extends EventData {
1545
1459
  /**
@@ -1589,8 +1503,7 @@ interface OnPermissionGroupEditedEvent extends EventData {
1589
1503
 
1590
1504
  /**
1591
1505
  * Called directly after a permission string is imported.
1592
- *
1593
- * {@link https://lua-api.factorio.com/latest/events.html#on_permission_string_imported View documentation}
1506
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_string_imported Online documentation}
1594
1507
  */
1595
1508
  interface OnPermissionStringImportedEvent extends EventData {
1596
1509
  /**
@@ -1609,8 +1522,7 @@ interface OnPermissionStringImportedEvent extends EventData {
1609
1522
 
1610
1523
  /**
1611
1524
  * Called when a player picks up an item.
1612
- *
1613
- * {@link https://lua-api.factorio.com/latest/events.html#on_picked_up_item View documentation}
1525
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_picked_up_item Online documentation}
1614
1526
  */
1615
1527
  interface OnPickedUpItemEvent extends EventData {
1616
1528
  readonly item_stack: SimpleItemStack
@@ -1627,8 +1539,7 @@ interface OnPickedUpItemEvent extends EventData {
1627
1539
 
1628
1540
  /**
1629
1541
  * Called after a player alt-selects an area with a selection-tool item.
1630
- *
1631
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area View documentation}
1542
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area Online documentation}
1632
1543
  */
1633
1544
  interface OnPlayerAltSelectedAreaEvent extends EventData {
1634
1545
  /**
@@ -1642,7 +1553,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
1642
1553
  /**
1643
1554
  * The area selected.
1644
1555
  */
1645
- readonly area: BoundingBoxRead
1556
+ readonly area: BoundingBox
1646
1557
  /**
1647
1558
  * The item used to select the area.
1648
1559
  */
@@ -1667,8 +1578,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
1667
1578
 
1668
1579
  /**
1669
1580
  * Called after a players ammo inventory changed in some way.
1670
- *
1671
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_ammo_inventory_changed View documentation}
1581
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_ammo_inventory_changed Online documentation}
1672
1582
  */
1673
1583
  interface OnPlayerAmmoInventoryChangedEvent extends EventData {
1674
1584
  readonly player_index: PlayerIndex
@@ -1684,8 +1594,7 @@ interface OnPlayerAmmoInventoryChangedEvent extends EventData {
1684
1594
 
1685
1595
  /**
1686
1596
  * Called after a players armor inventory changed in some way.
1687
- *
1688
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_armor_inventory_changed View documentation}
1597
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_armor_inventory_changed Online documentation}
1689
1598
  */
1690
1599
  interface OnPlayerArmorInventoryChangedEvent extends EventData {
1691
1600
  readonly player_index: PlayerIndex
@@ -1701,8 +1610,7 @@ interface OnPlayerArmorInventoryChangedEvent extends EventData {
1701
1610
 
1702
1611
  /**
1703
1612
  * Called when a player is banned.
1704
- *
1705
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_banned View documentation}
1613
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_banned Online documentation}
1706
1614
  */
1707
1615
  interface OnPlayerBannedEvent extends EventData {
1708
1616
  /**
@@ -1733,8 +1641,7 @@ interface OnPlayerBannedEvent extends EventData {
1733
1641
 
1734
1642
  /**
1735
1643
  * Called after a player builds tiles.
1736
- *
1737
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_built_tile View documentation}
1644
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_built_tile Online documentation}
1738
1645
  */
1739
1646
  interface OnPlayerBuiltTileEvent extends EventData {
1740
1647
  readonly player_index: PlayerIndex
@@ -1770,8 +1677,7 @@ interface OnPlayerBuiltTileEvent extends EventData {
1770
1677
 
1771
1678
  /**
1772
1679
  * Called when a player cancels crafting.
1773
- *
1774
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_cancelled_crafting View documentation}
1680
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cancelled_crafting Online documentation}
1775
1681
  */
1776
1682
  interface OnPlayerCancelledCraftingEvent extends EventData {
1777
1683
  /**
@@ -1802,8 +1708,7 @@ interface OnPlayerCancelledCraftingEvent extends EventData {
1802
1708
 
1803
1709
  /**
1804
1710
  * Called after a player changes forces.
1805
- *
1806
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_force View documentation}
1711
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_force Online documentation}
1807
1712
  */
1808
1713
  interface OnPlayerChangedForceEvent extends EventData {
1809
1714
  /**
@@ -1826,8 +1731,7 @@ interface OnPlayerChangedForceEvent extends EventData {
1826
1731
 
1827
1732
  /**
1828
1733
  * Called when the tile position a player is located at changes.
1829
- *
1830
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_position View documentation}
1734
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_position Online documentation}
1831
1735
  */
1832
1736
  interface OnPlayerChangedPositionEvent extends EventData {
1833
1737
  /**
@@ -1846,12 +1750,8 @@ interface OnPlayerChangedPositionEvent extends EventData {
1846
1750
 
1847
1751
  /**
1848
1752
  * Called after a player changes surfaces.
1849
- *
1850
- * **Note**
1851
- *
1852
- * In the instance a player is moved off a surface due to it being deleted this is not called.
1853
- *
1854
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_surface View documentation}
1753
+ * @remarks In the instance a player is moved off a surface due to it being deleted this is not called.
1754
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_surface Online documentation}
1855
1755
  */
1856
1756
  interface OnPlayerChangedSurfaceEvent extends EventData {
1857
1757
  /**
@@ -1874,8 +1774,7 @@ interface OnPlayerChangedSurfaceEvent extends EventData {
1874
1774
 
1875
1775
  /**
1876
1776
  * Called when cheat mode is disabled on a player.
1877
- *
1878
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_disabled View documentation}
1777
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_disabled Online documentation}
1879
1778
  */
1880
1779
  interface OnPlayerCheatModeDisabledEvent extends EventData {
1881
1780
  /**
@@ -1894,8 +1793,7 @@ interface OnPlayerCheatModeDisabledEvent extends EventData {
1894
1793
 
1895
1794
  /**
1896
1795
  * Called when cheat mode is enabled on a player.
1897
- *
1898
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_enabled View documentation}
1796
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_enabled Online documentation}
1899
1797
  */
1900
1798
  interface OnPlayerCheatModeEnabledEvent extends EventData {
1901
1799
  /**
@@ -1914,8 +1812,7 @@ interface OnPlayerCheatModeEnabledEvent extends EventData {
1914
1812
 
1915
1813
  /**
1916
1814
  * Called when a player clicks a gps tag
1917
- *
1918
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag View documentation}
1815
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag Online documentation}
1919
1816
  */
1920
1817
  interface OnPlayerClickedGpsTagEvent extends EventData {
1921
1818
  /**
@@ -1925,7 +1822,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
1925
1822
  /**
1926
1823
  * Map position contained in gps tag
1927
1824
  */
1928
- readonly position: MapPositionTable
1825
+ readonly position: MapPosition
1929
1826
  /**
1930
1827
  * Surface name contained in gps tag, even when such surface does not exists
1931
1828
  */
@@ -1942,8 +1839,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
1942
1839
 
1943
1840
  /**
1944
1841
  * Called when a player clicks the "confirm" button in the configure Blueprint GUI.
1945
- *
1946
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_blueprint View documentation}
1842
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_blueprint Online documentation}
1947
1843
  */
1948
1844
  interface OnPlayerConfiguredBlueprintEvent extends EventData {
1949
1845
  /**
@@ -1962,8 +1858,7 @@ interface OnPlayerConfiguredBlueprintEvent extends EventData {
1962
1858
 
1963
1859
  /**
1964
1860
  * Called when a player configures spidertron remote to be connected with a given spidertron
1965
- *
1966
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_spider_remote View documentation}
1861
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_spider_remote Online documentation}
1967
1862
  */
1968
1863
  interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
1969
1864
  /**
@@ -1986,8 +1881,7 @@ interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
1986
1881
 
1987
1882
  /**
1988
1883
  * 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 OnPrePlayerCraftedItemEvent on_pre_player_crafted_item}).
1989
- *
1990
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_crafted_item View documentation}
1884
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_crafted_item Online documentation}
1991
1885
  */
1992
1886
  interface OnPlayerCraftedItemEvent extends EventData {
1993
1887
  /**
@@ -2014,8 +1908,7 @@ interface OnPlayerCraftedItemEvent extends EventData {
2014
1908
 
2015
1909
  /**
2016
1910
  * Called after the player was created.
2017
- *
2018
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_created View documentation}
1911
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_created Online documentation}
2019
1912
  */
2020
1913
  interface OnPlayerCreatedEvent extends EventData {
2021
1914
  readonly player_index: PlayerIndex
@@ -2031,8 +1924,7 @@ interface OnPlayerCreatedEvent extends EventData {
2031
1924
 
2032
1925
  /**
2033
1926
  * Called after a players cursorstack changed in some way.
2034
- *
2035
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_cursor_stack_changed View documentation}
1927
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cursor_stack_changed Online documentation}
2036
1928
  */
2037
1929
  interface OnPlayerCursorStackChangedEvent extends EventData {
2038
1930
  readonly player_index: PlayerIndex
@@ -2048,8 +1940,7 @@ interface OnPlayerCursorStackChangedEvent extends EventData {
2048
1940
 
2049
1941
  /**
2050
1942
  * Called when a player selects an area with a deconstruction planner.
2051
- *
2052
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_deconstructed_area View documentation}
1943
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_deconstructed_area Online documentation}
2053
1944
  */
2054
1945
  interface OnPlayerDeconstructedAreaEvent extends EventData {
2055
1946
  /**
@@ -2063,7 +1954,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
2063
1954
  /**
2064
1955
  * The area selected.
2065
1956
  */
2066
- readonly area: BoundingBoxRead
1957
+ readonly area: BoundingBox
2067
1958
  /**
2068
1959
  * The item used to select the area.
2069
1960
  */
@@ -2084,8 +1975,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
2084
1975
 
2085
1976
  /**
2086
1977
  * Called when a player is demoted.
2087
- *
2088
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_demoted View documentation}
1978
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_demoted Online documentation}
2089
1979
  */
2090
1980
  interface OnPlayerDemotedEvent extends EventData {
2091
1981
  /**
@@ -2104,8 +1994,7 @@ interface OnPlayerDemotedEvent extends EventData {
2104
1994
 
2105
1995
  /**
2106
1996
  * Called after a player dies.
2107
- *
2108
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_died View documentation}
1997
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_died Online documentation}
2109
1998
  */
2110
1999
  interface OnPlayerDiedEvent extends EventData {
2111
2000
  readonly player_index: PlayerIndex
@@ -2122,8 +2011,7 @@ interface OnPlayerDiedEvent extends EventData {
2122
2011
 
2123
2012
  /**
2124
2013
  * Called when the display resolution changes for a given player.
2125
- *
2126
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_display_resolution_changed View documentation}
2014
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_display_resolution_changed Online documentation}
2127
2015
  */
2128
2016
  interface OnPlayerDisplayResolutionChangedEvent extends EventData {
2129
2017
  /**
@@ -2146,8 +2034,7 @@ interface OnPlayerDisplayResolutionChangedEvent extends EventData {
2146
2034
 
2147
2035
  /**
2148
2036
  * Called when the display scale changes for a given player.
2149
- *
2150
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_display_scale_changed View documentation}
2037
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_display_scale_changed Online documentation}
2151
2038
  */
2152
2039
  interface OnPlayerDisplayScaleChangedEvent extends EventData {
2153
2040
  /**
@@ -2170,8 +2057,7 @@ interface OnPlayerDisplayScaleChangedEvent extends EventData {
2170
2057
 
2171
2058
  /**
2172
2059
  * Called when the player's driving state has changed, this means a player has either entered or left a vehicle.
2173
- *
2174
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_driving_changed_state View documentation}
2060
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_driving_changed_state Online documentation}
2175
2061
  */
2176
2062
  interface OnPlayerDrivingChangedStateEvent extends EventData {
2177
2063
  readonly player_index: PlayerIndex
@@ -2191,8 +2077,7 @@ interface OnPlayerDrivingChangedStateEvent extends EventData {
2191
2077
 
2192
2078
  /**
2193
2079
  * Called when a player drops an item on the ground.
2194
- *
2195
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_dropped_item View documentation}
2080
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_dropped_item Online documentation}
2196
2081
  */
2197
2082
  interface OnPlayerDroppedItemEvent extends EventData {
2198
2083
  readonly player_index: PlayerIndex
@@ -2212,8 +2097,7 @@ interface OnPlayerDroppedItemEvent extends EventData {
2212
2097
 
2213
2098
  /**
2214
2099
  * Called when a player fast-transfers something to or from an entity.
2215
- *
2216
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_fast_transferred View documentation}
2100
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_fast_transferred Online documentation}
2217
2101
  */
2218
2102
  interface OnPlayerFastTransferredEvent extends EventData {
2219
2103
  /**
@@ -2240,8 +2124,7 @@ interface OnPlayerFastTransferredEvent extends EventData {
2240
2124
 
2241
2125
  /**
2242
2126
  * Called after player flushed fluid
2243
- *
2244
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_flushed_fluid View documentation}
2127
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_flushed_fluid Online documentation}
2245
2128
  */
2246
2129
  interface OnPlayerFlushedFluidEvent extends EventData {
2247
2130
  /**
@@ -2276,8 +2159,7 @@ interface OnPlayerFlushedFluidEvent extends EventData {
2276
2159
 
2277
2160
  /**
2278
2161
  * Called after a players gun inventory changed in some way.
2279
- *
2280
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_gun_inventory_changed View documentation}
2162
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_gun_inventory_changed Online documentation}
2281
2163
  */
2282
2164
  interface OnPlayerGunInventoryChangedEvent extends EventData {
2283
2165
  readonly player_index: PlayerIndex
@@ -2292,9 +2174,8 @@ interface OnPlayerGunInventoryChangedEvent extends EventData {
2292
2174
  }
2293
2175
 
2294
2176
  /**
2295
- * Called after a player joins the game.
2296
- *
2297
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_joined_game View documentation}
2177
+ * 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.
2178
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_joined_game Online documentation}
2298
2179
  */
2299
2180
  interface OnPlayerJoinedGameEvent extends EventData {
2300
2181
  readonly player_index: PlayerIndex
@@ -2310,8 +2191,7 @@ interface OnPlayerJoinedGameEvent extends EventData {
2310
2191
 
2311
2192
  /**
2312
2193
  * Called when a player is kicked.
2313
- *
2314
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_kicked View documentation}
2194
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_kicked Online documentation}
2315
2195
  */
2316
2196
  interface OnPlayerKickedEvent extends EventData {
2317
2197
  /**
@@ -2337,9 +2217,8 @@ interface OnPlayerKickedEvent extends EventData {
2337
2217
  }
2338
2218
 
2339
2219
  /**
2340
- * Called after a player leaves the game.
2341
- *
2342
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_left_game View documentation}
2220
+ * 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.
2221
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_left_game Online documentation}
2343
2222
  */
2344
2223
  interface OnPlayerLeftGameEvent extends EventData {
2345
2224
  readonly player_index: PlayerIndex
@@ -2356,8 +2235,7 @@ interface OnPlayerLeftGameEvent extends EventData {
2356
2235
 
2357
2236
  /**
2358
2237
  * Called after a players main inventory changed in some way.
2359
- *
2360
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_main_inventory_changed View documentation}
2238
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_main_inventory_changed Online documentation}
2361
2239
  */
2362
2240
  interface OnPlayerMainInventoryChangedEvent extends EventData {
2363
2241
  readonly player_index: PlayerIndex
@@ -2373,12 +2251,8 @@ interface OnPlayerMainInventoryChangedEvent extends EventData {
2373
2251
 
2374
2252
  /**
2375
2253
  * 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}.
2376
- *
2377
- * **Note**
2378
- *
2379
- * 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.
2380
- *
2381
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_entity View documentation}
2254
+ * @remarks 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.
2255
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_entity Online documentation}
2382
2256
  */
2383
2257
  interface OnPlayerMinedEntityEvent extends EventData {
2384
2258
  /**
@@ -2405,8 +2279,7 @@ interface OnPlayerMinedEntityEvent extends EventData {
2405
2279
 
2406
2280
  /**
2407
2281
  * Called when the player mines something.
2408
- *
2409
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_item View documentation}
2282
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_item Online documentation}
2410
2283
  */
2411
2284
  interface OnPlayerMinedItemEvent extends EventData {
2412
2285
  /**
@@ -2426,8 +2299,7 @@ interface OnPlayerMinedItemEvent extends EventData {
2426
2299
 
2427
2300
  /**
2428
2301
  * Called after a player mines tiles.
2429
- *
2430
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_tile View documentation}
2302
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_tile Online documentation}
2431
2303
  */
2432
2304
  interface OnPlayerMinedTileEvent extends EventData {
2433
2305
  readonly player_index: PlayerIndex
@@ -2451,8 +2323,7 @@ interface OnPlayerMinedTileEvent extends EventData {
2451
2323
 
2452
2324
  /**
2453
2325
  * Called when a player is muted.
2454
- *
2455
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_muted View documentation}
2326
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_muted Online documentation}
2456
2327
  */
2457
2328
  interface OnPlayerMutedEvent extends EventData {
2458
2329
  /**
@@ -2471,8 +2342,7 @@ interface OnPlayerMutedEvent extends EventData {
2471
2342
 
2472
2343
  /**
2473
2344
  * Called when a player invokes the "smart pipette" over an entity.
2474
- *
2475
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_pipette View documentation}
2345
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_pipette Online documentation}
2476
2346
  */
2477
2347
  interface OnPlayerPipetteEvent extends EventData {
2478
2348
  /**
@@ -2499,8 +2369,7 @@ interface OnPlayerPipetteEvent extends EventData {
2499
2369
 
2500
2370
  /**
2501
2371
  * Called after the player puts equipment in an equipment grid
2502
- *
2503
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_placed_equipment View documentation}
2372
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_placed_equipment Online documentation}
2504
2373
  */
2505
2374
  interface OnPlayerPlacedEquipmentEvent extends EventData {
2506
2375
  readonly player_index: PlayerIndex
@@ -2524,8 +2393,7 @@ interface OnPlayerPlacedEquipmentEvent extends EventData {
2524
2393
 
2525
2394
  /**
2526
2395
  * Called when a player is promoted.
2527
- *
2528
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_promoted View documentation}
2396
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_promoted Online documentation}
2529
2397
  */
2530
2398
  interface OnPlayerPromotedEvent extends EventData {
2531
2399
  /**
@@ -2544,8 +2412,7 @@ interface OnPlayerPromotedEvent extends EventData {
2544
2412
 
2545
2413
  /**
2546
2414
  * Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
2547
- *
2548
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_removed View documentation}
2415
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_removed Online documentation}
2549
2416
  */
2550
2417
  interface OnPlayerRemovedEvent extends EventData {
2551
2418
  /**
@@ -2564,8 +2431,7 @@ interface OnPlayerRemovedEvent extends EventData {
2564
2431
 
2565
2432
  /**
2566
2433
  * Called after the player removes equipment from an equipment grid
2567
- *
2568
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_removed_equipment View documentation}
2434
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_removed_equipment Online documentation}
2569
2435
  */
2570
2436
  interface OnPlayerRemovedEquipmentEvent extends EventData {
2571
2437
  readonly player_index: PlayerIndex
@@ -2593,8 +2459,7 @@ interface OnPlayerRemovedEquipmentEvent extends EventData {
2593
2459
 
2594
2460
  /**
2595
2461
  * Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter}.
2596
- *
2597
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_repaired_entity View documentation}
2462
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_repaired_entity Online documentation}
2598
2463
  */
2599
2464
  interface OnPlayerRepairedEntityEvent extends EventData {
2600
2465
  readonly player_index: PlayerIndex
@@ -2611,8 +2476,7 @@ interface OnPlayerRepairedEntityEvent extends EventData {
2611
2476
 
2612
2477
  /**
2613
2478
  * Called after a player respawns.
2614
- *
2615
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_respawned View documentation}
2479
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_respawned Online documentation}
2616
2480
  */
2617
2481
  interface OnPlayerRespawnedEvent extends EventData {
2618
2482
  readonly player_index: PlayerIndex
@@ -2632,8 +2496,7 @@ interface OnPlayerRespawnedEvent extends EventData {
2632
2496
 
2633
2497
  /**
2634
2498
  * Called after a player reverse-selects an area with a selection-tool item.
2635
- *
2636
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_reverse_selected_area View documentation}
2499
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_reverse_selected_area Online documentation}
2637
2500
  */
2638
2501
  interface OnPlayerReverseSelectedAreaEvent extends EventData {
2639
2502
  /**
@@ -2647,7 +2510,7 @@ interface OnPlayerReverseSelectedAreaEvent extends EventData {
2647
2510
  /**
2648
2511
  * The area selected.
2649
2512
  */
2650
- readonly area: BoundingBoxRead
2513
+ readonly area: BoundingBox
2651
2514
  /**
2652
2515
  * The item used to select the area.
2653
2516
  */
@@ -2672,8 +2535,7 @@ interface OnPlayerReverseSelectedAreaEvent extends EventData {
2672
2535
 
2673
2536
  /**
2674
2537
  * 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.
2675
- *
2676
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_rotated_entity View documentation}
2538
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_rotated_entity Online documentation}
2677
2539
  */
2678
2540
  interface OnPlayerRotatedEntityEvent extends EventData {
2679
2541
  /**
@@ -2697,8 +2559,7 @@ interface OnPlayerRotatedEntityEvent extends EventData {
2697
2559
 
2698
2560
  /**
2699
2561
  * Called after a player selects an area with a selection-tool item.
2700
- *
2701
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_selected_area View documentation}
2562
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_selected_area Online documentation}
2702
2563
  */
2703
2564
  interface OnPlayerSelectedAreaEvent extends EventData {
2704
2565
  /**
@@ -2712,7 +2573,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
2712
2573
  /**
2713
2574
  * The area selected.
2714
2575
  */
2715
- readonly area: BoundingBoxRead
2576
+ readonly area: BoundingBox
2716
2577
  /**
2717
2578
  * The item used to select the area.
2718
2579
  */
@@ -2737,8 +2598,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
2737
2598
 
2738
2599
  /**
2739
2600
  * Called when a player sets a quickbar slot to anything (new value, or set to empty).
2740
- *
2741
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_set_quick_bar_slot View documentation}
2601
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_set_quick_bar_slot Online documentation}
2742
2602
  */
2743
2603
  interface OnPlayerSetQuickBarSlotEvent extends EventData {
2744
2604
  readonly player_index: PlayerIndex
@@ -2754,8 +2614,7 @@ interface OnPlayerSetQuickBarSlotEvent extends EventData {
2754
2614
 
2755
2615
  /**
2756
2616
  * Called when a player selects an area with a blueprint.
2757
- *
2758
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_setup_blueprint View documentation}
2617
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_setup_blueprint Online documentation}
2759
2618
  */
2760
2619
  interface OnPlayerSetupBlueprintEvent extends EventData {
2761
2620
  /**
@@ -2769,7 +2628,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
2769
2628
  /**
2770
2629
  * The area selected.
2771
2630
  */
2772
- readonly area: BoundingBoxRead
2631
+ readonly area: BoundingBox
2773
2632
  /**
2774
2633
  * The item used to select the area.
2775
2634
  */
@@ -2794,8 +2653,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
2794
2653
 
2795
2654
  /**
2796
2655
  * Called when a player toggles alt mode, also known as "show entity info".
2797
- *
2798
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_alt_mode View documentation}
2656
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_alt_mode Online documentation}
2799
2657
  */
2800
2658
  interface OnPlayerToggledAltModeEvent extends EventData {
2801
2659
  readonly player_index: PlayerIndex
@@ -2815,8 +2673,7 @@ interface OnPlayerToggledAltModeEvent extends EventData {
2815
2673
 
2816
2674
  /**
2817
2675
  * Called when a player toggles the map editor on or off.
2818
- *
2819
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_map_editor View documentation}
2676
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_map_editor Online documentation}
2820
2677
  */
2821
2678
  interface OnPlayerToggledMapEditorEvent extends EventData {
2822
2679
  readonly player_index: PlayerIndex
@@ -2832,8 +2689,7 @@ interface OnPlayerToggledMapEditorEvent extends EventData {
2832
2689
 
2833
2690
  /**
2834
2691
  * Called after a players trash inventory changed in some way.
2835
- *
2836
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_trash_inventory_changed View documentation}
2692
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_trash_inventory_changed Online documentation}
2837
2693
  */
2838
2694
  interface OnPlayerTrashInventoryChangedEvent extends EventData {
2839
2695
  readonly player_index: PlayerIndex
@@ -2849,8 +2705,7 @@ interface OnPlayerTrashInventoryChangedEvent extends EventData {
2849
2705
 
2850
2706
  /**
2851
2707
  * Called when a player is un-banned.
2852
- *
2853
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_unbanned View documentation}
2708
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_unbanned Online documentation}
2854
2709
  */
2855
2710
  interface OnPlayerUnbannedEvent extends EventData {
2856
2711
  /**
@@ -2881,8 +2736,7 @@ interface OnPlayerUnbannedEvent extends EventData {
2881
2736
 
2882
2737
  /**
2883
2738
  * Called when a player is unmuted.
2884
- *
2885
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_unmuted View documentation}
2739
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_unmuted Online documentation}
2886
2740
  */
2887
2741
  interface OnPlayerUnmutedEvent extends EventData {
2888
2742
  /**
@@ -2901,8 +2755,7 @@ interface OnPlayerUnmutedEvent extends EventData {
2901
2755
 
2902
2756
  /**
2903
2757
  * Called when a player uses a capsule that results in some game action.
2904
- *
2905
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_used_capsule View documentation}
2758
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_used_capsule Online documentation}
2906
2759
  */
2907
2760
  interface OnPlayerUsedCapsuleEvent extends EventData {
2908
2761
  /**
@@ -2916,7 +2769,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
2916
2769
  /**
2917
2770
  * The position the capsule was used.
2918
2771
  */
2919
- readonly position: MapPositionTable
2772
+ readonly position: MapPosition
2920
2773
  /**
2921
2774
  * Identifier of the event
2922
2775
  */
@@ -2929,8 +2782,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
2929
2782
 
2930
2783
  /**
2931
2784
  * Called when a player uses spidertron remote to send a spidertron to a given position
2932
- *
2933
- * {@link https://lua-api.factorio.com/latest/events.html#on_player_used_spider_remote View documentation}
2785
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_used_spider_remote Online documentation}
2934
2786
  */
2935
2787
  interface OnPlayerUsedSpiderRemoteEvent extends EventData {
2936
2788
  /**
@@ -2944,7 +2796,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
2944
2796
  /**
2945
2797
  * Goal position to which spidertron was sent to.
2946
2798
  */
2947
- readonly position: MapPositionTable
2799
+ readonly position: MapPosition
2948
2800
  /**
2949
2801
  * If the use was successful. It may fail when spidertron has different driver or when player is on different surface.
2950
2802
  */
@@ -2961,8 +2813,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
2961
2813
 
2962
2814
  /**
2963
2815
  * Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter}.
2964
- *
2965
- * {@link https://lua-api.factorio.com/latest/events.html#on_post_entity_died View documentation}
2816
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_post_entity_died Online documentation}
2966
2817
  */
2967
2818
  interface OnPostEntityDiedEvent extends EventData {
2968
2819
  /**
@@ -2976,7 +2827,7 @@ interface OnPostEntityDiedEvent extends EventData {
2976
2827
  /**
2977
2828
  * Position where the entity died.
2978
2829
  */
2979
- readonly position: MapPositionTable
2830
+ readonly position: MapPosition
2980
2831
  /**
2981
2832
  * The entity prototype of the entity that died.
2982
2833
  */
@@ -3009,8 +2860,7 @@ interface OnPostEntityDiedEvent extends EventData {
3009
2860
 
3010
2861
  /**
3011
2862
  * Called when players uses an item to build something. Called before {@link OnBuiltEntityEvent on_built_entity}.
3012
- *
3013
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_build View documentation}
2863
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_build Online documentation}
3014
2864
  */
3015
2865
  interface OnPreBuildEvent extends EventData {
3016
2866
  /**
@@ -3020,7 +2870,7 @@ interface OnPreBuildEvent extends EventData {
3020
2870
  /**
3021
2871
  * Where the item was placed.
3022
2872
  */
3023
- readonly position: MapPositionTable
2873
+ readonly position: MapPosition
3024
2874
  /**
3025
2875
  * Item was placed using shift building.
3026
2876
  */
@@ -3053,15 +2903,14 @@ interface OnPreBuildEvent extends EventData {
3053
2903
 
3054
2904
  /**
3055
2905
  * Called before one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
3056
- *
3057
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_chunk_deleted View documentation}
2906
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_chunk_deleted Online documentation}
3058
2907
  */
3059
2908
  interface OnPreChunkDeletedEvent extends EventData {
3060
2909
  readonly surface_index: SurfaceIndex
3061
2910
  /**
3062
2911
  * The chunks to be deleted.
3063
2912
  */
3064
- readonly positions: ChunkPositionTable[]
2913
+ readonly positions: ChunkPosition[]
3065
2914
  /**
3066
2915
  * Identifier of the event
3067
2916
  */
@@ -3074,8 +2923,7 @@ interface OnPreChunkDeletedEvent extends EventData {
3074
2923
 
3075
2924
  /**
3076
2925
  * Called before entity copy-paste is done.
3077
- *
3078
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_entity_settings_pasted View documentation}
2926
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_entity_settings_pasted Online documentation}
3079
2927
  */
3080
2928
  interface OnPreEntitySettingsPastedEvent extends EventData {
3081
2929
  readonly player_index: PlayerIndex
@@ -3099,8 +2947,7 @@ interface OnPreEntitySettingsPastedEvent extends EventData {
3099
2947
 
3100
2948
  /**
3101
2949
  * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter}.
3102
- *
3103
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_deconstructed View documentation}
2950
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_deconstructed Online documentation}
3104
2951
  */
3105
2952
  interface OnPreGhostDeconstructedEvent extends EventData {
3106
2953
  /**
@@ -3118,10 +2965,30 @@ interface OnPreGhostDeconstructedEvent extends EventData {
3118
2965
  readonly tick: uint
3119
2966
  }
3120
2967
 
2968
+ /**
2969
+ * Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter}.
2970
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_upgraded Online documentation}
2971
+ */
2972
+ interface OnPreGhostUpgradedEvent extends EventData {
2973
+ /**
2974
+ * The player that did the upgrade if any.
2975
+ */
2976
+ readonly player_index?: PlayerIndex
2977
+ readonly ghost: LuaEntity
2978
+ readonly target: LuaEntityPrototype
2979
+ /**
2980
+ * Identifier of the event
2981
+ */
2982
+ readonly name: typeof defines.events.on_pre_ghost_upgraded
2983
+ /**
2984
+ * Tick the event was generated.
2985
+ */
2986
+ readonly tick: uint
2987
+ }
2988
+
3121
2989
  /**
3122
2990
  * Called directly before a permission group is deleted.
3123
- *
3124
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_group_deleted View documentation}
2991
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_group_deleted Online documentation}
3125
2992
  */
3126
2993
  interface OnPrePermissionGroupDeletedEvent extends EventData {
3127
2994
  /**
@@ -3144,8 +3011,7 @@ interface OnPrePermissionGroupDeletedEvent extends EventData {
3144
3011
 
3145
3012
  /**
3146
3013
  * Called directly before a permission string is imported.
3147
- *
3148
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_string_imported View documentation}
3014
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_string_imported Online documentation}
3149
3015
  */
3150
3016
  interface OnPrePermissionStringImportedEvent extends EventData {
3151
3017
  /**
@@ -3164,8 +3030,7 @@ interface OnPrePermissionStringImportedEvent extends EventData {
3164
3030
 
3165
3031
  /**
3166
3032
  * Called when a player queues something to be crafted.
3167
- *
3168
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_crafted_item View documentation}
3033
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_crafted_item Online documentation}
3169
3034
  */
3170
3035
  interface OnPrePlayerCraftedItemEvent extends EventData {
3171
3036
  /**
@@ -3196,8 +3061,7 @@ interface OnPrePlayerCraftedItemEvent extends EventData {
3196
3061
 
3197
3062
  /**
3198
3063
  * Called before a players dies.
3199
- *
3200
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_died View documentation}
3064
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_died Online documentation}
3201
3065
  */
3202
3066
  interface OnPrePlayerDiedEvent extends EventData {
3203
3067
  readonly player_index: PlayerIndex
@@ -3214,8 +3078,7 @@ interface OnPrePlayerDiedEvent extends EventData {
3214
3078
 
3215
3079
  /**
3216
3080
  * Called before a player leaves the game.
3217
- *
3218
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_left_game View documentation}
3081
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_left_game Online documentation}
3219
3082
  */
3220
3083
  interface OnPrePlayerLeftGameEvent extends EventData {
3221
3084
  readonly player_index: PlayerIndex
@@ -3232,8 +3095,7 @@ interface OnPrePlayerLeftGameEvent extends EventData {
3232
3095
 
3233
3096
  /**
3234
3097
  * Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter}.
3235
- *
3236
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item View documentation}
3098
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item Online documentation}
3237
3099
  */
3238
3100
  interface OnPrePlayerMinedItemEvent extends EventData {
3239
3101
  /**
@@ -3253,8 +3115,7 @@ interface OnPrePlayerMinedItemEvent extends EventData {
3253
3115
 
3254
3116
  /**
3255
3117
  * Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
3256
- *
3257
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_removed View documentation}
3118
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_removed Online documentation}
3258
3119
  */
3259
3120
  interface OnPrePlayerRemovedEvent extends EventData {
3260
3121
  /**
@@ -3273,8 +3134,7 @@ interface OnPrePlayerRemovedEvent extends EventData {
3273
3134
 
3274
3135
  /**
3275
3136
  * Called before a player toggles the map editor on or off.
3276
- *
3277
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_toggled_map_editor View documentation}
3137
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_toggled_map_editor Online documentation}
3278
3138
  */
3279
3139
  interface OnPrePlayerToggledMapEditorEvent extends EventData {
3280
3140
  readonly player_index: PlayerIndex
@@ -3290,8 +3150,7 @@ interface OnPrePlayerToggledMapEditorEvent extends EventData {
3290
3150
 
3291
3151
  /**
3292
3152
  * Called directly before a robot explodes cliffs.
3293
- *
3294
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_robot_exploded_cliff View documentation}
3153
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_robot_exploded_cliff Online documentation}
3295
3154
  */
3296
3155
  interface OnPreRobotExplodedCliffEvent extends EventData {
3297
3156
  readonly robot: LuaEntity
@@ -3312,8 +3171,7 @@ interface OnPreRobotExplodedCliffEvent extends EventData {
3312
3171
 
3313
3172
  /**
3314
3173
  * Called just before a script inventory is resized.
3315
- *
3316
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_script_inventory_resized View documentation}
3174
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_script_inventory_resized Online documentation}
3317
3175
  */
3318
3176
  interface OnPreScriptInventoryResizedEvent extends EventData {
3319
3177
  /**
@@ -3345,8 +3203,7 @@ interface OnPreScriptInventoryResizedEvent extends EventData {
3345
3203
 
3346
3204
  /**
3347
3205
  * Called just before a surface is cleared (all entities removed and all chunks deleted).
3348
- *
3349
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_cleared View documentation}
3206
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_cleared Online documentation}
3350
3207
  */
3351
3208
  interface OnPreSurfaceClearedEvent extends EventData {
3352
3209
  readonly surface_index: SurfaceIndex
@@ -3362,8 +3219,7 @@ interface OnPreSurfaceClearedEvent extends EventData {
3362
3219
 
3363
3220
  /**
3364
3221
  * Called just before a surface is deleted.
3365
- *
3366
- * {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_deleted View documentation}
3222
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_deleted Online documentation}
3367
3223
  */
3368
3224
  interface OnPreSurfaceDeletedEvent extends EventData {
3369
3225
  readonly surface_index: SurfaceIndex
@@ -3379,8 +3235,7 @@ interface OnPreSurfaceDeletedEvent extends EventData {
3379
3235
 
3380
3236
  /**
3381
3237
  * Called when research is cancelled.
3382
- *
3383
- * {@link https://lua-api.factorio.com/latest/events.html#on_research_cancelled View documentation}
3238
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_research_cancelled Online documentation}
3384
3239
  */
3385
3240
  interface OnResearchCancelledEvent extends EventData {
3386
3241
  /**
@@ -3403,8 +3258,7 @@ interface OnResearchCancelledEvent extends EventData {
3403
3258
 
3404
3259
  /**
3405
3260
  * Called when a research finishes.
3406
- *
3407
- * {@link https://lua-api.factorio.com/latest/events.html#on_research_finished View documentation}
3261
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_research_finished Online documentation}
3408
3262
  */
3409
3263
  interface OnResearchFinishedEvent extends EventData {
3410
3264
  /**
@@ -3427,8 +3281,7 @@ interface OnResearchFinishedEvent extends EventData {
3427
3281
 
3428
3282
  /**
3429
3283
  * Called when a research is reversed (unresearched).
3430
- *
3431
- * {@link https://lua-api.factorio.com/latest/events.html#on_research_reversed View documentation}
3284
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_research_reversed Online documentation}
3432
3285
  */
3433
3286
  interface OnResearchReversedEvent extends EventData {
3434
3287
  /**
@@ -3451,8 +3304,7 @@ interface OnResearchReversedEvent extends EventData {
3451
3304
 
3452
3305
  /**
3453
3306
  * Called when a technology research starts.
3454
- *
3455
- * {@link https://lua-api.factorio.com/latest/events.html#on_research_started View documentation}
3307
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_research_started Online documentation}
3456
3308
  */
3457
3309
  interface OnResearchStartedEvent extends EventData {
3458
3310
  /**
@@ -3472,8 +3324,7 @@ interface OnResearchStartedEvent extends EventData {
3472
3324
 
3473
3325
  /**
3474
3326
  * Called when a resource entity reaches 0 or its minimum yield for infinite resources.
3475
- *
3476
- * {@link https://lua-api.factorio.com/latest/events.html#on_resource_depleted View documentation}
3327
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_resource_depleted Online documentation}
3477
3328
  */
3478
3329
  interface OnResourceDepletedEvent extends EventData {
3479
3330
  readonly entity: LuaEntity
@@ -3489,8 +3340,7 @@ interface OnResourceDepletedEvent extends EventData {
3489
3340
 
3490
3341
  /**
3491
3342
  * Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter}.
3492
- *
3493
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_entity View documentation}
3343
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_entity Online documentation}
3494
3344
  */
3495
3345
  interface OnRobotBuiltEntityEvent extends EventData {
3496
3346
  /**
@@ -3521,8 +3371,7 @@ interface OnRobotBuiltEntityEvent extends EventData {
3521
3371
 
3522
3372
  /**
3523
3373
  * Called after a robot builds tiles.
3524
- *
3525
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_tile View documentation}
3374
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_tile Online documentation}
3526
3375
  */
3527
3376
  interface OnRobotBuiltTileEvent extends EventData {
3528
3377
  /**
@@ -3561,8 +3410,7 @@ interface OnRobotBuiltTileEvent extends EventData {
3561
3410
 
3562
3411
  /**
3563
3412
  * Called directly after a robot explodes cliffs.
3564
- *
3565
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_exploded_cliff View documentation}
3413
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_exploded_cliff Online documentation}
3566
3414
  */
3567
3415
  interface OnRobotExplodedCliffEvent extends EventData {
3568
3416
  readonly robot: LuaEntity
@@ -3582,8 +3430,7 @@ interface OnRobotExplodedCliffEvent extends EventData {
3582
3430
 
3583
3431
  /**
3584
3432
  * Called when a robot mines an entity.
3585
- *
3586
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined View documentation}
3433
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined Online documentation}
3587
3434
  */
3588
3435
  interface OnRobotMinedEvent extends EventData {
3589
3436
  /**
@@ -3606,12 +3453,8 @@ interface OnRobotMinedEvent extends EventData {
3606
3453
 
3607
3454
  /**
3608
3455
  * 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}.
3609
- *
3610
- * **Note**
3611
- *
3612
- * 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.
3613
- *
3614
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_entity View documentation}
3456
+ * @remarks 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.
3457
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_entity Online documentation}
3615
3458
  */
3616
3459
  interface OnRobotMinedEntityEvent extends EventData {
3617
3460
  /**
@@ -3638,8 +3481,7 @@ interface OnRobotMinedEntityEvent extends EventData {
3638
3481
 
3639
3482
  /**
3640
3483
  * Called after a robot mines tiles.
3641
- *
3642
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_tile View documentation}
3484
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_tile Online documentation}
3643
3485
  */
3644
3486
  interface OnRobotMinedTileEvent extends EventData {
3645
3487
  /**
@@ -3666,8 +3508,7 @@ interface OnRobotMinedTileEvent extends EventData {
3666
3508
 
3667
3509
  /**
3668
3510
  * Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter}.
3669
- *
3670
- * {@link https://lua-api.factorio.com/latest/events.html#on_robot_pre_mined View documentation}
3511
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_pre_mined Online documentation}
3671
3512
  */
3672
3513
  interface OnRobotPreMinedEvent extends EventData {
3673
3514
  /**
@@ -3690,8 +3531,7 @@ interface OnRobotPreMinedEvent extends EventData {
3690
3531
 
3691
3532
  /**
3692
3533
  * Called when a rocket silo is ordered to be launched.
3693
- *
3694
- * {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launch_ordered View documentation}
3534
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launch_ordered Online documentation}
3695
3535
  */
3696
3536
  interface OnRocketLaunchOrderedEvent extends EventData {
3697
3537
  readonly rocket: LuaEntity
@@ -3712,8 +3552,7 @@ interface OnRocketLaunchOrderedEvent extends EventData {
3712
3552
 
3713
3553
  /**
3714
3554
  * Called when the rocket is launched.
3715
- *
3716
- * {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launched View documentation}
3555
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launched Online documentation}
3717
3556
  */
3718
3557
  interface OnRocketLaunchedEvent extends EventData {
3719
3558
  readonly rocket: LuaEntity
@@ -3734,8 +3573,7 @@ interface OnRocketLaunchedEvent extends EventData {
3734
3573
 
3735
3574
  /**
3736
3575
  * Called when a runtime mod setting is changed by a player.
3737
- *
3738
- * {@link https://lua-api.factorio.com/latest/events.html#on_runtime_mod_setting_changed View documentation}
3576
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_runtime_mod_setting_changed Online documentation}
3739
3577
  */
3740
3578
  interface OnRuntimeModSettingChangedEvent extends EventData {
3741
3579
  /**
@@ -3762,8 +3600,7 @@ interface OnRuntimeModSettingChangedEvent extends EventData {
3762
3600
 
3763
3601
  /**
3764
3602
  * Called just after a script inventory is resized.
3765
- *
3766
- * {@link https://lua-api.factorio.com/latest/events.html#on_script_inventory_resized View documentation}
3603
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_script_inventory_resized Online documentation}
3767
3604
  */
3768
3605
  interface OnScriptInventoryResizedEvent extends EventData {
3769
3606
  /**
@@ -3799,8 +3636,7 @@ interface OnScriptInventoryResizedEvent extends EventData {
3799
3636
 
3800
3637
  /**
3801
3638
  * Called when a {@link LuaSurface#request_path LuaSurface::request_path} call completes.
3802
- *
3803
- * {@link https://lua-api.factorio.com/latest/events.html#on_script_path_request_finished View documentation}
3639
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_script_path_request_finished Online documentation}
3804
3640
  */
3805
3641
  interface OnScriptPathRequestFinishedEvent extends EventData {
3806
3642
  /**
@@ -3827,8 +3663,7 @@ interface OnScriptPathRequestFinishedEvent extends EventData {
3827
3663
 
3828
3664
  /**
3829
3665
  * Called when a script trigger effect is triggered.
3830
- *
3831
- * {@link https://lua-api.factorio.com/latest/events.html#on_script_trigger_effect View documentation}
3666
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_script_trigger_effect Online documentation}
3832
3667
  */
3833
3668
  interface OnScriptTriggerEffectEvent extends EventData {
3834
3669
  /**
@@ -3839,9 +3674,9 @@ interface OnScriptTriggerEffectEvent extends EventData {
3839
3674
  * The surface the effect happened on.
3840
3675
  */
3841
3676
  readonly surface_index: SurfaceIndex
3842
- readonly source_position?: MapPositionTable
3677
+ readonly source_position?: MapPosition
3843
3678
  readonly source_entity?: LuaEntity
3844
- readonly target_position?: MapPositionTable
3679
+ readonly target_position?: MapPosition
3845
3680
  readonly target_entity?: LuaEntity
3846
3681
  /**
3847
3682
  * Identifier of the event
@@ -3855,8 +3690,7 @@ interface OnScriptTriggerEffectEvent extends EventData {
3855
3690
 
3856
3691
  /**
3857
3692
  * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter}.
3858
- *
3859
- * {@link https://lua-api.factorio.com/latest/events.html#on_sector_scanned View documentation}
3693
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_sector_scanned Online documentation}
3860
3694
  */
3861
3695
  interface OnSectorScannedEvent extends EventData {
3862
3696
  /**
@@ -3866,11 +3700,11 @@ interface OnSectorScannedEvent extends EventData {
3866
3700
  /**
3867
3701
  * The chunk scanned.
3868
3702
  */
3869
- readonly chunk_position: ChunkPositionTable
3703
+ readonly chunk_position: ChunkPosition
3870
3704
  /**
3871
3705
  * Area of the scanned chunk.
3872
3706
  */
3873
- readonly area: BoundingBoxRead
3707
+ readonly area: BoundingBox
3874
3708
  /**
3875
3709
  * Identifier of the event
3876
3710
  */
@@ -3883,8 +3717,7 @@ interface OnSectorScannedEvent extends EventData {
3883
3717
 
3884
3718
  /**
3885
3719
  * Called after the selected entity changes for a given player.
3886
- *
3887
- * {@link https://lua-api.factorio.com/latest/events.html#on_selected_entity_changed View documentation}
3720
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_selected_entity_changed Online documentation}
3888
3721
  */
3889
3722
  interface OnSelectedEntityChangedEvent extends EventData {
3890
3723
  /**
@@ -3907,8 +3740,7 @@ interface OnSelectedEntityChangedEvent extends EventData {
3907
3740
 
3908
3741
  /**
3909
3742
  * Called when a spider finishes moving to its autopilot position.
3910
- *
3911
- * {@link https://lua-api.factorio.com/latest/events.html#on_spider_command_completed View documentation}
3743
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_spider_command_completed Online documentation}
3912
3744
  */
3913
3745
  interface OnSpiderCommandCompletedEvent extends EventData {
3914
3746
  /**
@@ -3927,8 +3759,7 @@ interface OnSpiderCommandCompletedEvent extends EventData {
3927
3759
 
3928
3760
  /**
3929
3761
  * Called when a translation request generated through {@link LuaPlayer#request_translation LuaPlayer::request_translation} is translated.
3930
- *
3931
- * {@link https://lua-api.factorio.com/latest/events.html#on_string_translated View documentation}
3762
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_string_translated Online documentation}
3932
3763
  */
3933
3764
  interface OnStringTranslatedEvent extends EventData {
3934
3765
  /**
@@ -3959,8 +3790,7 @@ interface OnStringTranslatedEvent extends EventData {
3959
3790
 
3960
3791
  /**
3961
3792
  * Called just after a surface is cleared (all entities removed and all chunks deleted).
3962
- *
3963
- * {@link https://lua-api.factorio.com/latest/events.html#on_surface_cleared View documentation}
3793
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_cleared Online documentation}
3964
3794
  */
3965
3795
  interface OnSurfaceClearedEvent extends EventData {
3966
3796
  readonly surface_index: SurfaceIndex
@@ -3976,12 +3806,8 @@ interface OnSurfaceClearedEvent extends EventData {
3976
3806
 
3977
3807
  /**
3978
3808
  * Called when a surface is created.
3979
- *
3980
- * **Note**
3981
- *
3982
- * This is not called when the default surface is created as it will always exist.
3983
- *
3984
- * {@link https://lua-api.factorio.com/latest/events.html#on_surface_created View documentation}
3809
+ * @remarks This is not called when the default surface is created as it will always exist.
3810
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_created Online documentation}
3985
3811
  */
3986
3812
  interface OnSurfaceCreatedEvent extends EventData {
3987
3813
  readonly surface_index: SurfaceIndex
@@ -3997,8 +3823,7 @@ interface OnSurfaceCreatedEvent extends EventData {
3997
3823
 
3998
3824
  /**
3999
3825
  * Called after a surface is deleted.
4000
- *
4001
- * {@link https://lua-api.factorio.com/latest/events.html#on_surface_deleted View documentation}
3826
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_deleted Online documentation}
4002
3827
  */
4003
3828
  interface OnSurfaceDeletedEvent extends EventData {
4004
3829
  readonly surface_index: SurfaceIndex
@@ -4014,8 +3839,7 @@ interface OnSurfaceDeletedEvent extends EventData {
4014
3839
 
4015
3840
  /**
4016
3841
  * Called after a surface is imported.
4017
- *
4018
- * {@link https://lua-api.factorio.com/latest/events.html#on_surface_imported View documentation}
3842
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_imported Online documentation}
4019
3843
  */
4020
3844
  interface OnSurfaceImportedEvent extends EventData {
4021
3845
  readonly surface_index: SurfaceIndex
@@ -4035,8 +3859,7 @@ interface OnSurfaceImportedEvent extends EventData {
4035
3859
 
4036
3860
  /**
4037
3861
  * Called when a surface is renamed.
4038
- *
4039
- * {@link https://lua-api.factorio.com/latest/events.html#on_surface_renamed View documentation}
3862
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_renamed Online documentation}
4040
3863
  */
4041
3864
  interface OnSurfaceRenamedEvent extends EventData {
4042
3865
  readonly surface_index: SurfaceIndex
@@ -4054,8 +3877,7 @@ interface OnSurfaceRenamedEvent extends EventData {
4054
3877
 
4055
3878
  /**
4056
3879
  * Called when {@link LuaForce#reset_technology_effects LuaForce::reset_technology_effects} is finished.
4057
- *
4058
- * {@link https://lua-api.factorio.com/latest/events.html#on_technology_effects_reset View documentation}
3880
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_technology_effects_reset Online documentation}
4059
3881
  */
4060
3882
  interface OnTechnologyEffectsResetEvent extends EventData {
4061
3883
  readonly force: LuaForce
@@ -4071,8 +3893,7 @@ interface OnTechnologyEffectsResetEvent extends EventData {
4071
3893
 
4072
3894
  /**
4073
3895
  * It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
4074
- *
4075
- * {@link https://lua-api.factorio.com/latest/events.html#on_tick View documentation}
3896
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_tick Online documentation}
4076
3897
  */
4077
3898
  interface OnTickEvent extends EventData {
4078
3899
  /**
@@ -4087,8 +3908,7 @@ interface OnTickEvent extends EventData {
4087
3908
 
4088
3909
  /**
4089
3910
  * Called when a train changes state (started to stopped and vice versa)
4090
- *
4091
- * {@link https://lua-api.factorio.com/latest/events.html#on_train_changed_state View documentation}
3911
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_train_changed_state Online documentation}
4092
3912
  */
4093
3913
  interface OnTrainChangedStateEvent extends EventData {
4094
3914
  readonly train: LuaTrain
@@ -4105,8 +3925,7 @@ interface OnTrainChangedStateEvent extends EventData {
4105
3925
 
4106
3926
  /**
4107
3927
  * Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
4108
- *
4109
- * {@link https://lua-api.factorio.com/latest/events.html#on_train_created View documentation}
3928
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_train_created Online documentation}
4110
3929
  */
4111
3930
  interface OnTrainCreatedEvent extends EventData {
4112
3931
  readonly train: LuaTrain
@@ -4130,8 +3949,7 @@ interface OnTrainCreatedEvent extends EventData {
4130
3949
 
4131
3950
  /**
4132
3951
  * Called when a trains schedule is changed either by the player or through script.
4133
- *
4134
- * {@link https://lua-api.factorio.com/latest/events.html#on_train_schedule_changed View documentation}
3952
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_train_schedule_changed Online documentation}
4135
3953
  */
4136
3954
  interface OnTrainScheduleChangedEvent extends EventData {
4137
3955
  readonly train: LuaTrain
@@ -4151,8 +3969,7 @@ interface OnTrainScheduleChangedEvent extends EventData {
4151
3969
 
4152
3970
  /**
4153
3971
  * Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity="true"`.
4154
- *
4155
- * {@link https://lua-api.factorio.com/latest/events.html#on_trigger_created_entity View documentation}
3972
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_trigger_created_entity Online documentation}
4156
3973
  */
4157
3974
  interface OnTriggerCreatedEntityEvent extends EventData {
4158
3975
  readonly entity: LuaEntity
@@ -4169,8 +3986,7 @@ interface OnTriggerCreatedEntityEvent extends EventData {
4169
3986
 
4170
3987
  /**
4171
3988
  * Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery="true"`.
4172
- *
4173
- * {@link https://lua-api.factorio.com/latest/events.html#on_trigger_fired_artillery View documentation}
3989
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_trigger_fired_artillery Online documentation}
4174
3990
  */
4175
3991
  interface OnTriggerFiredArtilleryEvent extends EventData {
4176
3992
  readonly entity: LuaEntity
@@ -4187,8 +4003,7 @@ interface OnTriggerFiredArtilleryEvent extends EventData {
4187
4003
 
4188
4004
  /**
4189
4005
  * Called when a unit is added to a unit group.
4190
- *
4191
- * {@link https://lua-api.factorio.com/latest/events.html#on_unit_added_to_group View documentation}
4006
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_added_to_group Online documentation}
4192
4007
  */
4193
4008
  interface OnUnitAddedToGroupEvent extends EventData {
4194
4009
  readonly unit: LuaEntity
@@ -4205,8 +4020,7 @@ interface OnUnitAddedToGroupEvent extends EventData {
4205
4020
 
4206
4021
  /**
4207
4022
  * Called when a new unit group is created, before any members are added to it.
4208
- *
4209
- * {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_created View documentation}
4023
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_created Online documentation}
4210
4024
  */
4211
4025
  interface OnUnitGroupCreatedEvent extends EventData {
4212
4026
  readonly group: LuaUnitGroup
@@ -4222,8 +4036,7 @@ interface OnUnitGroupCreatedEvent extends EventData {
4222
4036
 
4223
4037
  /**
4224
4038
  * Called when a unit group finishes gathering and starts executing its command.
4225
- *
4226
- * {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_finished_gathering View documentation}
4039
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_finished_gathering Online documentation}
4227
4040
  */
4228
4041
  interface OnUnitGroupFinishedGatheringEvent extends EventData {
4229
4042
  readonly group: LuaUnitGroup
@@ -4239,8 +4052,7 @@ interface OnUnitGroupFinishedGatheringEvent extends EventData {
4239
4052
 
4240
4053
  /**
4241
4054
  * Called when a unit is removed from a unit group.
4242
- *
4243
- * {@link https://lua-api.factorio.com/latest/events.html#on_unit_removed_from_group View documentation}
4055
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_removed_from_group Online documentation}
4244
4056
  */
4245
4057
  interface OnUnitRemovedFromGroupEvent extends EventData {
4246
4058
  readonly unit: LuaEntity
@@ -4257,8 +4069,7 @@ interface OnUnitRemovedFromGroupEvent extends EventData {
4257
4069
 
4258
4070
  /**
4259
4071
  * Called when a worker (construction or logistic) robot expires through a lack of energy.
4260
- *
4261
- * {@link https://lua-api.factorio.com/latest/events.html#on_worker_robot_expired View documentation}
4072
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_worker_robot_expired Online documentation}
4262
4073
  */
4263
4074
  interface OnWorkerRobotExpiredEvent extends EventData {
4264
4075
  readonly robot: LuaEntity
@@ -4274,8 +4085,7 @@ interface OnWorkerRobotExpiredEvent extends EventData {
4274
4085
 
4275
4086
  /**
4276
4087
  * 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}.
4277
- *
4278
- * {@link https://lua-api.factorio.com/latest/events.html#script_raised_built View documentation}
4088
+ * @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_built Online documentation}
4279
4089
  */
4280
4090
  interface ScriptRaisedBuiltEvent extends EventData {
4281
4091
  /**
@@ -4294,8 +4104,7 @@ interface ScriptRaisedBuiltEvent extends EventData {
4294
4104
 
4295
4105
  /**
4296
4106
  * 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}.
4297
- *
4298
- * {@link https://lua-api.factorio.com/latest/events.html#script_raised_destroy View documentation}
4107
+ * @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_destroy Online documentation}
4299
4108
  */
4300
4109
  interface ScriptRaisedDestroyEvent extends EventData {
4301
4110
  /**
@@ -4314,8 +4123,7 @@ interface ScriptRaisedDestroyEvent extends EventData {
4314
4123
 
4315
4124
  /**
4316
4125
  * 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}.
4317
- *
4318
- * {@link https://lua-api.factorio.com/latest/events.html#script_raised_revive View documentation}
4126
+ * @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_revive Online documentation}
4319
4127
  */
4320
4128
  interface ScriptRaisedReviveEvent extends EventData {
4321
4129
  /**
@@ -4338,8 +4146,7 @@ interface ScriptRaisedReviveEvent extends EventData {
4338
4146
 
4339
4147
  /**
4340
4148
  * 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}.
4341
- *
4342
- * {@link https://lua-api.factorio.com/latest/events.html#script_raised_set_tiles View documentation}
4149
+ * @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_set_tiles Online documentation}
4343
4150
  */
4344
4151
  interface ScriptRaisedSetTilesEvent extends EventData {
4345
4152
  /**
@@ -4349,7 +4156,7 @@ interface ScriptRaisedSetTilesEvent extends EventData {
4349
4156
  /**
4350
4157
  * The tiles that were changed.
4351
4158
  */
4352
- readonly tiles: TileRead[]
4159
+ readonly tiles: Tile[]
4353
4160
  /**
4354
4161
  * Identifier of the event
4355
4162
  */