typed-factorio 3.2.0 → 3.3.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -13,7 +13,7 @@ declare module "factorio:runtime" {
13
13
  * script.on_event("my-potato-control", function(event)
14
14
  * game.print("Keyboard shortcut pressed on tick: " ..tostring(event.tick))
15
15
  * end)
16
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#CustomInputEvent Online documentation}
16
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#CustomInputEvent Online documentation}
17
17
  */
18
18
  interface CustomInputEvent extends EventData {
19
19
  /**
@@ -47,7 +47,7 @@ declare module "factorio:runtime" {
47
47
  }
48
48
  /**
49
49
  * Called when an achievement is gained.
50
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_achievement_gained Online documentation}
50
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_achievement_gained Online documentation}
51
51
  */
52
52
  interface OnAchievementGainedEvent extends EventData {
53
53
  /**
@@ -66,7 +66,7 @@ declare module "factorio:runtime" {
66
66
  }
67
67
  /**
68
68
  * Called when a unit/group completes a command.
69
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_ai_command_completed Online documentation}
69
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_ai_command_completed Online documentation}
70
70
  */
71
71
  interface OnAiCommandCompletedEvent extends EventData {
72
72
  /**
@@ -89,7 +89,7 @@ declare module "factorio:runtime" {
89
89
  }
90
90
  /**
91
91
  * Called when an area of the map is cloned.
92
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_area_cloned Online documentation}
92
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_area_cloned Online documentation}
93
93
  */
94
94
  interface OnAreaClonedEvent extends EventData {
95
95
  readonly source_surface: LuaSurface
@@ -115,7 +115,7 @@ declare module "factorio:runtime" {
115
115
  * Called when a biter migration builds a base.
116
116
  *
117
117
  * This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
118
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_biter_base_built Online documentation}
118
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_biter_base_built Online documentation}
119
119
  */
120
120
  interface OnBiterBaseBuiltEvent extends EventData {
121
121
  /**
@@ -133,7 +133,7 @@ declare module "factorio:runtime" {
133
133
  }
134
134
  /**
135
135
  * Called when a set of positions on the map is cloned.
136
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_brush_cloned Online documentation}
136
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_brush_cloned Online documentation}
137
137
  */
138
138
  interface OnBrushClonedEvent extends EventData {
139
139
  readonly source_offset: TilePosition
@@ -158,7 +158,7 @@ declare module "factorio:runtime" {
158
158
  }
159
159
  /**
160
160
  * Called when a {@link defines.command.build_base} command reaches its destination, and before building starts.
161
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_build_base_arrived Online documentation}
161
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_build_base_arrived Online documentation}
162
162
  */
163
163
  interface OnBuildBaseArrivedEvent extends EventData {
164
164
  /**
@@ -182,7 +182,7 @@ declare module "factorio:runtime" {
182
182
  * Called when player builds something.
183
183
  *
184
184
  * Event filter: [LuaPlayerBuiltEntityEventFilter](LuaPlayerBuiltEntityEventFilter]
185
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_built_entity Online documentation}
185
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_built_entity Online documentation}
186
186
  */
187
187
  interface OnBuiltEntityEvent extends EventData {
188
188
  readonly entity: LuaEntity
@@ -205,7 +205,7 @@ declare module "factorio:runtime" {
205
205
  * Called when the deconstruction of an entity is canceled.
206
206
  *
207
207
  * Event filter: [LuaEntityDeconstructionCancelledEventFilter](LuaEntityDeconstructionCancelledEventFilter]
208
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_cancelled_deconstruction Online documentation}
208
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_cancelled_deconstruction Online documentation}
209
209
  */
210
210
  interface OnCancelledDeconstructionEvent extends EventData {
211
211
  readonly entity: LuaEntity
@@ -223,7 +223,7 @@ declare module "factorio:runtime" {
223
223
  * Called when the upgrade of an entity is canceled.
224
224
  *
225
225
  * Event filter: [LuaUpgradeCancelledEventFilter](LuaUpgradeCancelledEventFilter]
226
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_cancelled_upgrade Online documentation}
226
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_cancelled_upgrade Online documentation}
227
227
  */
228
228
  interface OnCancelledUpgradeEvent extends EventData {
229
229
  readonly entity: LuaEntity
@@ -243,7 +243,7 @@ declare module "factorio:runtime" {
243
243
  * Called when a character corpse expires due to timeout or all of the items being removed from it.
244
244
  *
245
245
  * this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
246
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_character_corpse_expired Online documentation}
246
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_character_corpse_expired Online documentation}
247
247
  */
248
248
  interface OnCharacterCorpseExpiredEvent extends EventData {
249
249
  /**
@@ -261,7 +261,7 @@ declare module "factorio:runtime" {
261
261
  }
262
262
  /**
263
263
  * Called when a chart tag is created.
264
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_chart_tag_added Online documentation}
264
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_chart_tag_added Online documentation}
265
265
  */
266
266
  interface OnChartTagAddedEvent extends EventData {
267
267
  readonly tag: LuaCustomChartTag
@@ -278,7 +278,7 @@ declare module "factorio:runtime" {
278
278
  }
279
279
  /**
280
280
  * Called when a chart tag is modified by a player.
281
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_chart_tag_modified Online documentation}
281
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_chart_tag_modified Online documentation}
282
282
  */
283
283
  interface OnChartTagModifiedEvent extends EventData {
284
284
  readonly tag: LuaCustomChartTag
@@ -300,7 +300,7 @@ declare module "factorio:runtime" {
300
300
  }
301
301
  /**
302
302
  * Called just before a chart tag is deleted.
303
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_chart_tag_removed Online documentation}
303
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_chart_tag_removed Online documentation}
304
304
  */
305
305
  interface OnChartTagRemovedEvent extends EventData {
306
306
  readonly tag: LuaCustomChartTag
@@ -317,7 +317,7 @@ declare module "factorio:runtime" {
317
317
  }
318
318
  /**
319
319
  * Called when a chunk is charted or re-charted.
320
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_chunk_charted Online documentation}
320
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_chunk_charted Online documentation}
321
321
  */
322
322
  interface OnChunkChartedEvent extends EventData {
323
323
  readonly surface_index: SurfaceIndex
@@ -338,7 +338,7 @@ declare module "factorio:runtime" {
338
338
  }
339
339
  /**
340
340
  * Called when one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
341
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_chunk_deleted Online documentation}
341
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_chunk_deleted Online documentation}
342
342
  */
343
343
  interface OnChunkDeletedEvent extends EventData {
344
344
  readonly surface_index: SurfaceIndex
@@ -357,7 +357,7 @@ declare module "factorio:runtime" {
357
357
  }
358
358
  /**
359
359
  * Called when a chunk is generated.
360
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_chunk_generated Online documentation}
360
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_chunk_generated Online documentation}
361
361
  */
362
362
  interface OnChunkGeneratedEvent extends EventData {
363
363
  /**
@@ -383,7 +383,7 @@ declare module "factorio:runtime" {
383
383
  }
384
384
  /**
385
385
  * Called when a combat robot expires through a lack of energy, or timeout.
386
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_combat_robot_expired Online documentation}
386
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_combat_robot_expired Online documentation}
387
387
  */
388
388
  interface OnCombatRobotExpiredEvent extends EventData {
389
389
  readonly robot: LuaEntity
@@ -404,7 +404,7 @@ declare module "factorio:runtime" {
404
404
  * Called when a message is sent to the in-game console, either by a player or through the server interface.
405
405
  *
406
406
  * This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
407
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_console_chat Online documentation}
407
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_console_chat Online documentation}
408
408
  */
409
409
  interface OnConsoleChatEvent extends EventData {
410
410
  /**
@@ -426,7 +426,7 @@ declare module "factorio:runtime" {
426
426
  }
427
427
  /**
428
428
  * Called when someone enters a command-like message regardless of it being a valid command.
429
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_console_command Online documentation}
429
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_console_command Online documentation}
430
430
  */
431
431
  interface OnConsoleCommandEvent extends EventData {
432
432
  /**
@@ -452,7 +452,7 @@ declare module "factorio:runtime" {
452
452
  }
453
453
  /**
454
454
  * Called when a cutscene is cancelled by the player or by script.
455
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_cutscene_cancelled Online documentation}
455
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_cutscene_cancelled Online documentation}
456
456
  */
457
457
  interface OnCutsceneCancelledEvent extends EventData {
458
458
  /**
@@ -470,7 +470,7 @@ declare module "factorio:runtime" {
470
470
  }
471
471
  /**
472
472
  * Called when a cutscene finishes naturally (was not cancelled).
473
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_cutscene_finished Online documentation}
473
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_cutscene_finished Online documentation}
474
474
  */
475
475
  interface OnCutsceneFinishedEvent extends EventData {
476
476
  /**
@@ -488,7 +488,7 @@ declare module "factorio:runtime" {
488
488
  }
489
489
  /**
490
490
  * Called when a cutscene starts.
491
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_cutscene_started Online documentation}
491
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_cutscene_started Online documentation}
492
492
  */
493
493
  interface OnCutsceneStartedEvent extends EventData {
494
494
  /**
@@ -508,7 +508,7 @@ declare module "factorio:runtime" {
508
508
  * Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.
509
509
  *
510
510
  * This refers to an index in the table previously passed to set_controller which started the cutscene.
511
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_cutscene_waypoint_reached Online documentation}
511
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_cutscene_waypoint_reached Online documentation}
512
512
  */
513
513
  interface OnCutsceneWaypointReachedEvent extends EventData {
514
514
  /**
@@ -532,7 +532,7 @@ declare module "factorio:runtime" {
532
532
  * Called when an entity is cloned. The filter applies to the source entity.
533
533
  *
534
534
  * Event filter: [LuaEntityClonedEventFilter](LuaEntityClonedEventFilter]
535
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_cloned Online documentation}
535
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_cloned Online documentation}
536
536
  */
537
537
  interface OnEntityClonedEvent extends EventData {
538
538
  readonly source: LuaEntity
@@ -550,7 +550,7 @@ declare module "factorio:runtime" {
550
550
  * Called after an entity has been recolored either by the player or through script.
551
551
  *
552
552
  * Automatic recoloring due to {@link LuaPlayer#color LuaPlayer::color} will not raise events, as that is a separate mechanism.
553
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_color_changed Online documentation}
553
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_color_changed Online documentation}
554
554
  */
555
555
  interface OnEntityColorChangedEvent extends EventData {
556
556
  /**
@@ -570,7 +570,7 @@ declare module "factorio:runtime" {
570
570
  * Called when an entity is damaged. This is not called when an entities health is set directly by another mod.
571
571
  *
572
572
  * Event filter: [LuaEntityDamagedEventFilter](LuaEntityDamagedEventFilter]
573
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_damaged Online documentation}
573
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_damaged Online documentation}
574
574
  */
575
575
  interface OnEntityDamagedEvent extends EventData {
576
576
  readonly entity: LuaEntity
@@ -612,7 +612,7 @@ declare module "factorio:runtime" {
612
612
  * Called when an entity dies.
613
613
  *
614
614
  * Event filter: [LuaEntityDiedEventFilter](LuaEntityDiedEventFilter]
615
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_died Online documentation}
615
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_died Online documentation}
616
616
  */
617
617
  interface OnEntityDiedEvent extends EventData {
618
618
  /**
@@ -646,7 +646,7 @@ declare module "factorio:runtime" {
646
646
  }
647
647
  /**
648
648
  * Called when one of an entity's logistic slots changes.
649
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_logistic_slot_changed Online documentation}
649
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_logistic_slot_changed Online documentation}
650
650
  */
651
651
  interface OnEntityLogisticSlotChangedEvent extends EventData {
652
652
  /**
@@ -676,7 +676,7 @@ declare module "factorio:runtime" {
676
676
  }
677
677
  /**
678
678
  * Called after an entity has been renamed either by the player or through script.
679
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_renamed Online documentation}
679
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_renamed Online documentation}
680
680
  */
681
681
  interface OnEntityRenamedEvent extends EventData {
682
682
  /**
@@ -697,7 +697,7 @@ declare module "factorio:runtime" {
697
697
  }
698
698
  /**
699
699
  * Called after entity copy-paste is done.
700
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_settings_pasted Online documentation}
700
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_settings_pasted Online documentation}
701
701
  */
702
702
  interface OnEntitySettingsPastedEvent extends EventData {
703
703
  readonly player_index: PlayerIndex
@@ -720,7 +720,7 @@ declare module "factorio:runtime" {
720
720
  }
721
721
  /**
722
722
  * Called when an entity is spawned by a EnemySpawner
723
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_entity_spawned Online documentation}
723
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_entity_spawned Online documentation}
724
724
  */
725
725
  interface OnEntitySpawnedEvent extends EventData {
726
726
  readonly spawner: LuaEntity
@@ -736,7 +736,7 @@ declare module "factorio:runtime" {
736
736
  }
737
737
  /**
738
738
  * Called after equipment is inserted into an equipment grid.
739
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_equipment_inserted Online documentation}
739
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_equipment_inserted Online documentation}
740
740
  */
741
741
  interface OnEquipmentInsertedEvent extends EventData {
742
742
  /**
@@ -758,7 +758,7 @@ declare module "factorio:runtime" {
758
758
  }
759
759
  /**
760
760
  * Called after equipment is removed from an equipment grid.
761
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_equipment_removed Online documentation}
761
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_equipment_removed Online documentation}
762
762
  */
763
763
  interface OnEquipmentRemovedEvent extends EventData {
764
764
  /**
@@ -788,7 +788,7 @@ declare module "factorio:runtime" {
788
788
  }
789
789
  /**
790
790
  * Called when the a forces cease fire values change.
791
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_force_cease_fire_changed Online documentation}
791
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_force_cease_fire_changed Online documentation}
792
792
  */
793
793
  interface OnForceCeaseFireChangedEvent extends EventData {
794
794
  /**
@@ -816,7 +816,7 @@ declare module "factorio:runtime" {
816
816
  * Called when a new force is created using `game.create_force()`
817
817
  *
818
818
  * This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
819
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_force_created Online documentation}
819
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_force_created Online documentation}
820
820
  */
821
821
  interface OnForceCreatedEvent extends EventData {
822
822
  /**
@@ -834,7 +834,7 @@ declare module "factorio:runtime" {
834
834
  }
835
835
  /**
836
836
  * Called when the a forces friends change.
837
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_force_friends_changed Online documentation}
837
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_force_friends_changed Online documentation}
838
838
  */
839
839
  interface OnForceFriendsChangedEvent extends EventData {
840
840
  /**
@@ -860,7 +860,7 @@ declare module "factorio:runtime" {
860
860
  }
861
861
  /**
862
862
  * Called when {@link LuaForce#reset LuaForce::reset} is finished.
863
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_force_reset Online documentation}
863
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_force_reset Online documentation}
864
864
  */
865
865
  interface OnForceResetEvent extends EventData {
866
866
  readonly force: LuaForce
@@ -877,7 +877,7 @@ declare module "factorio:runtime" {
877
877
  * Called after two forces have been merged using `game.merge_forces()`.
878
878
  *
879
879
  * The source force is invalidated before this event is called and the name can be re-used in this event if desired.
880
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_forces_merged Online documentation}
880
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_forces_merged Online documentation}
881
881
  */
882
882
  interface OnForcesMergedEvent extends EventData {
883
883
  /**
@@ -903,7 +903,7 @@ declare module "factorio:runtime" {
903
903
  }
904
904
  /**
905
905
  * Called when two forces are about to be merged using `game.merge_forces()`.
906
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_forces_merging Online documentation}
906
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_forces_merging Online documentation}
907
907
  */
908
908
  interface OnForcesMergingEvent extends EventData {
909
909
  /**
@@ -927,7 +927,7 @@ declare module "factorio:runtime" {
927
927
  * 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.
928
928
  *
929
929
  * This event is not fired when the scenario is loaded via the map editor.
930
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_game_created_from_scenario Online documentation}
930
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_game_created_from_scenario Online documentation}
931
931
  */
932
932
  interface OnGameCreatedFromScenarioEvent extends EventData {
933
933
  /**
@@ -941,7 +941,7 @@ declare module "factorio:runtime" {
941
941
  }
942
942
  /**
943
943
  * Called when {@link LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
944
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_checked_state_changed Online documentation}
944
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_checked_state_changed Online documentation}
945
945
  */
946
946
  interface OnGuiCheckedStateChangedEvent extends EventData {
947
947
  /**
@@ -963,7 +963,7 @@ declare module "factorio:runtime" {
963
963
  }
964
964
  /**
965
965
  * Called when {@link LuaGuiElement} is clicked.
966
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_click Online documentation}
966
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_click Online documentation}
967
967
  */
968
968
  interface OnGuiClickEvent extends EventData {
969
969
  /**
@@ -1009,7 +1009,7 @@ declare module "factorio:runtime" {
1009
1009
  * 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.
1010
1010
  *
1011
1011
  * 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.
1012
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_closed Online documentation}
1012
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_closed Online documentation}
1013
1013
  */
1014
1014
  interface OnGuiClosedEvent extends EventData {
1015
1015
  /**
@@ -1063,7 +1063,7 @@ declare module "factorio:runtime" {
1063
1063
  }
1064
1064
  /**
1065
1065
  * Called when a {@link LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
1066
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_confirmed Online documentation}
1066
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_confirmed Online documentation}
1067
1067
  */
1068
1068
  interface OnGuiConfirmedEvent extends EventData {
1069
1069
  /**
@@ -1097,7 +1097,7 @@ declare module "factorio:runtime" {
1097
1097
  }
1098
1098
  /**
1099
1099
  * Called when {@link LuaGuiElement} element value is changed (related to choose element buttons).
1100
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_elem_changed Online documentation}
1100
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_elem_changed Online documentation}
1101
1101
  */
1102
1102
  interface OnGuiElemChangedEvent extends EventData {
1103
1103
  /**
@@ -1121,7 +1121,7 @@ declare module "factorio:runtime" {
1121
1121
  * Called when {@link LuaGuiElement} is hovered by the mouse.
1122
1122
  *
1123
1123
  * Only fired for events whose {@link LuaGuiElement#raise_hover_events LuaGuiElement::raise_hover_events} is `true`.
1124
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_hover Online documentation}
1124
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_hover Online documentation}
1125
1125
  */
1126
1126
  interface OnGuiHoverEvent extends EventData {
1127
1127
  /**
@@ -1145,7 +1145,7 @@ declare module "factorio:runtime" {
1145
1145
  * Called when the player's cursor leaves a {@link LuaGuiElement} that was previously hovered.
1146
1146
  *
1147
1147
  * Only fired for events whose {@link LuaGuiElement#raise_hover_events LuaGuiElement::raise_hover_events} is `true`.
1148
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_leave Online documentation}
1148
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_leave Online documentation}
1149
1149
  */
1150
1150
  interface OnGuiLeaveEvent extends EventData {
1151
1151
  /**
@@ -1167,7 +1167,7 @@ declare module "factorio:runtime" {
1167
1167
  }
1168
1168
  /**
1169
1169
  * Called when {@link LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
1170
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_location_changed Online documentation}
1170
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_location_changed Online documentation}
1171
1171
  */
1172
1172
  interface OnGuiLocationChangedEvent extends EventData {
1173
1173
  /**
@@ -1189,7 +1189,7 @@ declare module "factorio:runtime" {
1189
1189
  }
1190
1190
  /**
1191
1191
  * Called when the player opens a GUI.
1192
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_opened Online documentation}
1192
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_opened Online documentation}
1193
1193
  */
1194
1194
  interface OnGuiOpenedEvent extends EventData {
1195
1195
  /**
@@ -1235,7 +1235,7 @@ declare module "factorio:runtime" {
1235
1235
  }
1236
1236
  /**
1237
1237
  * Called when {@link LuaGuiElement} selected tab is changed (related to tabbed-panes).
1238
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_selected_tab_changed Online documentation}
1238
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_selected_tab_changed Online documentation}
1239
1239
  */
1240
1240
  interface OnGuiSelectedTabChangedEvent extends EventData {
1241
1241
  /**
@@ -1257,7 +1257,7 @@ declare module "factorio:runtime" {
1257
1257
  }
1258
1258
  /**
1259
1259
  * Called when {@link LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
1260
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_selection_state_changed Online documentation}
1260
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_selection_state_changed Online documentation}
1261
1261
  */
1262
1262
  interface OnGuiSelectionStateChangedEvent extends EventData {
1263
1263
  /**
@@ -1279,7 +1279,7 @@ declare module "factorio:runtime" {
1279
1279
  }
1280
1280
  /**
1281
1281
  * Called when {@link LuaGuiElement} switch state is changed (related to switches).
1282
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_switch_state_changed Online documentation}
1282
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_switch_state_changed Online documentation}
1283
1283
  */
1284
1284
  interface OnGuiSwitchStateChangedEvent extends EventData {
1285
1285
  /**
@@ -1301,7 +1301,7 @@ declare module "factorio:runtime" {
1301
1301
  }
1302
1302
  /**
1303
1303
  * Called when {@link LuaGuiElement} text is changed by the player.
1304
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_text_changed Online documentation}
1304
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_text_changed Online documentation}
1305
1305
  */
1306
1306
  interface OnGuiTextChangedEvent extends EventData {
1307
1307
  /**
@@ -1327,7 +1327,7 @@ declare module "factorio:runtime" {
1327
1327
  }
1328
1328
  /**
1329
1329
  * Called when {@link LuaGuiElement} slider value is changed (related to the slider element).
1330
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_gui_value_changed Online documentation}
1330
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_gui_value_changed Online documentation}
1331
1331
  */
1332
1332
  interface OnGuiValueChangedEvent extends EventData {
1333
1333
  /**
@@ -1349,7 +1349,7 @@ declare module "factorio:runtime" {
1349
1349
  }
1350
1350
  /**
1351
1351
  * Called when a land mine is armed.
1352
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_land_mine_armed Online documentation}
1352
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_land_mine_armed Online documentation}
1353
1353
  */
1354
1354
  interface OnLandMineArmedEvent extends EventData {
1355
1355
  readonly mine: LuaEntity
@@ -1364,7 +1364,7 @@ declare module "factorio:runtime" {
1364
1364
  }
1365
1365
  /**
1366
1366
  * Called when a custom {@link import("factorio:prototype").ShortcutPrototype Lua shortcut} is pressed.
1367
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_lua_shortcut Online documentation}
1367
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_lua_shortcut Online documentation}
1368
1368
  */
1369
1369
  interface OnLuaShortcutEvent extends EventData {
1370
1370
  readonly player_index: PlayerIndex
@@ -1385,7 +1385,7 @@ declare module "factorio:runtime" {
1385
1385
  * Called when an entity is marked for deconstruction with the Deconstruction planner or via script.
1386
1386
  *
1387
1387
  * Event filter: [LuaEntityMarkedForDeconstructionEventFilter](LuaEntityMarkedForDeconstructionEventFilter]
1388
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_marked_for_deconstruction Online documentation}
1388
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_marked_for_deconstruction Online documentation}
1389
1389
  */
1390
1390
  interface OnMarkedForDeconstructionEvent extends EventData {
1391
1391
  readonly entity: LuaEntity
@@ -1403,7 +1403,7 @@ declare module "factorio:runtime" {
1403
1403
  * Called when an entity is marked for upgrade with the Upgrade planner or via script.
1404
1404
  *
1405
1405
  * Event filter: [LuaEntityMarkedForUpgradeEventFilter](LuaEntityMarkedForUpgradeEventFilter]
1406
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_marked_for_upgrade Online documentation}
1406
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_marked_for_upgrade Online documentation}
1407
1407
  */
1408
1408
  interface OnMarkedForUpgradeEvent extends EventData {
1409
1409
  readonly player_index?: PlayerIndex
@@ -1421,7 +1421,7 @@ declare module "factorio:runtime" {
1421
1421
  }
1422
1422
  /**
1423
1423
  * Called after a player purchases some offer from a `market` entity.
1424
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_market_item_purchased Online documentation}
1424
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_market_item_purchased Online documentation}
1425
1425
  */
1426
1426
  interface OnMarketItemPurchasedEvent extends EventData {
1427
1427
  /**
@@ -1451,7 +1451,7 @@ declare module "factorio:runtime" {
1451
1451
  }
1452
1452
  /**
1453
1453
  * Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
1454
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_mod_item_opened Online documentation}
1454
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_mod_item_opened Online documentation}
1455
1455
  */
1456
1456
  interface OnModItemOpenedEvent extends EventData {
1457
1457
  /**
@@ -1479,7 +1479,7 @@ declare module "factorio:runtime" {
1479
1479
  * Called after an object is destroyed that has been registered with {@link LuaBootstrap#register_on_object_destroyed LuaBootstrap::register_on_object_destroyed}.
1480
1480
  *
1481
1481
  * Depending on when a given object is destroyed, this event will be fired at the end of the current tick or at the end of the next tick.
1482
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_object_destroyed Online documentation}
1482
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_object_destroyed Online documentation}
1483
1483
  */
1484
1484
  interface OnObjectDestroyedEvent extends EventData {
1485
1485
  /**
@@ -1505,7 +1505,7 @@ declare module "factorio:runtime" {
1505
1505
  }
1506
1506
  /**
1507
1507
  * Called directly after a permission group is added.
1508
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_permission_group_added Online documentation}
1508
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_permission_group_added Online documentation}
1509
1509
  */
1510
1510
  interface OnPermissionGroupAddedEvent extends EventData {
1511
1511
  /**
@@ -1527,7 +1527,7 @@ declare module "factorio:runtime" {
1527
1527
  }
1528
1528
  /**
1529
1529
  * Called directly after a permission group is deleted.
1530
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_permission_group_deleted Online documentation}
1530
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_permission_group_deleted Online documentation}
1531
1531
  */
1532
1532
  interface OnPermissionGroupDeletedEvent extends EventData {
1533
1533
  /**
@@ -1553,7 +1553,7 @@ declare module "factorio:runtime" {
1553
1553
  }
1554
1554
  /**
1555
1555
  * Called directly after a permission group is edited in some way.
1556
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_permission_group_edited Online documentation}
1556
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_permission_group_edited Online documentation}
1557
1557
  */
1558
1558
  interface OnPermissionGroupEditedEvent extends EventData {
1559
1559
  /**
@@ -1602,7 +1602,7 @@ declare module "factorio:runtime" {
1602
1602
  }
1603
1603
  /**
1604
1604
  * Called directly after a permission string is imported.
1605
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_permission_string_imported Online documentation}
1605
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_permission_string_imported Online documentation}
1606
1606
  */
1607
1607
  interface OnPermissionStringImportedEvent extends EventData {
1608
1608
  /**
@@ -1620,7 +1620,7 @@ declare module "factorio:runtime" {
1620
1620
  }
1621
1621
  /**
1622
1622
  * Called when a player picks up an item.
1623
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_picked_up_item Online documentation}
1623
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_picked_up_item Online documentation}
1624
1624
  */
1625
1625
  interface OnPickedUpItemEvent extends EventData {
1626
1626
  readonly item_stack: SimpleItemStack
@@ -1636,7 +1636,7 @@ declare module "factorio:runtime" {
1636
1636
  }
1637
1637
  /**
1638
1638
  * Called after a player alt-reverse-selects an area with a selection-tool item.
1639
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_alt_reverse_selected_area Online documentation}
1639
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_alt_reverse_selected_area Online documentation}
1640
1640
  */
1641
1641
  interface OnPlayerAltReverseSelectedAreaEvent extends EventData {
1642
1642
  /**
@@ -1674,7 +1674,7 @@ declare module "factorio:runtime" {
1674
1674
  }
1675
1675
  /**
1676
1676
  * Called after a player alt-selects an area with a selection-tool item.
1677
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_alt_selected_area Online documentation}
1677
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_alt_selected_area Online documentation}
1678
1678
  */
1679
1679
  interface OnPlayerAltSelectedAreaEvent extends EventData {
1680
1680
  /**
@@ -1716,7 +1716,7 @@ declare module "factorio:runtime" {
1716
1716
  }
1717
1717
  /**
1718
1718
  * Called after a players ammo inventory changed in some way.
1719
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_ammo_inventory_changed Online documentation}
1719
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_ammo_inventory_changed Online documentation}
1720
1720
  */
1721
1721
  interface OnPlayerAmmoInventoryChangedEvent extends EventData {
1722
1722
  readonly player_index: PlayerIndex
@@ -1731,7 +1731,7 @@ declare module "factorio:runtime" {
1731
1731
  }
1732
1732
  /**
1733
1733
  * Called after a players armor inventory changed in some way.
1734
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_armor_inventory_changed Online documentation}
1734
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_armor_inventory_changed Online documentation}
1735
1735
  */
1736
1736
  interface OnPlayerArmorInventoryChangedEvent extends EventData {
1737
1737
  readonly player_index: PlayerIndex
@@ -1746,7 +1746,7 @@ declare module "factorio:runtime" {
1746
1746
  }
1747
1747
  /**
1748
1748
  * Called when a player is banned.
1749
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_banned Online documentation}
1749
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_banned Online documentation}
1750
1750
  */
1751
1751
  interface OnPlayerBannedEvent extends EventData {
1752
1752
  /**
@@ -1776,7 +1776,7 @@ declare module "factorio:runtime" {
1776
1776
  }
1777
1777
  /**
1778
1778
  * Called after a player builds tiles.
1779
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_built_tile Online documentation}
1779
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_built_tile Online documentation}
1780
1780
  */
1781
1781
  interface OnPlayerBuiltTileEvent extends EventData {
1782
1782
  readonly player_index: PlayerIndex
@@ -1815,7 +1815,7 @@ declare module "factorio:runtime" {
1815
1815
  }
1816
1816
  /**
1817
1817
  * Called when a player cancels crafting.
1818
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_cancelled_crafting Online documentation}
1818
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_cancelled_crafting Online documentation}
1819
1819
  */
1820
1820
  interface OnPlayerCancelledCraftingEvent extends EventData {
1821
1821
  /**
@@ -1845,7 +1845,7 @@ declare module "factorio:runtime" {
1845
1845
  }
1846
1846
  /**
1847
1847
  * Called after a player changes forces.
1848
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_changed_force Online documentation}
1848
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_changed_force Online documentation}
1849
1849
  */
1850
1850
  interface OnPlayerChangedForceEvent extends EventData {
1851
1851
  /**
@@ -1867,7 +1867,7 @@ declare module "factorio:runtime" {
1867
1867
  }
1868
1868
  /**
1869
1869
  * Called when the tile position a player is located at changes.
1870
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_changed_position Online documentation}
1870
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_changed_position Online documentation}
1871
1871
  */
1872
1872
  interface OnPlayerChangedPositionEvent extends EventData {
1873
1873
  /**
@@ -1885,7 +1885,7 @@ declare module "factorio:runtime" {
1885
1885
  }
1886
1886
  /**
1887
1887
  * Called after a player changes surfaces.
1888
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_changed_surface Online documentation}
1888
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_changed_surface Online documentation}
1889
1889
  */
1890
1890
  interface OnPlayerChangedSurfaceEvent extends EventData {
1891
1891
  /**
@@ -1907,7 +1907,7 @@ declare module "factorio:runtime" {
1907
1907
  }
1908
1908
  /**
1909
1909
  * Called when cheat mode is disabled on a player.
1910
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_cheat_mode_disabled Online documentation}
1910
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_cheat_mode_disabled Online documentation}
1911
1911
  */
1912
1912
  interface OnPlayerCheatModeDisabledEvent extends EventData {
1913
1913
  /**
@@ -1925,7 +1925,7 @@ declare module "factorio:runtime" {
1925
1925
  }
1926
1926
  /**
1927
1927
  * Called when cheat mode is enabled on a player.
1928
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_cheat_mode_enabled Online documentation}
1928
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_cheat_mode_enabled Online documentation}
1929
1929
  */
1930
1930
  interface OnPlayerCheatModeEnabledEvent extends EventData {
1931
1931
  /**
@@ -1943,7 +1943,7 @@ declare module "factorio:runtime" {
1943
1943
  }
1944
1944
  /**
1945
1945
  * Called when a player clicks a gps tag
1946
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_clicked_gps_tag Online documentation}
1946
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_clicked_gps_tag Online documentation}
1947
1947
  */
1948
1948
  interface OnPlayerClickedGpsTagEvent extends EventData {
1949
1949
  /**
@@ -1969,7 +1969,7 @@ declare module "factorio:runtime" {
1969
1969
  }
1970
1970
  /**
1971
1971
  * Called when a player clicks the "confirm" button in the configure Blueprint GUI.
1972
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_configured_blueprint Online documentation}
1972
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_configured_blueprint Online documentation}
1973
1973
  */
1974
1974
  interface OnPlayerConfiguredBlueprintEvent extends EventData {
1975
1975
  /**
@@ -1987,7 +1987,7 @@ declare module "factorio:runtime" {
1987
1987
  }
1988
1988
  /**
1989
1989
  * Called after a player changes controller types.
1990
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_controller_changed Online documentation}
1990
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_controller_changed Online documentation}
1991
1991
  */
1992
1992
  interface OnPlayerControllerChangedEvent extends EventData {
1993
1993
  /**
@@ -2009,7 +2009,7 @@ declare module "factorio:runtime" {
2009
2009
  }
2010
2010
  /**
2011
2011
  * 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}).
2012
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_crafted_item Online documentation}
2012
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_crafted_item Online documentation}
2013
2013
  */
2014
2014
  interface OnPlayerCraftedItemEvent extends EventData {
2015
2015
  /**
@@ -2035,7 +2035,7 @@ declare module "factorio:runtime" {
2035
2035
  }
2036
2036
  /**
2037
2037
  * Called after the player was created.
2038
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_created Online documentation}
2038
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_created Online documentation}
2039
2039
  */
2040
2040
  interface OnPlayerCreatedEvent extends EventData {
2041
2041
  readonly player_index: PlayerIndex
@@ -2052,7 +2052,7 @@ declare module "factorio:runtime" {
2052
2052
  * Called after a player's {@link LuaControl#cursor_stack cursor stack} changed in some way.
2053
2053
  *
2054
2054
  * This is fired in the same tick that the change happens, but not instantly.
2055
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_cursor_stack_changed Online documentation}
2055
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_cursor_stack_changed Online documentation}
2056
2056
  */
2057
2057
  interface OnPlayerCursorStackChangedEvent extends EventData {
2058
2058
  readonly player_index: PlayerIndex
@@ -2067,7 +2067,7 @@ declare module "factorio:runtime" {
2067
2067
  }
2068
2068
  /**
2069
2069
  * Called when a player selects an area with a deconstruction planner.
2070
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_deconstructed_area Online documentation}
2070
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_deconstructed_area Online documentation}
2071
2071
  */
2072
2072
  interface OnPlayerDeconstructedAreaEvent extends EventData {
2073
2073
  /**
@@ -2109,7 +2109,7 @@ declare module "factorio:runtime" {
2109
2109
  }
2110
2110
  /**
2111
2111
  * Called when a player is demoted.
2112
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_demoted Online documentation}
2112
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_demoted Online documentation}
2113
2113
  */
2114
2114
  interface OnPlayerDemotedEvent extends EventData {
2115
2115
  /**
@@ -2127,7 +2127,7 @@ declare module "factorio:runtime" {
2127
2127
  }
2128
2128
  /**
2129
2129
  * Called after a player dies.
2130
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_died Online documentation}
2130
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_died Online documentation}
2131
2131
  */
2132
2132
  interface OnPlayerDiedEvent extends EventData {
2133
2133
  readonly player_index: PlayerIndex
@@ -2143,7 +2143,7 @@ declare module "factorio:runtime" {
2143
2143
  }
2144
2144
  /**
2145
2145
  * Called when the display density scale changes for a given player. The display density scale is the scale value automatically applied based on the player's display DPI. This is only relevant on platforms that support high-density displays.
2146
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_display_density_scale_changed Online documentation}
2146
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_display_density_scale_changed Online documentation}
2147
2147
  */
2148
2148
  interface OnPlayerDisplayDensityScaleChangedEvent extends EventData {
2149
2149
  /**
@@ -2165,7 +2165,7 @@ declare module "factorio:runtime" {
2165
2165
  }
2166
2166
  /**
2167
2167
  * Called when the display resolution changes for a given player.
2168
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_display_resolution_changed Online documentation}
2168
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_display_resolution_changed Online documentation}
2169
2169
  */
2170
2170
  interface OnPlayerDisplayResolutionChangedEvent extends EventData {
2171
2171
  /**
@@ -2187,7 +2187,7 @@ declare module "factorio:runtime" {
2187
2187
  }
2188
2188
  /**
2189
2189
  * Called when the display scale changes for a given player.
2190
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_display_scale_changed Online documentation}
2190
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_display_scale_changed Online documentation}
2191
2191
  */
2192
2192
  interface OnPlayerDisplayScaleChangedEvent extends EventData {
2193
2193
  /**
@@ -2211,7 +2211,7 @@ declare module "factorio:runtime" {
2211
2211
  * Called when the player's driving state has changed, meaning a player has either entered or left a vehicle.
2212
2212
  *
2213
2213
  * This event is not raised when the player is ejected from a vehicle due to it being destroyed.
2214
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_driving_changed_state Online documentation}
2214
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_driving_changed_state Online documentation}
2215
2215
  */
2216
2216
  interface OnPlayerDrivingChangedStateEvent extends EventData {
2217
2217
  readonly player_index: PlayerIndex
@@ -2230,7 +2230,7 @@ declare module "factorio:runtime" {
2230
2230
  }
2231
2231
  /**
2232
2232
  * Called when a player drops an item on the ground.
2233
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_dropped_item Online documentation}
2233
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_dropped_item Online documentation}
2234
2234
  */
2235
2235
  interface OnPlayerDroppedItemEvent extends EventData {
2236
2236
  readonly player_index: PlayerIndex
@@ -2249,7 +2249,7 @@ declare module "factorio:runtime" {
2249
2249
  }
2250
2250
  /**
2251
2251
  * Called when a player fast-transfers something to or from an entity.
2252
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_fast_transferred Online documentation}
2252
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_fast_transferred Online documentation}
2253
2253
  */
2254
2254
  interface OnPlayerFastTransferredEvent extends EventData {
2255
2255
  /**
@@ -2279,7 +2279,7 @@ declare module "factorio:runtime" {
2279
2279
  }
2280
2280
  /**
2281
2281
  * Called when the player flips an entity. This event is only fired when the entity actually changes its orientation or mirroring -- pressing the flip keys on an entity that can't be flipped won't fire this event.
2282
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_flipped_entity Online documentation}
2282
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_flipped_entity Online documentation}
2283
2283
  */
2284
2284
  interface OnPlayerFlippedEntityEvent extends EventData {
2285
2285
  /**
@@ -2302,7 +2302,7 @@ declare module "factorio:runtime" {
2302
2302
  }
2303
2303
  /**
2304
2304
  * Called after player flushed fluid
2305
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_flushed_fluid Online documentation}
2305
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_flushed_fluid Online documentation}
2306
2306
  */
2307
2307
  interface OnPlayerFlushedFluidEvent extends EventData {
2308
2308
  /**
@@ -2336,7 +2336,7 @@ declare module "factorio:runtime" {
2336
2336
  }
2337
2337
  /**
2338
2338
  * Called after a players gun inventory changed in some way.
2339
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_gun_inventory_changed Online documentation}
2339
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_gun_inventory_changed Online documentation}
2340
2340
  */
2341
2341
  interface OnPlayerGunInventoryChangedEvent extends EventData {
2342
2342
  readonly player_index: PlayerIndex
@@ -2351,7 +2351,7 @@ declare module "factorio:runtime" {
2351
2351
  }
2352
2352
  /**
2353
2353
  * Called when a player's input method changes. See {@link LuaPlayer#input_method LuaPlayer::input_method}.
2354
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_input_method_changed Online documentation}
2354
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_input_method_changed Online documentation}
2355
2355
  */
2356
2356
  interface OnPlayerInputMethodChangedEvent extends EventData {
2357
2357
  /**
@@ -2369,7 +2369,7 @@ declare module "factorio:runtime" {
2369
2369
  }
2370
2370
  /**
2371
2371
  * 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.
2372
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_joined_game Online documentation}
2372
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_joined_game Online documentation}
2373
2373
  */
2374
2374
  interface OnPlayerJoinedGameEvent extends EventData {
2375
2375
  readonly player_index: PlayerIndex
@@ -2384,7 +2384,7 @@ declare module "factorio:runtime" {
2384
2384
  }
2385
2385
  /**
2386
2386
  * Called when a player is kicked.
2387
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_kicked Online documentation}
2387
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_kicked Online documentation}
2388
2388
  */
2389
2389
  interface OnPlayerKickedEvent extends EventData {
2390
2390
  /**
@@ -2410,7 +2410,7 @@ declare module "factorio:runtime" {
2410
2410
  }
2411
2411
  /**
2412
2412
  * 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.
2413
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_left_game Online documentation}
2413
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_left_game Online documentation}
2414
2414
  */
2415
2415
  interface OnPlayerLeftGameEvent extends EventData {
2416
2416
  readonly player_index: PlayerIndex
@@ -2426,7 +2426,7 @@ declare module "factorio:runtime" {
2426
2426
  }
2427
2427
  /**
2428
2428
  * Called when a player's active locale changes. See {@link LuaPlayer#locale LuaPlayer::locale}.
2429
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_locale_changed Online documentation}
2429
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_locale_changed Online documentation}
2430
2430
  */
2431
2431
  interface OnPlayerLocaleChangedEvent extends EventData {
2432
2432
  /**
@@ -2448,7 +2448,7 @@ declare module "factorio:runtime" {
2448
2448
  }
2449
2449
  /**
2450
2450
  * Called after a players main inventory changed in some way.
2451
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_main_inventory_changed Online documentation}
2451
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_main_inventory_changed Online documentation}
2452
2452
  */
2453
2453
  interface OnPlayerMainInventoryChangedEvent extends EventData {
2454
2454
  readonly player_index: PlayerIndex
@@ -2469,7 +2469,7 @@ declare module "factorio:runtime" {
2469
2469
  * 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.
2470
2470
  *
2471
2471
  * Event filter: [LuaPlayerMinedEntityEventFilter](LuaPlayerMinedEntityEventFilter]
2472
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_mined_entity Online documentation}
2472
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_mined_entity Online documentation}
2473
2473
  */
2474
2474
  interface OnPlayerMinedEntityEvent extends EventData {
2475
2475
  /**
@@ -2495,7 +2495,7 @@ declare module "factorio:runtime" {
2495
2495
  }
2496
2496
  /**
2497
2497
  * Called when the player mines something.
2498
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_mined_item Online documentation}
2498
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_mined_item Online documentation}
2499
2499
  */
2500
2500
  interface OnPlayerMinedItemEvent extends EventData {
2501
2501
  /**
@@ -2514,7 +2514,7 @@ declare module "factorio:runtime" {
2514
2514
  }
2515
2515
  /**
2516
2516
  * Called after a player mines tiles.
2517
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_mined_tile Online documentation}
2517
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_mined_tile Online documentation}
2518
2518
  */
2519
2519
  interface OnPlayerMinedTileEvent extends EventData {
2520
2520
  readonly player_index: PlayerIndex
@@ -2537,7 +2537,7 @@ declare module "factorio:runtime" {
2537
2537
  }
2538
2538
  /**
2539
2539
  * Called when a player is muted.
2540
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_muted Online documentation}
2540
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_muted Online documentation}
2541
2541
  */
2542
2542
  interface OnPlayerMutedEvent extends EventData {
2543
2543
  /**
@@ -2555,7 +2555,7 @@ declare module "factorio:runtime" {
2555
2555
  }
2556
2556
  /**
2557
2557
  * Called when a player invokes the "smart pipette" over an entity.
2558
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_pipette Online documentation}
2558
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_pipette Online documentation}
2559
2559
  */
2560
2560
  interface OnPlayerPipetteEvent extends EventData {
2561
2561
  /**
@@ -2585,7 +2585,7 @@ declare module "factorio:runtime" {
2585
2585
  }
2586
2586
  /**
2587
2587
  * Called after the player puts equipment in an equipment grid
2588
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_placed_equipment Online documentation}
2588
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_placed_equipment Online documentation}
2589
2589
  */
2590
2590
  interface OnPlayerPlacedEquipmentEvent extends EventData {
2591
2591
  readonly player_index: PlayerIndex
@@ -2608,7 +2608,7 @@ declare module "factorio:runtime" {
2608
2608
  }
2609
2609
  /**
2610
2610
  * Called when a player is promoted.
2611
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_promoted Online documentation}
2611
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_promoted Online documentation}
2612
2612
  */
2613
2613
  interface OnPlayerPromotedEvent extends EventData {
2614
2614
  /**
@@ -2626,7 +2626,7 @@ declare module "factorio:runtime" {
2626
2626
  }
2627
2627
  /**
2628
2628
  * Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link OnPlayerLeftGameEvent leaving} the game, and instead behaves like the player never existed in the save file.
2629
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_removed Online documentation}
2629
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_removed Online documentation}
2630
2630
  */
2631
2631
  interface OnPlayerRemovedEvent extends EventData {
2632
2632
  /**
@@ -2644,7 +2644,7 @@ declare module "factorio:runtime" {
2644
2644
  }
2645
2645
  /**
2646
2646
  * Called after the player removes equipment from an equipment grid
2647
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_removed_equipment Online documentation}
2647
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_removed_equipment Online documentation}
2648
2648
  */
2649
2649
  interface OnPlayerRemovedEquipmentEvent extends EventData {
2650
2650
  readonly player_index: PlayerIndex
@@ -2677,7 +2677,7 @@ declare module "factorio:runtime" {
2677
2677
  * Called when a player repairs an entity.
2678
2678
  *
2679
2679
  * Event filter: [LuaPlayerRepairedEntityEventFilter](LuaPlayerRepairedEntityEventFilter]
2680
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_repaired_entity Online documentation}
2680
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_repaired_entity Online documentation}
2681
2681
  */
2682
2682
  interface OnPlayerRepairedEntityEvent extends EventData {
2683
2683
  readonly player_index: PlayerIndex
@@ -2693,7 +2693,7 @@ declare module "factorio:runtime" {
2693
2693
  }
2694
2694
  /**
2695
2695
  * Called after a player respawns.
2696
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_respawned Online documentation}
2696
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_respawned Online documentation}
2697
2697
  */
2698
2698
  interface OnPlayerRespawnedEvent extends EventData {
2699
2699
  readonly player_index: PlayerIndex
@@ -2712,7 +2712,7 @@ declare module "factorio:runtime" {
2712
2712
  }
2713
2713
  /**
2714
2714
  * Called after a player reverse-selects an area with a selection-tool item.
2715
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_reverse_selected_area Online documentation}
2715
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_reverse_selected_area Online documentation}
2716
2716
  */
2717
2717
  interface OnPlayerReverseSelectedAreaEvent extends EventData {
2718
2718
  /**
@@ -2752,7 +2752,7 @@ declare module "factorio:runtime" {
2752
2752
  * 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.
2753
2753
  *
2754
2754
  * Entities being flipped will not fire this event, even if the flip involves rotating. See {@link OnPlayerFlippedEntityEvent on_player_flipped_entity}.
2755
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_rotated_entity Online documentation}
2755
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_rotated_entity Online documentation}
2756
2756
  */
2757
2757
  interface OnPlayerRotatedEntityEvent extends EventData {
2758
2758
  /**
@@ -2775,7 +2775,7 @@ declare module "factorio:runtime" {
2775
2775
  }
2776
2776
  /**
2777
2777
  * Called after a player selects an area with a selection-tool item.
2778
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_selected_area Online documentation}
2778
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_selected_area Online documentation}
2779
2779
  */
2780
2780
  interface OnPlayerSelectedAreaEvent extends EventData {
2781
2781
  /**
@@ -2817,7 +2817,7 @@ declare module "factorio:runtime" {
2817
2817
  }
2818
2818
  /**
2819
2819
  * Called when a player sets a quickbar slot to anything (new value, or set to empty).
2820
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_set_quick_bar_slot Online documentation}
2820
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_set_quick_bar_slot Online documentation}
2821
2821
  */
2822
2822
  interface OnPlayerSetQuickBarSlotEvent extends EventData {
2823
2823
  readonly player_index: PlayerIndex
@@ -2832,7 +2832,7 @@ declare module "factorio:runtime" {
2832
2832
  }
2833
2833
  /**
2834
2834
  * Called when a player selects an area with a blueprint.
2835
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_setup_blueprint Online documentation}
2835
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_setup_blueprint Online documentation}
2836
2836
  */
2837
2837
  interface OnPlayerSetupBlueprintEvent extends EventData {
2838
2838
  /**
@@ -2878,7 +2878,7 @@ declare module "factorio:runtime" {
2878
2878
  }
2879
2879
  /**
2880
2880
  * Called when a player toggles alt mode, also known as "show entity info".
2881
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_toggled_alt_mode Online documentation}
2881
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_toggled_alt_mode Online documentation}
2882
2882
  */
2883
2883
  interface OnPlayerToggledAltModeEvent extends EventData {
2884
2884
  readonly player_index: PlayerIndex
@@ -2897,7 +2897,7 @@ declare module "factorio:runtime" {
2897
2897
  }
2898
2898
  /**
2899
2899
  * Called when a player toggles the map editor on or off.
2900
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_toggled_map_editor Online documentation}
2900
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_toggled_map_editor Online documentation}
2901
2901
  */
2902
2902
  interface OnPlayerToggledMapEditorEvent extends EventData {
2903
2903
  readonly player_index: PlayerIndex
@@ -2912,7 +2912,7 @@ declare module "factorio:runtime" {
2912
2912
  }
2913
2913
  /**
2914
2914
  * Called after a players trash inventory changed in some way.
2915
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_trash_inventory_changed Online documentation}
2915
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_trash_inventory_changed Online documentation}
2916
2916
  */
2917
2917
  interface OnPlayerTrashInventoryChangedEvent extends EventData {
2918
2918
  readonly player_index: PlayerIndex
@@ -2927,7 +2927,7 @@ declare module "factorio:runtime" {
2927
2927
  }
2928
2928
  /**
2929
2929
  * Called when a player is un-banned.
2930
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_unbanned Online documentation}
2930
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_unbanned Online documentation}
2931
2931
  */
2932
2932
  interface OnPlayerUnbannedEvent extends EventData {
2933
2933
  /**
@@ -2957,7 +2957,7 @@ declare module "factorio:runtime" {
2957
2957
  }
2958
2958
  /**
2959
2959
  * Called when a player is unmuted.
2960
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_unmuted Online documentation}
2960
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_unmuted Online documentation}
2961
2961
  */
2962
2962
  interface OnPlayerUnmutedEvent extends EventData {
2963
2963
  /**
@@ -2975,7 +2975,7 @@ declare module "factorio:runtime" {
2975
2975
  }
2976
2976
  /**
2977
2977
  * Called when a player uses a capsule that results in some game action.
2978
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_used_capsule Online documentation}
2978
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_used_capsule Online documentation}
2979
2979
  */
2980
2980
  interface OnPlayerUsedCapsuleEvent extends EventData {
2981
2981
  /**
@@ -3005,7 +3005,7 @@ declare module "factorio:runtime" {
3005
3005
  }
3006
3006
  /**
3007
3007
  * Called when a player uses spidertron remote to send all selected units to a given position
3008
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_player_used_spidertron_remote Online documentation}
3008
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_player_used_spidertron_remote Online documentation}
3009
3009
  */
3010
3010
  interface OnPlayerUsedSpidertronRemoteEvent extends EventData {
3011
3011
  /**
@@ -3029,7 +3029,7 @@ declare module "factorio:runtime" {
3029
3029
  * Called after an entity dies.
3030
3030
  *
3031
3031
  * Event filter: [LuaPostEntityDiedEventFilter](LuaPostEntityDiedEventFilter]
3032
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_post_entity_died Online documentation}
3032
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_post_entity_died Online documentation}
3033
3033
  */
3034
3034
  interface OnPostEntityDiedEvent extends EventData {
3035
3035
  /**
@@ -3079,7 +3079,7 @@ declare module "factorio:runtime" {
3079
3079
  }
3080
3080
  /**
3081
3081
  * Called when players uses an item to build something. Called before {@link OnBuiltEntityEvent on_built_entity}.
3082
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_build Online documentation}
3082
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_build Online documentation}
3083
3083
  */
3084
3084
  interface OnPreBuildEvent extends EventData {
3085
3085
  /**
@@ -3125,7 +3125,7 @@ declare module "factorio:runtime" {
3125
3125
  }
3126
3126
  /**
3127
3127
  * Called before one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
3128
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_chunk_deleted Online documentation}
3128
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_chunk_deleted Online documentation}
3129
3129
  */
3130
3130
  interface OnPreChunkDeletedEvent extends EventData {
3131
3131
  readonly surface_index: SurfaceIndex
@@ -3144,7 +3144,7 @@ declare module "factorio:runtime" {
3144
3144
  }
3145
3145
  /**
3146
3146
  * Called before entity copy-paste is done.
3147
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_entity_settings_pasted Online documentation}
3147
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_entity_settings_pasted Online documentation}
3148
3148
  */
3149
3149
  interface OnPreEntitySettingsPastedEvent extends EventData {
3150
3150
  readonly player_index: PlayerIndex
@@ -3171,7 +3171,7 @@ declare module "factorio:runtime" {
3171
3171
  * Also called for item request proxies before they are destroyed as a result of being marked for deconstruction.
3172
3172
  *
3173
3173
  * Event filter: [LuaPreGhostDeconstructedEventFilter](LuaPreGhostDeconstructedEventFilter]
3174
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_ghost_deconstructed Online documentation}
3174
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_ghost_deconstructed Online documentation}
3175
3175
  */
3176
3176
  interface OnPreGhostDeconstructedEvent extends EventData {
3177
3177
  /**
@@ -3192,7 +3192,7 @@ declare module "factorio:runtime" {
3192
3192
  * Called before a ghost entity is upgraded.
3193
3193
  *
3194
3194
  * Event filter: [LuaPreGhostUpgradedEventFilter](LuaPreGhostUpgradedEventFilter]
3195
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_ghost_upgraded Online documentation}
3195
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_ghost_upgraded Online documentation}
3196
3196
  */
3197
3197
  interface OnPreGhostUpgradedEvent extends EventData {
3198
3198
  /**
@@ -3213,7 +3213,7 @@ declare module "factorio:runtime" {
3213
3213
  }
3214
3214
  /**
3215
3215
  * Called directly before a permission group is deleted.
3216
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_permission_group_deleted Online documentation}
3216
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_permission_group_deleted Online documentation}
3217
3217
  */
3218
3218
  interface OnPrePermissionGroupDeletedEvent extends EventData {
3219
3219
  /**
@@ -3235,7 +3235,7 @@ declare module "factorio:runtime" {
3235
3235
  }
3236
3236
  /**
3237
3237
  * Called directly before a permission string is imported.
3238
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_permission_string_imported Online documentation}
3238
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_permission_string_imported Online documentation}
3239
3239
  */
3240
3240
  interface OnPrePermissionStringImportedEvent extends EventData {
3241
3241
  /**
@@ -3253,7 +3253,7 @@ declare module "factorio:runtime" {
3253
3253
  }
3254
3254
  /**
3255
3255
  * Called when a player queues something to be crafted.
3256
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_player_crafted_item Online documentation}
3256
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_player_crafted_item Online documentation}
3257
3257
  */
3258
3258
  interface OnPrePlayerCraftedItemEvent extends EventData {
3259
3259
  /**
@@ -3283,7 +3283,7 @@ declare module "factorio:runtime" {
3283
3283
  }
3284
3284
  /**
3285
3285
  * Called before a players dies.
3286
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_player_died Online documentation}
3286
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_player_died Online documentation}
3287
3287
  */
3288
3288
  interface OnPrePlayerDiedEvent extends EventData {
3289
3289
  readonly player_index: PlayerIndex
@@ -3299,7 +3299,7 @@ declare module "factorio:runtime" {
3299
3299
  }
3300
3300
  /**
3301
3301
  * Called before a player leaves the game.
3302
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_player_left_game Online documentation}
3302
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_player_left_game Online documentation}
3303
3303
  */
3304
3304
  interface OnPrePlayerLeftGameEvent extends EventData {
3305
3305
  readonly player_index: PlayerIndex
@@ -3317,7 +3317,7 @@ declare module "factorio:runtime" {
3317
3317
  * Called when the player completes a mining action, but before the entity is potentially removed from the map. This is called even if the entity does not end up being removed.
3318
3318
  *
3319
3319
  * Event filter: [LuaPrePlayerMinedEntityEventFilter](LuaPrePlayerMinedEntityEventFilter]
3320
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_player_mined_item Online documentation}
3320
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_player_mined_item Online documentation}
3321
3321
  */
3322
3322
  interface OnPrePlayerMinedItemEvent extends EventData {
3323
3323
  /**
@@ -3336,7 +3336,7 @@ declare module "factorio:runtime" {
3336
3336
  }
3337
3337
  /**
3338
3338
  * Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link OnPlayerLeftGameEvent leaving} the game, and instead behaves like the player never existed in the save file.
3339
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_player_removed Online documentation}
3339
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_player_removed Online documentation}
3340
3340
  */
3341
3341
  interface OnPrePlayerRemovedEvent extends EventData {
3342
3342
  /**
@@ -3354,7 +3354,7 @@ declare module "factorio:runtime" {
3354
3354
  }
3355
3355
  /**
3356
3356
  * Called before a player toggles the map editor on or off.
3357
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_player_toggled_map_editor Online documentation}
3357
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_player_toggled_map_editor Online documentation}
3358
3358
  */
3359
3359
  interface OnPrePlayerToggledMapEditorEvent extends EventData {
3360
3360
  readonly player_index: PlayerIndex
@@ -3369,7 +3369,7 @@ declare module "factorio:runtime" {
3369
3369
  }
3370
3370
  /**
3371
3371
  * Called directly before a robot explodes cliffs.
3372
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_robot_exploded_cliff Online documentation}
3372
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_robot_exploded_cliff Online documentation}
3373
3373
  */
3374
3374
  interface OnPreRobotExplodedCliffEvent extends EventData {
3375
3375
  readonly robot: LuaEntity
@@ -3393,7 +3393,7 @@ declare module "factorio:runtime" {
3393
3393
  }
3394
3394
  /**
3395
3395
  * Called just before the scenario finishes.
3396
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_scenario_finished Online documentation}
3396
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_scenario_finished Online documentation}
3397
3397
  */
3398
3398
  interface OnPreScenarioFinishedEvent extends EventData {
3399
3399
  /**
@@ -3411,7 +3411,7 @@ declare module "factorio:runtime" {
3411
3411
  }
3412
3412
  /**
3413
3413
  * Called just before a script inventory is resized.
3414
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_script_inventory_resized Online documentation}
3414
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_script_inventory_resized Online documentation}
3415
3415
  */
3416
3416
  interface OnPreScriptInventoryResizedEvent extends EventData {
3417
3417
  /**
@@ -3442,7 +3442,7 @@ declare module "factorio:runtime" {
3442
3442
  }
3443
3443
  /**
3444
3444
  * Called just before a surface is cleared (all entities removed and all chunks deleted).
3445
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_surface_cleared Online documentation}
3445
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_surface_cleared Online documentation}
3446
3446
  */
3447
3447
  interface OnPreSurfaceClearedEvent extends EventData {
3448
3448
  readonly surface_index: SurfaceIndex
@@ -3457,7 +3457,7 @@ declare module "factorio:runtime" {
3457
3457
  }
3458
3458
  /**
3459
3459
  * Called just before a surface is deleted.
3460
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_pre_surface_deleted Online documentation}
3460
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_pre_surface_deleted Online documentation}
3461
3461
  */
3462
3462
  interface OnPreSurfaceDeletedEvent extends EventData {
3463
3463
  readonly surface_index: SurfaceIndex
@@ -3472,7 +3472,7 @@ declare module "factorio:runtime" {
3472
3472
  }
3473
3473
  /**
3474
3474
  * Called when the player triggers "redo".
3475
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_redo_applied Online documentation}
3475
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_redo_applied Online documentation}
3476
3476
  */
3477
3477
  interface OnRedoAppliedEvent extends EventData {
3478
3478
  /**
@@ -3494,7 +3494,7 @@ declare module "factorio:runtime" {
3494
3494
  }
3495
3495
  /**
3496
3496
  * Called when research is cancelled.
3497
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_research_cancelled Online documentation}
3497
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_research_cancelled Online documentation}
3498
3498
  */
3499
3499
  interface OnResearchCancelledEvent extends EventData {
3500
3500
  /**
@@ -3516,7 +3516,7 @@ declare module "factorio:runtime" {
3516
3516
  }
3517
3517
  /**
3518
3518
  * Called when a research finishes.
3519
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_research_finished Online documentation}
3519
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_research_finished Online documentation}
3520
3520
  */
3521
3521
  interface OnResearchFinishedEvent extends EventData {
3522
3522
  /**
@@ -3538,7 +3538,7 @@ declare module "factorio:runtime" {
3538
3538
  }
3539
3539
  /**
3540
3540
  * Called when research is moved forwards or backwards in the research queue.
3541
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_research_moved Online documentation}
3541
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_research_moved Online documentation}
3542
3542
  */
3543
3543
  interface OnResearchMovedEvent extends EventData {
3544
3544
  /**
@@ -3556,7 +3556,7 @@ declare module "factorio:runtime" {
3556
3556
  }
3557
3557
  /**
3558
3558
  * Called when a research is reversed (unresearched).
3559
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_research_reversed Online documentation}
3559
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_research_reversed Online documentation}
3560
3560
  */
3561
3561
  interface OnResearchReversedEvent extends EventData {
3562
3562
  /**
@@ -3578,7 +3578,7 @@ declare module "factorio:runtime" {
3578
3578
  }
3579
3579
  /**
3580
3580
  * Called when a technology research starts.
3581
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_research_started Online documentation}
3581
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_research_started Online documentation}
3582
3582
  */
3583
3583
  interface OnResearchStartedEvent extends EventData {
3584
3584
  /**
@@ -3597,7 +3597,7 @@ declare module "factorio:runtime" {
3597
3597
  }
3598
3598
  /**
3599
3599
  * Called when a resource entity reaches 0 or its minimum yield for infinite resources.
3600
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_resource_depleted Online documentation}
3600
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_resource_depleted Online documentation}
3601
3601
  */
3602
3602
  interface OnResourceDepletedEvent extends EventData {
3603
3603
  readonly entity: LuaEntity
@@ -3614,7 +3614,7 @@ declare module "factorio:runtime" {
3614
3614
  * Called when a construction robot builds an entity.
3615
3615
  *
3616
3616
  * Event filter: [LuaRobotBuiltEntityEventFilter](LuaRobotBuiltEntityEventFilter]
3617
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_built_entity Online documentation}
3617
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_built_entity Online documentation}
3618
3618
  */
3619
3619
  interface OnRobotBuiltEntityEvent extends EventData {
3620
3620
  /**
@@ -3644,7 +3644,7 @@ declare module "factorio:runtime" {
3644
3644
  }
3645
3645
  /**
3646
3646
  * Called after a robot builds tiles.
3647
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_built_tile Online documentation}
3647
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_built_tile Online documentation}
3648
3648
  */
3649
3649
  interface OnRobotBuiltTileEvent extends EventData {
3650
3650
  /**
@@ -3686,7 +3686,7 @@ declare module "factorio:runtime" {
3686
3686
  }
3687
3687
  /**
3688
3688
  * Called directly after a robot explodes cliffs.
3689
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_exploded_cliff Online documentation}
3689
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_exploded_cliff Online documentation}
3690
3690
  */
3691
3691
  interface OnRobotExplodedCliffEvent extends EventData {
3692
3692
  readonly robot: LuaEntity
@@ -3709,7 +3709,7 @@ declare module "factorio:runtime" {
3709
3709
  }
3710
3710
  /**
3711
3711
  * Called when a robot mines an entity.
3712
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_mined Online documentation}
3712
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_mined Online documentation}
3713
3713
  */
3714
3714
  interface OnRobotMinedEvent extends EventData {
3715
3715
  /**
@@ -3737,7 +3737,7 @@ declare module "factorio:runtime" {
3737
3737
  * 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.
3738
3738
  *
3739
3739
  * Event filter: [LuaRobotMinedEntityEventFilter](LuaRobotMinedEntityEventFilter]
3740
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_mined_entity Online documentation}
3740
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_mined_entity Online documentation}
3741
3741
  */
3742
3742
  interface OnRobotMinedEntityEvent extends EventData {
3743
3743
  /**
@@ -3763,7 +3763,7 @@ declare module "factorio:runtime" {
3763
3763
  }
3764
3764
  /**
3765
3765
  * Called after a robot mines tiles.
3766
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_mined_tile Online documentation}
3766
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_mined_tile Online documentation}
3767
3767
  */
3768
3768
  interface OnRobotMinedTileEvent extends EventData {
3769
3769
  /**
@@ -3791,7 +3791,7 @@ declare module "factorio:runtime" {
3791
3791
  * Called before a robot mines an entity.
3792
3792
  *
3793
3793
  * Event filter: [LuaPreRobotMinedEntityEventFilter](LuaPreRobotMinedEntityEventFilter]
3794
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_robot_pre_mined Online documentation}
3794
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_robot_pre_mined Online documentation}
3795
3795
  */
3796
3796
  interface OnRobotPreMinedEvent extends EventData {
3797
3797
  /**
@@ -3813,7 +3813,7 @@ declare module "factorio:runtime" {
3813
3813
  }
3814
3814
  /**
3815
3815
  * Called when a rocket silo is ordered to be launched.
3816
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_rocket_launch_ordered Online documentation}
3816
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_rocket_launch_ordered Online documentation}
3817
3817
  */
3818
3818
  interface OnRocketLaunchOrderedEvent extends EventData {
3819
3819
  readonly rocket: LuaEntity
@@ -3833,7 +3833,7 @@ declare module "factorio:runtime" {
3833
3833
  }
3834
3834
  /**
3835
3835
  * Called when the rocket is launched.
3836
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_rocket_launched Online documentation}
3836
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_rocket_launched Online documentation}
3837
3837
  */
3838
3838
  interface OnRocketLaunchedEvent extends EventData {
3839
3839
  readonly rocket: LuaEntity
@@ -3853,7 +3853,7 @@ declare module "factorio:runtime" {
3853
3853
  }
3854
3854
  /**
3855
3855
  * Called when a runtime mod setting is changed by a player.
3856
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_runtime_mod_setting_changed Online documentation}
3856
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_runtime_mod_setting_changed Online documentation}
3857
3857
  */
3858
3858
  interface OnRuntimeModSettingChangedEvent extends EventData {
3859
3859
  /**
@@ -3876,7 +3876,7 @@ declare module "factorio:runtime" {
3876
3876
  }
3877
3877
  /**
3878
3878
  * Called just after a script inventory is resized.
3879
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_script_inventory_resized Online documentation}
3879
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_script_inventory_resized Online documentation}
3880
3880
  */
3881
3881
  interface OnScriptInventoryResizedEvent extends EventData {
3882
3882
  /**
@@ -3911,7 +3911,7 @@ declare module "factorio:runtime" {
3911
3911
  }
3912
3912
  /**
3913
3913
  * Called when a {@link LuaSurface#request_path LuaSurface::request_path} call completes.
3914
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_script_path_request_finished Online documentation}
3914
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_script_path_request_finished Online documentation}
3915
3915
  */
3916
3916
  interface OnScriptPathRequestFinishedEvent extends EventData {
3917
3917
  /**
@@ -3937,7 +3937,7 @@ declare module "factorio:runtime" {
3937
3937
  }
3938
3938
  /**
3939
3939
  * Called when a script trigger effect is triggered.
3940
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_script_trigger_effect Online documentation}
3940
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_script_trigger_effect Online documentation}
3941
3941
  */
3942
3942
  interface OnScriptTriggerEffectEvent extends EventData {
3943
3943
  /**
@@ -3969,7 +3969,7 @@ declare module "factorio:runtime" {
3969
3969
  * Called when an entity of type `radar` finishes scanning a sector.
3970
3970
  *
3971
3971
  * Event filter: [LuaSectorScannedEventFilter](LuaSectorScannedEventFilter]
3972
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_sector_scanned Online documentation}
3972
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_sector_scanned Online documentation}
3973
3973
  */
3974
3974
  interface OnSectorScannedEvent extends EventData {
3975
3975
  /**
@@ -3995,7 +3995,7 @@ declare module "factorio:runtime" {
3995
3995
  }
3996
3996
  /**
3997
3997
  * Called when an individual segment of a SegmentedUnit is created.
3998
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_segment_entity_created Online documentation}
3998
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_segment_entity_created Online documentation}
3999
3999
  */
4000
4000
  interface OnSegmentEntityCreatedEvent extends EventData {
4001
4001
  readonly entity: LuaEntity
@@ -4010,7 +4010,7 @@ declare module "factorio:runtime" {
4010
4010
  }
4011
4011
  /**
4012
4012
  * Called after the selected entity changes for a given player.
4013
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_selected_entity_changed Online documentation}
4013
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_selected_entity_changed Online documentation}
4014
4014
  */
4015
4015
  interface OnSelectedEntityChangedEvent extends EventData {
4016
4016
  /**
@@ -4034,7 +4034,7 @@ declare module "factorio:runtime" {
4034
4034
  * Called when a space platform builds an entity.
4035
4035
  *
4036
4036
  * Event filter: [LuaPlatformBuiltEntityEventFilter](LuaPlatformBuiltEntityEventFilter]
4037
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_built_entity Online documentation}
4037
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_built_entity Online documentation}
4038
4038
  */
4039
4039
  interface OnSpacePlatformBuiltEntityEvent extends EventData {
4040
4040
  /**
@@ -4064,7 +4064,7 @@ declare module "factorio:runtime" {
4064
4064
  }
4065
4065
  /**
4066
4066
  * Called after a space platform builds tiles.
4067
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_built_tile Online documentation}
4067
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_built_tile Online documentation}
4068
4068
  */
4069
4069
  interface OnSpacePlatformBuiltTileEvent extends EventData {
4070
4070
  /**
@@ -4106,7 +4106,7 @@ declare module "factorio:runtime" {
4106
4106
  }
4107
4107
  /**
4108
4108
  * Called when a space platform changes state
4109
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_changed_state Online documentation}
4109
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_changed_state Online documentation}
4110
4110
  */
4111
4111
  interface OnSpacePlatformChangedStateEvent extends EventData {
4112
4112
  readonly platform: LuaSpacePlatform
@@ -4128,7 +4128,7 @@ declare module "factorio:runtime" {
4128
4128
  * 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.
4129
4129
  *
4130
4130
  * Event filter: [LuaPlatformMinedEntityEventFilter](LuaPlatformMinedEntityEventFilter]
4131
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_mined_entity Online documentation}
4131
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_mined_entity Online documentation}
4132
4132
  */
4133
4133
  interface OnSpacePlatformMinedEntityEvent extends EventData {
4134
4134
  /**
@@ -4154,7 +4154,7 @@ declare module "factorio:runtime" {
4154
4154
  }
4155
4155
  /**
4156
4156
  * Called when a platform mines an entity.
4157
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_mined_item Online documentation}
4157
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_mined_item Online documentation}
4158
4158
  */
4159
4159
  interface OnSpacePlatformMinedItemEvent extends EventData {
4160
4160
  /**
@@ -4176,7 +4176,7 @@ declare module "factorio:runtime" {
4176
4176
  }
4177
4177
  /**
4178
4178
  * Called after a platform mines tiles.
4179
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_mined_tile Online documentation}
4179
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_mined_tile Online documentation}
4180
4180
  */
4181
4181
  interface OnSpacePlatformMinedTileEvent extends EventData {
4182
4182
  /**
@@ -4204,7 +4204,7 @@ declare module "factorio:runtime" {
4204
4204
  * Called before a platform mines an entity.
4205
4205
  *
4206
4206
  * Event filter: [LuaPrePlatformMinedEntityEventFilter](LuaPrePlatformMinedEntityEventFilter]
4207
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_space_platform_pre_mined Online documentation}
4207
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_space_platform_pre_mined Online documentation}
4208
4208
  */
4209
4209
  interface OnSpacePlatformPreMinedEvent extends EventData {
4210
4210
  /**
@@ -4226,7 +4226,7 @@ declare module "factorio:runtime" {
4226
4226
  }
4227
4227
  /**
4228
4228
  * Called when a spider finishes moving to its autopilot position.
4229
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_spider_command_completed Online documentation}
4229
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_spider_command_completed Online documentation}
4230
4230
  */
4231
4231
  interface OnSpiderCommandCompletedEvent extends EventData {
4232
4232
  /**
@@ -4244,7 +4244,7 @@ declare module "factorio:runtime" {
4244
4244
  }
4245
4245
  /**
4246
4246
  * Called when a translation request generated through {@link LuaPlayer#request_translation LuaPlayer::request_translation} or {@link LuaPlayer#request_translations LuaPlayer::request_translations} has been completed.
4247
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_string_translated Online documentation}
4247
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_string_translated Online documentation}
4248
4248
  */
4249
4249
  interface OnStringTranslatedEvent extends EventData {
4250
4250
  /**
@@ -4278,7 +4278,7 @@ declare module "factorio:runtime" {
4278
4278
  }
4279
4279
  /**
4280
4280
  * Called just after a surface is cleared (all entities removed and all chunks deleted).
4281
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_surface_cleared Online documentation}
4281
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_surface_cleared Online documentation}
4282
4282
  */
4283
4283
  interface OnSurfaceClearedEvent extends EventData {
4284
4284
  readonly surface_index: SurfaceIndex
@@ -4295,7 +4295,7 @@ declare module "factorio:runtime" {
4295
4295
  * Called when a surface is created.
4296
4296
  *
4297
4297
  * This is not called when the default surface is created as it will always exist.
4298
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_surface_created Online documentation}
4298
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_surface_created Online documentation}
4299
4299
  */
4300
4300
  interface OnSurfaceCreatedEvent extends EventData {
4301
4301
  readonly surface_index: SurfaceIndex
@@ -4310,7 +4310,7 @@ declare module "factorio:runtime" {
4310
4310
  }
4311
4311
  /**
4312
4312
  * Called after a surface is deleted.
4313
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_surface_deleted Online documentation}
4313
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_surface_deleted Online documentation}
4314
4314
  */
4315
4315
  interface OnSurfaceDeletedEvent extends EventData {
4316
4316
  readonly surface_index: SurfaceIndex
@@ -4325,7 +4325,7 @@ declare module "factorio:runtime" {
4325
4325
  }
4326
4326
  /**
4327
4327
  * Called after a surface is imported via the map editor.
4328
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_surface_imported Online documentation}
4328
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_surface_imported Online documentation}
4329
4329
  */
4330
4330
  interface OnSurfaceImportedEvent extends EventData {
4331
4331
  readonly surface_index: SurfaceIndex
@@ -4344,7 +4344,7 @@ declare module "factorio:runtime" {
4344
4344
  }
4345
4345
  /**
4346
4346
  * Called when a surface is renamed.
4347
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_surface_renamed Online documentation}
4347
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_surface_renamed Online documentation}
4348
4348
  */
4349
4349
  interface OnSurfaceRenamedEvent extends EventData {
4350
4350
  readonly surface_index: SurfaceIndex
@@ -4361,7 +4361,7 @@ declare module "factorio:runtime" {
4361
4361
  }
4362
4362
  /**
4363
4363
  * Called when {@link LuaForce#reset_technology_effects LuaForce::reset_technology_effects} is finished.
4364
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_technology_effects_reset Online documentation}
4364
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_technology_effects_reset Online documentation}
4365
4365
  */
4366
4366
  interface OnTechnologyEffectsResetEvent extends EventData {
4367
4367
  readonly force: LuaForce
@@ -4376,7 +4376,7 @@ declare module "factorio:runtime" {
4376
4376
  }
4377
4377
  /**
4378
4378
  * It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
4379
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_tick Online documentation}
4379
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_tick Online documentation}
4380
4380
  */
4381
4381
  interface OnTickEvent extends EventData {
4382
4382
  /**
@@ -4390,7 +4390,7 @@ declare module "factorio:runtime" {
4390
4390
  }
4391
4391
  /**
4392
4392
  * Called when a train changes state (started to stopped and vice versa)
4393
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_train_changed_state Online documentation}
4393
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_train_changed_state Online documentation}
4394
4394
  */
4395
4395
  interface OnTrainChangedStateEvent extends EventData {
4396
4396
  readonly train: LuaTrain
@@ -4406,7 +4406,7 @@ declare module "factorio:runtime" {
4406
4406
  }
4407
4407
  /**
4408
4408
  * Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
4409
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_train_created Online documentation}
4409
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_train_created Online documentation}
4410
4410
  */
4411
4411
  interface OnTrainCreatedEvent extends EventData {
4412
4412
  readonly train: LuaTrain
@@ -4429,7 +4429,7 @@ declare module "factorio:runtime" {
4429
4429
  }
4430
4430
  /**
4431
4431
  * Called when a trains schedule is changed either by the player or through script.
4432
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_train_schedule_changed Online documentation}
4432
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_train_schedule_changed Online documentation}
4433
4433
  */
4434
4434
  interface OnTrainScheduleChangedEvent extends EventData {
4435
4435
  readonly train: LuaTrain
@@ -4448,7 +4448,7 @@ declare module "factorio:runtime" {
4448
4448
  }
4449
4449
  /**
4450
4450
  * Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity=true`.
4451
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_trigger_created_entity Online documentation}
4451
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_trigger_created_entity Online documentation}
4452
4452
  */
4453
4453
  interface OnTriggerCreatedEntityEvent extends EventData {
4454
4454
  readonly entity: LuaEntity
@@ -4464,7 +4464,7 @@ declare module "factorio:runtime" {
4464
4464
  }
4465
4465
  /**
4466
4466
  * Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery=true`.
4467
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_trigger_fired_artillery Online documentation}
4467
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_trigger_fired_artillery Online documentation}
4468
4468
  */
4469
4469
  interface OnTriggerFiredArtilleryEvent extends EventData {
4470
4470
  readonly entity: LuaEntity
@@ -4480,7 +4480,7 @@ declare module "factorio:runtime" {
4480
4480
  }
4481
4481
  /**
4482
4482
  * Called when the player triggers "undo".
4483
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_undo_applied Online documentation}
4483
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_undo_applied Online documentation}
4484
4484
  */
4485
4485
  interface OnUndoAppliedEvent extends EventData {
4486
4486
  /**
@@ -4502,7 +4502,7 @@ declare module "factorio:runtime" {
4502
4502
  }
4503
4503
  /**
4504
4504
  * Called when a unit is added to a unit group.
4505
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_unit_added_to_group Online documentation}
4505
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_unit_added_to_group Online documentation}
4506
4506
  */
4507
4507
  interface OnUnitAddedToGroupEvent extends EventData {
4508
4508
  readonly unit: LuaEntity
@@ -4518,7 +4518,7 @@ declare module "factorio:runtime" {
4518
4518
  }
4519
4519
  /**
4520
4520
  * Called when a new unit group is created, before any members are added to it.
4521
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_unit_group_created Online documentation}
4521
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_unit_group_created Online documentation}
4522
4522
  */
4523
4523
  interface OnUnitGroupCreatedEvent extends EventData {
4524
4524
  readonly group: LuaCommandable
@@ -4533,7 +4533,7 @@ declare module "factorio:runtime" {
4533
4533
  }
4534
4534
  /**
4535
4535
  * Called when a unit group finishes gathering and starts executing its command.
4536
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_unit_group_finished_gathering Online documentation}
4536
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_unit_group_finished_gathering Online documentation}
4537
4537
  */
4538
4538
  interface OnUnitGroupFinishedGatheringEvent extends EventData {
4539
4539
  readonly group: LuaCommandable
@@ -4548,7 +4548,7 @@ declare module "factorio:runtime" {
4548
4548
  }
4549
4549
  /**
4550
4550
  * Called when a unit is removed from a unit group.
4551
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_unit_removed_from_group Online documentation}
4551
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_unit_removed_from_group Online documentation}
4552
4552
  */
4553
4553
  interface OnUnitRemovedFromGroupEvent extends EventData {
4554
4554
  readonly unit: LuaEntity
@@ -4564,7 +4564,7 @@ declare module "factorio:runtime" {
4564
4564
  }
4565
4565
  /**
4566
4566
  * Called when a worker (construction or logistic) robot expires through a lack of energy.
4567
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#on_worker_robot_expired Online documentation}
4567
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#on_worker_robot_expired Online documentation}
4568
4568
  */
4569
4569
  interface OnWorkerRobotExpiredEvent extends EventData {
4570
4570
  readonly robot: LuaEntity
@@ -4581,7 +4581,7 @@ declare module "factorio:runtime" {
4581
4581
  * 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}.
4582
4582
  *
4583
4583
  * Event filter: [LuaScriptRaisedBuiltEventFilter](LuaScriptRaisedBuiltEventFilter]
4584
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#script_raised_built Online documentation}
4584
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#script_raised_built Online documentation}
4585
4585
  */
4586
4586
  interface ScriptRaisedBuiltEvent extends EventData {
4587
4587
  /**
@@ -4601,7 +4601,7 @@ declare module "factorio:runtime" {
4601
4601
  * 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}.
4602
4602
  *
4603
4603
  * Event filter: [LuaScriptRaisedDestroyEventFilter](LuaScriptRaisedDestroyEventFilter]
4604
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#script_raised_destroy Online documentation}
4604
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#script_raised_destroy Online documentation}
4605
4605
  */
4606
4606
  interface ScriptRaisedDestroyEvent extends EventData {
4607
4607
  /**
@@ -4621,7 +4621,7 @@ declare module "factorio:runtime" {
4621
4621
  * 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}.
4622
4622
  *
4623
4623
  * Event filter: [LuaScriptRaisedReviveEventFilter](LuaScriptRaisedReviveEventFilter]
4624
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#script_raised_revive Online documentation}
4624
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#script_raised_revive Online documentation}
4625
4625
  */
4626
4626
  interface ScriptRaisedReviveEvent extends EventData {
4627
4627
  /**
@@ -4643,7 +4643,7 @@ declare module "factorio:runtime" {
4643
4643
  }
4644
4644
  /**
4645
4645
  * 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}.
4646
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#script_raised_set_tiles Online documentation}
4646
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#script_raised_set_tiles Online documentation}
4647
4647
  */
4648
4648
  interface ScriptRaisedSetTilesEvent extends EventData {
4649
4649
  /**
@@ -4667,7 +4667,7 @@ declare module "factorio:runtime" {
4667
4667
  * A static event mods can use to tell other mods they teleported something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_teleported LuaBootstrap::raise_script_teleported}, or when `raise_teleported` is passed to {@link LuaControl#teleport LuaControl::teleport}.
4668
4668
  *
4669
4669
  * Event filter: [LuaScriptRaisedTeleportedEventFilter](LuaScriptRaisedTeleportedEventFilter]
4670
- * @see {@link https://lua-api.factorio.com/2.0.16/events.html#script_raised_teleported Online documentation}
4670
+ * @see {@link https://lua-api.factorio.com/2.0.17/events.html#script_raised_teleported Online documentation}
4671
4671
  */
4672
4672
  interface ScriptRaisedTeleportedEvent extends EventData {
4673
4673
  /**