typed-factorio 0.18.1 → 0.20.0-beta.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -15,7 +15,7 @@ declare namespace defines {
15
15
  train_out_of_fuel,
16
16
  }
17
17
  /**
18
- * AI command exit status. See {@link LuaEntity.set_command LuaEntity::set_command}
18
+ * AI command exit status. See {@link LuaEntity#set_command LuaEntity::set_command}
19
19
  *
20
20
  * {@link https://lua-api.factorio.com/latest/defines.html#defines.behavior_result View documentation}
21
21
  */
@@ -528,8 +528,7 @@ declare namespace defines {
528
528
  */
529
529
  fluid_ingredient_shortage,
530
530
  /**
531
- * Used by crafting machines, boilers, burner energy sources and reactors: Reactor/burner has full burnt result
532
- * inventory, boiler has full output fluidbox.
531
+ * Used by crafting machines, boilers, burner energy sources and reactors: Reactor/burner has full burnt result inventory, boiler has full output fluidbox.
533
532
  *
534
533
  * {@link https://lua-api.factorio.com/latest/defines.html#defines.entity_status.full_output View documentation}
535
534
  */
@@ -644,21 +643,30 @@ declare namespace defines {
644
643
  cant_divide_segments,
645
644
  }
646
645
  /**
647
- * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain
648
- * and when they get raised.
646
+ * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
649
647
  *
650
648
  * {@link https://lua-api.factorio.com/latest/defines.html#defines.events View documentation}
651
649
  */
652
650
  namespace events {
653
- /** Event type: {@link OnTickEvent} */
651
+ /**
652
+ * Event type: {@link OnTickEvent}
653
+ */
654
654
  const on_tick: EventId<OnTickEvent>
655
- /** Event type: {@link OnGuiClickEvent} */
655
+ /**
656
+ * Event type: {@link OnGuiClickEvent}
657
+ */
656
658
  const on_gui_click: EventId<OnGuiClickEvent>
657
- /** Event type: {@link OnGuiConfirmedEvent} */
659
+ /**
660
+ * Event type: {@link OnGuiConfirmedEvent}
661
+ */
658
662
  const on_gui_confirmed: EventId<OnGuiConfirmedEvent>
659
- /** Event type: {@link OnGuiTextChangedEvent} */
663
+ /**
664
+ * Event type: {@link OnGuiTextChangedEvent}
665
+ */
660
666
  const on_gui_text_changed: EventId<OnGuiTextChangedEvent>
661
- /** Event type: {@link OnGuiCheckedStateChangedEvent} */
667
+ /**
668
+ * Event type: {@link OnGuiCheckedStateChangedEvent}
669
+ */
662
670
  const on_gui_checked_state_changed: EventId<OnGuiCheckedStateChangedEvent>
663
671
  /**
664
672
  * Event type: {@link OnEntityDiedEvent}
@@ -678,7 +686,9 @@ declare namespace defines {
678
686
  * Event filter: {@link LuaEntityDamagedEventFilter}
679
687
  */
680
688
  const on_entity_damaged: EventId<OnEntityDamagedEvent, LuaEntityDamagedEventFilter>
681
- /** Event type: {@link OnPickedUpItemEvent} */
689
+ /**
690
+ * Event type: {@link OnPickedUpItemEvent}
691
+ */
682
692
  const on_picked_up_item: EventId<OnPickedUpItemEvent>
683
693
  /**
684
694
  * Event type: {@link OnBuiltEntityEvent}
@@ -692,11 +702,17 @@ declare namespace defines {
692
702
  * Event filter: {@link LuaSectorScannedEventFilter}
693
703
  */
694
704
  const on_sector_scanned: EventId<OnSectorScannedEvent, LuaSectorScannedEventFilter>
695
- /** Event type: {@link OnPlayerMinedItemEvent} */
705
+ /**
706
+ * Event type: {@link OnPlayerMinedItemEvent}
707
+ */
696
708
  const on_player_mined_item: EventId<OnPlayerMinedItemEvent>
697
- /** Event type: {@link OnPreBuildEvent} */
709
+ /**
710
+ * Event type: {@link OnPreBuildEvent}
711
+ */
698
712
  const on_pre_build: EventId<OnPreBuildEvent>
699
- /** Event type: {@link OnRocketLaunchedEvent} */
713
+ /**
714
+ * Event type: {@link OnRocketLaunchedEvent}
715
+ */
700
716
  const on_rocket_launched: EventId<OnRocketLaunchedEvent>
701
717
  /**
702
718
  * Event type: {@link OnPrePlayerMinedItemEvent}
@@ -704,9 +720,13 @@ declare namespace defines {
704
720
  * Event filter: {@link LuaPrePlayerMinedEntityEventFilter}
705
721
  */
706
722
  const on_pre_player_mined_item: EventId<OnPrePlayerMinedItemEvent, LuaPrePlayerMinedEntityEventFilter>
707
- /** Event type: {@link OnChunkGeneratedEvent} */
723
+ /**
724
+ * Event type: {@link OnChunkGeneratedEvent}
725
+ */
708
726
  const on_chunk_generated: EventId<OnChunkGeneratedEvent>
709
- /** Event type: {@link OnPlayerCraftedItemEvent} */
727
+ /**
728
+ * Event type: {@link OnPlayerCraftedItemEvent}
729
+ */
710
730
  const on_player_crafted_item: EventId<OnPlayerCraftedItemEvent>
711
731
  /**
712
732
  * Event type: {@link OnRobotBuiltEntityEvent}
@@ -720,15 +740,25 @@ declare namespace defines {
720
740
  * Event filter: {@link LuaPreRobotMinedEntityEventFilter}
721
741
  */
722
742
  const on_robot_pre_mined: EventId<OnRobotPreMinedEvent, LuaPreRobotMinedEntityEventFilter>
723
- /** Event type: {@link OnRobotMinedEvent} */
743
+ /**
744
+ * Event type: {@link OnRobotMinedEvent}
745
+ */
724
746
  const on_robot_mined: EventId<OnRobotMinedEvent>
725
- /** Event type: {@link OnResearchStartedEvent} */
747
+ /**
748
+ * Event type: {@link OnResearchStartedEvent}
749
+ */
726
750
  const on_research_started: EventId<OnResearchStartedEvent>
727
- /** Event type: {@link OnResearchFinishedEvent} */
751
+ /**
752
+ * Event type: {@link OnResearchFinishedEvent}
753
+ */
728
754
  const on_research_finished: EventId<OnResearchFinishedEvent>
729
- /** Event type: {@link OnResearchReversedEvent} */
755
+ /**
756
+ * Event type: {@link OnResearchReversedEvent}
757
+ */
730
758
  const on_research_reversed: EventId<OnResearchReversedEvent>
731
- /** Event type: {@link OnPlayerRotatedEntityEvent} */
759
+ /**
760
+ * Event type: {@link OnPlayerRotatedEntityEvent}
761
+ */
732
762
  const on_player_rotated_entity: EventId<OnPlayerRotatedEntityEvent>
733
763
  /**
734
764
  * Event type: {@link OnMarkedForDeconstructionEvent}
@@ -748,87 +778,169 @@ declare namespace defines {
748
778
  OnCancelledDeconstructionEvent,
749
779
  LuaEntityDeconstructionCancelledEventFilter
750
780
  >
751
- /** Event type: {@link OnTriggerCreatedEntityEvent} */
781
+ /**
782
+ * Event type: {@link OnTriggerCreatedEntityEvent}
783
+ */
752
784
  const on_trigger_created_entity: EventId<OnTriggerCreatedEntityEvent>
753
- /** Event type: {@link OnTriggerFiredArtilleryEvent} */
785
+ /**
786
+ * Event type: {@link OnTriggerFiredArtilleryEvent}
787
+ */
754
788
  const on_trigger_fired_artillery: EventId<OnTriggerFiredArtilleryEvent>
755
- /** Event type: {@link OnTrainChangedStateEvent} */
789
+ /**
790
+ * Event type: {@link OnTrainChangedStateEvent}
791
+ */
756
792
  const on_train_changed_state: EventId<OnTrainChangedStateEvent>
757
- /** Event type: {@link OnPlayerCreatedEvent} */
793
+ /**
794
+ * Event type: {@link OnPlayerCreatedEvent}
795
+ */
758
796
  const on_player_created: EventId<OnPlayerCreatedEvent>
759
- /** Event type: {@link OnResourceDepletedEvent} */
797
+ /**
798
+ * Event type: {@link OnResourceDepletedEvent}
799
+ */
760
800
  const on_resource_depleted: EventId<OnResourceDepletedEvent>
761
- /** Event type: {@link OnPlayerDrivingChangedStateEvent} */
801
+ /**
802
+ * Event type: {@link OnPlayerDrivingChangedStateEvent}
803
+ */
762
804
  const on_player_driving_changed_state: EventId<OnPlayerDrivingChangedStateEvent>
763
- /** Event type: {@link OnForceCreatedEvent} */
805
+ /**
806
+ * Event type: {@link OnForceCreatedEvent}
807
+ */
764
808
  const on_force_created: EventId<OnForceCreatedEvent>
765
- /** Event type: {@link OnForcesMergingEvent} */
809
+ /**
810
+ * Event type: {@link OnForcesMergingEvent}
811
+ */
766
812
  const on_forces_merging: EventId<OnForcesMergingEvent>
767
- /** Event type: {@link OnPlayerCursorStackChangedEvent} */
813
+ /**
814
+ * Event type: {@link OnPlayerCursorStackChangedEvent}
815
+ */
768
816
  const on_player_cursor_stack_changed: EventId<OnPlayerCursorStackChangedEvent>
769
- /** Event type: {@link OnPreEntitySettingsPastedEvent} */
817
+ /**
818
+ * Event type: {@link OnPreEntitySettingsPastedEvent}
819
+ */
770
820
  const on_pre_entity_settings_pasted: EventId<OnPreEntitySettingsPastedEvent>
771
- /** Event type: {@link OnEntitySettingsPastedEvent} */
821
+ /**
822
+ * Event type: {@link OnEntitySettingsPastedEvent}
823
+ */
772
824
  const on_entity_settings_pasted: EventId<OnEntitySettingsPastedEvent>
773
- /** Event type: {@link OnPlayerMainInventoryChangedEvent} */
825
+ /**
826
+ * Event type: {@link OnPlayerMainInventoryChangedEvent}
827
+ */
774
828
  const on_player_main_inventory_changed: EventId<OnPlayerMainInventoryChangedEvent>
775
- /** Event type: {@link OnPlayerArmorInventoryChangedEvent} */
829
+ /**
830
+ * Event type: {@link OnPlayerArmorInventoryChangedEvent}
831
+ */
776
832
  const on_player_armor_inventory_changed: EventId<OnPlayerArmorInventoryChangedEvent>
777
- /** Event type: {@link OnPlayerAmmoInventoryChangedEvent} */
833
+ /**
834
+ * Event type: {@link OnPlayerAmmoInventoryChangedEvent}
835
+ */
778
836
  const on_player_ammo_inventory_changed: EventId<OnPlayerAmmoInventoryChangedEvent>
779
- /** Event type: {@link OnPlayerGunInventoryChangedEvent} */
837
+ /**
838
+ * Event type: {@link OnPlayerGunInventoryChangedEvent}
839
+ */
780
840
  const on_player_gun_inventory_changed: EventId<OnPlayerGunInventoryChangedEvent>
781
- /** Event type: {@link OnPlayerPlacedEquipmentEvent} */
841
+ /**
842
+ * Event type: {@link OnPlayerPlacedEquipmentEvent}
843
+ */
782
844
  const on_player_placed_equipment: EventId<OnPlayerPlacedEquipmentEvent>
783
- /** Event type: {@link OnPlayerRemovedEquipmentEvent} */
845
+ /**
846
+ * Event type: {@link OnPlayerRemovedEquipmentEvent}
847
+ */
784
848
  const on_player_removed_equipment: EventId<OnPlayerRemovedEquipmentEvent>
785
- /** Event type: {@link OnPrePlayerDiedEvent} */
849
+ /**
850
+ * Event type: {@link OnPrePlayerDiedEvent}
851
+ */
786
852
  const on_pre_player_died: EventId<OnPrePlayerDiedEvent>
787
- /** Event type: {@link OnPlayerDiedEvent} */
853
+ /**
854
+ * Event type: {@link OnPlayerDiedEvent}
855
+ */
788
856
  const on_player_died: EventId<OnPlayerDiedEvent>
789
- /** Event type: {@link OnPlayerRespawnedEvent} */
857
+ /**
858
+ * Event type: {@link OnPlayerRespawnedEvent}
859
+ */
790
860
  const on_player_respawned: EventId<OnPlayerRespawnedEvent>
791
- /** Event type: {@link OnPlayerJoinedGameEvent} */
861
+ /**
862
+ * Event type: {@link OnPlayerJoinedGameEvent}
863
+ */
792
864
  const on_player_joined_game: EventId<OnPlayerJoinedGameEvent>
793
- /** Event type: {@link OnPlayerLeftGameEvent} */
865
+ /**
866
+ * Event type: {@link OnPlayerLeftGameEvent}
867
+ */
794
868
  const on_player_left_game: EventId<OnPlayerLeftGameEvent>
795
- /** Event type: {@link OnPlayerBuiltTileEvent} */
869
+ /**
870
+ * Event type: {@link OnPlayerBuiltTileEvent}
871
+ */
796
872
  const on_player_built_tile: EventId<OnPlayerBuiltTileEvent>
797
- /** Event type: {@link OnPlayerMinedTileEvent} */
873
+ /**
874
+ * Event type: {@link OnPlayerMinedTileEvent}
875
+ */
798
876
  const on_player_mined_tile: EventId<OnPlayerMinedTileEvent>
799
- /** Event type: {@link OnRobotBuiltTileEvent} */
877
+ /**
878
+ * Event type: {@link OnRobotBuiltTileEvent}
879
+ */
800
880
  const on_robot_built_tile: EventId<OnRobotBuiltTileEvent>
801
- /** Event type: {@link OnRobotMinedTileEvent} */
881
+ /**
882
+ * Event type: {@link OnRobotMinedTileEvent}
883
+ */
802
884
  const on_robot_mined_tile: EventId<OnRobotMinedTileEvent>
803
- /** Event type: {@link OnPlayerSelectedAreaEvent} */
885
+ /**
886
+ * Event type: {@link OnPlayerSelectedAreaEvent}
887
+ */
804
888
  const on_player_selected_area: EventId<OnPlayerSelectedAreaEvent>
805
- /** Event type: {@link OnPlayerAltSelectedAreaEvent} */
889
+ /**
890
+ * Event type: {@link OnPlayerAltSelectedAreaEvent}
891
+ */
806
892
  const on_player_alt_selected_area: EventId<OnPlayerAltSelectedAreaEvent>
807
- /** Event type: {@link OnPlayerChangedSurfaceEvent} */
893
+ /**
894
+ * Event type: {@link OnPlayerChangedSurfaceEvent}
895
+ */
808
896
  const on_player_changed_surface: EventId<OnPlayerChangedSurfaceEvent>
809
- /** Event type: {@link OnSelectedEntityChangedEvent} */
897
+ /**
898
+ * Event type: {@link OnSelectedEntityChangedEvent}
899
+ */
810
900
  const on_selected_entity_changed: EventId<OnSelectedEntityChangedEvent>
811
- /** Event type: {@link OnMarketItemPurchasedEvent} */
901
+ /**
902
+ * Event type: {@link OnMarketItemPurchasedEvent}
903
+ */
812
904
  const on_market_item_purchased: EventId<OnMarketItemPurchasedEvent>
813
- /** Event type: {@link OnPlayerDroppedItemEvent} */
905
+ /**
906
+ * Event type: {@link OnPlayerDroppedItemEvent}
907
+ */
814
908
  const on_player_dropped_item: EventId<OnPlayerDroppedItemEvent>
815
- /** Event type: {@link OnBiterBaseBuiltEvent} */
909
+ /**
910
+ * Event type: {@link OnBiterBaseBuiltEvent}
911
+ */
816
912
  const on_biter_base_built: EventId<OnBiterBaseBuiltEvent>
817
- /** Event type: {@link OnPlayerChangedForceEvent} */
913
+ /**
914
+ * Event type: {@link OnPlayerChangedForceEvent}
915
+ */
818
916
  const on_player_changed_force: EventId<OnPlayerChangedForceEvent>
819
- /** Event type: {@link OnEntityRenamedEvent} */
917
+ /**
918
+ * Event type: {@link OnEntityRenamedEvent}
919
+ */
820
920
  const on_entity_renamed: EventId<OnEntityRenamedEvent>
821
- /** Event type: {@link OnGuiSelectionStateChangedEvent} */
921
+ /**
922
+ * Event type: {@link OnGuiSelectionStateChangedEvent}
923
+ */
822
924
  const on_gui_selection_state_changed: EventId<OnGuiSelectionStateChangedEvent>
823
- /** Event type: {@link OnRuntimeModSettingChangedEvent} */
925
+ /**
926
+ * Event type: {@link OnRuntimeModSettingChangedEvent}
927
+ */
824
928
  const on_runtime_mod_setting_changed: EventId<OnRuntimeModSettingChangedEvent>
825
- /** Event type: {@link OnDifficultySettingsChangedEvent} */
929
+ /**
930
+ * Event type: {@link OnDifficultySettingsChangedEvent}
931
+ */
826
932
  const on_difficulty_settings_changed: EventId<OnDifficultySettingsChangedEvent>
827
- /** Event type: {@link OnSurfaceCreatedEvent} */
933
+ /**
934
+ * Event type: {@link OnSurfaceCreatedEvent}
935
+ */
828
936
  const on_surface_created: EventId<OnSurfaceCreatedEvent>
829
- /** Event type: {@link OnSurfaceDeletedEvent} */
937
+ /**
938
+ * Event type: {@link OnSurfaceDeletedEvent}
939
+ */
830
940
  const on_surface_deleted: EventId<OnSurfaceDeletedEvent>
831
- /** Event type: {@link OnPreSurfaceDeletedEvent} */
941
+ /**
942
+ * Event type: {@link OnPreSurfaceDeletedEvent}
943
+ */
832
944
  const on_pre_surface_deleted: EventId<OnPreSurfaceDeletedEvent>
833
945
  /**
834
946
  * Event type: {@link OnPlayerMinedEntityEvent}
@@ -842,25 +954,45 @@ declare namespace defines {
842
954
  * Event filter: {@link LuaRobotMinedEntityEventFilter}
843
955
  */
844
956
  const on_robot_mined_entity: EventId<OnRobotMinedEntityEvent, LuaRobotMinedEntityEventFilter>
845
- /** Event type: {@link OnTrainCreatedEvent} */
957
+ /**
958
+ * Event type: {@link OnTrainCreatedEvent}
959
+ */
846
960
  const on_train_created: EventId<OnTrainCreatedEvent>
847
- /** Event type: {@link OnGuiElemChangedEvent} */
961
+ /**
962
+ * Event type: {@link OnGuiElemChangedEvent}
963
+ */
848
964
  const on_gui_elem_changed: EventId<OnGuiElemChangedEvent>
849
- /** Event type: {@link OnPlayerSetupBlueprintEvent} */
965
+ /**
966
+ * Event type: {@link OnPlayerSetupBlueprintEvent}
967
+ */
850
968
  const on_player_setup_blueprint: EventId<OnPlayerSetupBlueprintEvent>
851
- /** Event type: {@link OnPlayerDeconstructedAreaEvent} */
969
+ /**
970
+ * Event type: {@link OnPlayerDeconstructedAreaEvent}
971
+ */
852
972
  const on_player_deconstructed_area: EventId<OnPlayerDeconstructedAreaEvent>
853
- /** Event type: {@link OnPlayerConfiguredBlueprintEvent} */
973
+ /**
974
+ * Event type: {@link OnPlayerConfiguredBlueprintEvent}
975
+ */
854
976
  const on_player_configured_blueprint: EventId<OnPlayerConfiguredBlueprintEvent>
855
- /** Event type: {@link OnConsoleChatEvent} */
977
+ /**
978
+ * Event type: {@link OnConsoleChatEvent}
979
+ */
856
980
  const on_console_chat: EventId<OnConsoleChatEvent>
857
- /** Event type: {@link OnConsoleCommandEvent} */
981
+ /**
982
+ * Event type: {@link OnConsoleCommandEvent}
983
+ */
858
984
  const on_console_command: EventId<OnConsoleCommandEvent>
859
- /** Event type: {@link OnPlayerRemovedEvent} */
985
+ /**
986
+ * Event type: {@link OnPlayerRemovedEvent}
987
+ */
860
988
  const on_player_removed: EventId<OnPlayerRemovedEvent>
861
- /** Event type: {@link OnPrePlayerRemovedEvent} */
989
+ /**
990
+ * Event type: {@link OnPrePlayerRemovedEvent}
991
+ */
862
992
  const on_pre_player_removed: EventId<OnPrePlayerRemovedEvent>
863
- /** Event type: {@link OnPlayerUsedCapsuleEvent} */
993
+ /**
994
+ * Event type: {@link OnPlayerUsedCapsuleEvent}
995
+ */
864
996
  const on_player_used_capsule: EventId<OnPlayerUsedCapsuleEvent>
865
997
  /**
866
998
  * Event type: {@link ScriptRaisedBuiltEvent}
@@ -880,35 +1012,65 @@ declare namespace defines {
880
1012
  * Event filter: {@link LuaScriptRaisedReviveEventFilter}
881
1013
  */
882
1014
  const script_raised_revive: EventId<ScriptRaisedReviveEvent, LuaScriptRaisedReviveEventFilter>
883
- /** Event type: {@link ScriptRaisedSetTilesEvent} */
1015
+ /**
1016
+ * Event type: {@link ScriptRaisedSetTilesEvent}
1017
+ */
884
1018
  const script_raised_set_tiles: EventId<ScriptRaisedSetTilesEvent>
885
- /** Event type: {@link OnPlayerPromotedEvent} */
1019
+ /**
1020
+ * Event type: {@link OnPlayerPromotedEvent}
1021
+ */
886
1022
  const on_player_promoted: EventId<OnPlayerPromotedEvent>
887
- /** Event type: {@link OnPlayerDemotedEvent} */
1023
+ /**
1024
+ * Event type: {@link OnPlayerDemotedEvent}
1025
+ */
888
1026
  const on_player_demoted: EventId<OnPlayerDemotedEvent>
889
- /** Event type: {@link OnCombatRobotExpiredEvent} */
1027
+ /**
1028
+ * Event type: {@link OnCombatRobotExpiredEvent}
1029
+ */
890
1030
  const on_combat_robot_expired: EventId<OnCombatRobotExpiredEvent>
891
- /** Event type: {@link OnWorkerRobotExpiredEvent} */
1031
+ /**
1032
+ * Event type: {@link OnWorkerRobotExpiredEvent}
1033
+ */
892
1034
  const on_worker_robot_expired: EventId<OnWorkerRobotExpiredEvent>
893
- /** Event type: {@link OnPlayerChangedPositionEvent} */
1035
+ /**
1036
+ * Event type: {@link OnPlayerChangedPositionEvent}
1037
+ */
894
1038
  const on_player_changed_position: EventId<OnPlayerChangedPositionEvent>
895
- /** Event type: {@link OnModItemOpenedEvent} */
1039
+ /**
1040
+ * Event type: {@link OnModItemOpenedEvent}
1041
+ */
896
1042
  const on_mod_item_opened: EventId<OnModItemOpenedEvent>
897
- /** Event type: {@link OnGuiOpenedEvent} */
1043
+ /**
1044
+ * Event type: {@link OnGuiOpenedEvent}
1045
+ */
898
1046
  const on_gui_opened: EventId<OnGuiOpenedEvent>
899
- /** Event type: {@link OnGuiClosedEvent} */
1047
+ /**
1048
+ * Event type: {@link OnGuiClosedEvent}
1049
+ */
900
1050
  const on_gui_closed: EventId<OnGuiClosedEvent>
901
- /** Event type: {@link OnGuiValueChangedEvent} */
1051
+ /**
1052
+ * Event type: {@link OnGuiValueChangedEvent}
1053
+ */
902
1054
  const on_gui_value_changed: EventId<OnGuiValueChangedEvent>
903
- /** Event type: {@link OnPlayerMutedEvent} */
1055
+ /**
1056
+ * Event type: {@link OnPlayerMutedEvent}
1057
+ */
904
1058
  const on_player_muted: EventId<OnPlayerMutedEvent>
905
- /** Event type: {@link OnPlayerUnmutedEvent} */
1059
+ /**
1060
+ * Event type: {@link OnPlayerUnmutedEvent}
1061
+ */
906
1062
  const on_player_unmuted: EventId<OnPlayerUnmutedEvent>
907
- /** Event type: {@link OnPlayerCheatModeEnabledEvent} */
1063
+ /**
1064
+ * Event type: {@link OnPlayerCheatModeEnabledEvent}
1065
+ */
908
1066
  const on_player_cheat_mode_enabled: EventId<OnPlayerCheatModeEnabledEvent>
909
- /** Event type: {@link OnPlayerCheatModeDisabledEvent} */
1067
+ /**
1068
+ * Event type: {@link OnPlayerCheatModeDisabledEvent}
1069
+ */
910
1070
  const on_player_cheat_mode_disabled: EventId<OnPlayerCheatModeDisabledEvent>
911
- /** Event type: {@link OnCharacterCorpseExpiredEvent} */
1071
+ /**
1072
+ * Event type: {@link OnCharacterCorpseExpiredEvent}
1073
+ */
912
1074
  const on_character_corpse_expired: EventId<OnCharacterCorpseExpiredEvent>
913
1075
  /**
914
1076
  * Event type: {@link OnPreGhostDeconstructedEvent}
@@ -916,51 +1078,97 @@ declare namespace defines {
916
1078
  * Event filter: {@link LuaPreGhostDeconstructedEventFilter}
917
1079
  */
918
1080
  const on_pre_ghost_deconstructed: EventId<OnPreGhostDeconstructedEvent, LuaPreGhostDeconstructedEventFilter>
919
- /** Event type: {@link OnPlayerPipetteEvent} */
1081
+ /**
1082
+ * Event type: {@link OnPlayerPipetteEvent}
1083
+ */
920
1084
  const on_player_pipette: EventId<OnPlayerPipetteEvent>
921
- /** Event type: {@link OnPlayerDisplayResolutionChangedEvent} */
1085
+ /**
1086
+ * Event type: {@link OnPlayerDisplayResolutionChangedEvent}
1087
+ */
922
1088
  const on_player_display_resolution_changed: EventId<OnPlayerDisplayResolutionChangedEvent>
923
- /** Event type: {@link OnPlayerDisplayScaleChangedEvent} */
1089
+ /**
1090
+ * Event type: {@link OnPlayerDisplayScaleChangedEvent}
1091
+ */
924
1092
  const on_player_display_scale_changed: EventId<OnPlayerDisplayScaleChangedEvent>
925
- /** Event type: {@link OnPrePlayerCraftedItemEvent} */
1093
+ /**
1094
+ * Event type: {@link OnPrePlayerCraftedItemEvent}
1095
+ */
926
1096
  const on_pre_player_crafted_item: EventId<OnPrePlayerCraftedItemEvent>
927
- /** Event type: {@link OnPlayerCancelledCraftingEvent} */
1097
+ /**
1098
+ * Event type: {@link OnPlayerCancelledCraftingEvent}
1099
+ */
928
1100
  const on_player_cancelled_crafting: EventId<OnPlayerCancelledCraftingEvent>
929
- /** Event type: {@link OnChunkChartedEvent} */
1101
+ /**
1102
+ * Event type: {@link OnChunkChartedEvent}
1103
+ */
930
1104
  const on_chunk_charted: EventId<OnChunkChartedEvent>
931
- /** Event type: {@link OnTechnologyEffectsResetEvent} */
1105
+ /**
1106
+ * Event type: {@link OnTechnologyEffectsResetEvent}
1107
+ */
932
1108
  const on_technology_effects_reset: EventId<OnTechnologyEffectsResetEvent>
933
- /** Event type: {@link OnForceResetEvent} */
1109
+ /**
1110
+ * Event type: {@link OnForceResetEvent}
1111
+ */
934
1112
  const on_force_reset: EventId<OnForceResetEvent>
935
- /** Event type: {@link OnLandMineArmedEvent} */
1113
+ /**
1114
+ * Event type: {@link OnLandMineArmedEvent}
1115
+ */
936
1116
  const on_land_mine_armed: EventId<OnLandMineArmedEvent>
937
- /** Event type: {@link OnForcesMergedEvent} */
1117
+ /**
1118
+ * Event type: {@link OnForcesMergedEvent}
1119
+ */
938
1120
  const on_forces_merged: EventId<OnForcesMergedEvent>
939
- /** Event type: {@link OnPlayerTrashInventoryChangedEvent} */
1121
+ /**
1122
+ * Event type: {@link OnPlayerTrashInventoryChangedEvent}
1123
+ */
940
1124
  const on_player_trash_inventory_changed: EventId<OnPlayerTrashInventoryChangedEvent>
941
- /** Event type: {@link OnPrePlayerLeftGameEvent} */
1125
+ /**
1126
+ * Event type: {@link OnPrePlayerLeftGameEvent}
1127
+ */
942
1128
  const on_pre_player_left_game: EventId<OnPrePlayerLeftGameEvent>
943
- /** Event type: {@link OnPreSurfaceClearedEvent} */
1129
+ /**
1130
+ * Event type: {@link OnPreSurfaceClearedEvent}
1131
+ */
944
1132
  const on_pre_surface_cleared: EventId<OnPreSurfaceClearedEvent>
945
- /** Event type: {@link OnSurfaceClearedEvent} */
1133
+ /**
1134
+ * Event type: {@link OnSurfaceClearedEvent}
1135
+ */
946
1136
  const on_surface_cleared: EventId<OnSurfaceClearedEvent>
947
- /** Event type: {@link OnChunkDeletedEvent} */
1137
+ /**
1138
+ * Event type: {@link OnChunkDeletedEvent}
1139
+ */
948
1140
  const on_chunk_deleted: EventId<OnChunkDeletedEvent>
949
- /** Event type: {@link OnPreChunkDeletedEvent} */
1141
+ /**
1142
+ * Event type: {@link OnPreChunkDeletedEvent}
1143
+ */
950
1144
  const on_pre_chunk_deleted: EventId<OnPreChunkDeletedEvent>
951
- /** Event type: {@link OnTrainScheduleChangedEvent} */
1145
+ /**
1146
+ * Event type: {@link OnTrainScheduleChangedEvent}
1147
+ */
952
1148
  const on_train_schedule_changed: EventId<OnTrainScheduleChangedEvent>
953
- /** Event type: {@link OnPlayerBannedEvent} */
1149
+ /**
1150
+ * Event type: {@link OnPlayerBannedEvent}
1151
+ */
954
1152
  const on_player_banned: EventId<OnPlayerBannedEvent>
955
- /** Event type: {@link OnPlayerKickedEvent} */
1153
+ /**
1154
+ * Event type: {@link OnPlayerKickedEvent}
1155
+ */
956
1156
  const on_player_kicked: EventId<OnPlayerKickedEvent>
957
- /** Event type: {@link OnPlayerUnbannedEvent} */
1157
+ /**
1158
+ * Event type: {@link OnPlayerUnbannedEvent}
1159
+ */
958
1160
  const on_player_unbanned: EventId<OnPlayerUnbannedEvent>
959
- /** Event type: {@link OnRocketLaunchOrderedEvent} */
1161
+ /**
1162
+ * Event type: {@link OnRocketLaunchOrderedEvent}
1163
+ */
960
1164
  const on_rocket_launch_ordered: EventId<OnRocketLaunchOrderedEvent>
961
- /** Event type: {@link OnScriptPathRequestFinishedEvent} */
1165
+ /**
1166
+ * Event type: {@link OnScriptPathRequestFinishedEvent}
1167
+ */
962
1168
  const on_script_path_request_finished: EventId<OnScriptPathRequestFinishedEvent>
963
- /** Event type: {@link OnAiCommandCompletedEvent} */
1169
+ /**
1170
+ * Event type: {@link OnAiCommandCompletedEvent}
1171
+ */
964
1172
  const on_ai_command_completed: EventId<OnAiCommandCompletedEvent>
965
1173
  /**
966
1174
  * Event type: {@link OnMarkedForUpgradeEvent}
@@ -974,7 +1182,9 @@ declare namespace defines {
974
1182
  * Event filter: {@link LuaUpgradeCancelledEventFilter}
975
1183
  */
976
1184
  const on_cancelled_upgrade: EventId<OnCancelledUpgradeEvent, LuaUpgradeCancelledEventFilter>
977
- /** Event type: {@link OnPlayerToggledMapEditorEvent} */
1185
+ /**
1186
+ * Event type: {@link OnPlayerToggledMapEditorEvent}
1187
+ */
978
1188
  const on_player_toggled_map_editor: EventId<OnPlayerToggledMapEditorEvent>
979
1189
  /**
980
1190
  * Event type: {@link OnEntityClonedEvent}
@@ -982,17 +1192,29 @@ declare namespace defines {
982
1192
  * Event filter: {@link LuaEntityClonedEventFilter}
983
1193
  */
984
1194
  const on_entity_cloned: EventId<OnEntityClonedEvent, LuaEntityClonedEventFilter>
985
- /** Event type: {@link OnAreaClonedEvent} */
1195
+ /**
1196
+ * Event type: {@link OnAreaClonedEvent}
1197
+ */
986
1198
  const on_area_cloned: EventId<OnAreaClonedEvent>
987
- /** Event type: {@link OnBrushClonedEvent} */
1199
+ /**
1200
+ * Event type: {@link OnBrushClonedEvent}
1201
+ */
988
1202
  const on_brush_cloned: EventId<OnBrushClonedEvent>
989
- /** Event type: {@link OnGameCreatedFromScenarioEvent} */
1203
+ /**
1204
+ * Event type: {@link OnGameCreatedFromScenarioEvent}
1205
+ */
990
1206
  const on_game_created_from_scenario: EventId<OnGameCreatedFromScenarioEvent>
991
- /** Event type: {@link OnSurfaceImportedEvent} */
1207
+ /**
1208
+ * Event type: {@link OnSurfaceImportedEvent}
1209
+ */
992
1210
  const on_surface_imported: EventId<OnSurfaceImportedEvent>
993
- /** Event type: {@link OnSurfaceRenamedEvent} */
1211
+ /**
1212
+ * Event type: {@link OnSurfaceRenamedEvent}
1213
+ */
994
1214
  const on_surface_renamed: EventId<OnSurfaceRenamedEvent>
995
- /** Event type: {@link OnPlayerToggledAltModeEvent} */
1215
+ /**
1216
+ * Event type: {@link OnPlayerToggledAltModeEvent}
1217
+ */
996
1218
  const on_player_toggled_alt_mode: EventId<OnPlayerToggledAltModeEvent>
997
1219
  /**
998
1220
  * Event type: {@link OnPlayerRepairedEntityEvent}
@@ -1000,92 +1222,173 @@ declare namespace defines {
1000
1222
  * Event filter: {@link LuaPlayerRepairedEntityEventFilter}
1001
1223
  */
1002
1224
  const on_player_repaired_entity: EventId<OnPlayerRepairedEntityEvent, LuaPlayerRepairedEntityEventFilter>
1003
- /** Event type: {@link OnPlayerFastTransferredEvent} */
1225
+ /**
1226
+ * Event type: {@link OnPlayerFastTransferredEvent}
1227
+ */
1004
1228
  const on_player_fast_transferred: EventId<OnPlayerFastTransferredEvent>
1005
- /** Event type: {@link OnPreRobotExplodedCliffEvent} */
1229
+ /**
1230
+ * Event type: {@link OnPreRobotExplodedCliffEvent}
1231
+ */
1006
1232
  const on_pre_robot_exploded_cliff: EventId<OnPreRobotExplodedCliffEvent>
1007
- /** Event type: {@link OnRobotExplodedCliffEvent} */
1233
+ /**
1234
+ * Event type: {@link OnRobotExplodedCliffEvent}
1235
+ */
1008
1236
  const on_robot_exploded_cliff: EventId<OnRobotExplodedCliffEvent>
1009
- /** Event type: {@link OnEntitySpawnedEvent} */
1237
+ /**
1238
+ * Event type: {@link OnEntitySpawnedEvent}
1239
+ */
1010
1240
  const on_entity_spawned: EventId<OnEntitySpawnedEvent>
1011
- /** Event type: {@link OnCutsceneWaypointReachedEvent} */
1241
+ /**
1242
+ * Event type: {@link OnCutsceneWaypointReachedEvent}
1243
+ */
1012
1244
  const on_cutscene_waypoint_reached: EventId<OnCutsceneWaypointReachedEvent>
1013
- /** Event type: {@link OnUnitGroupCreatedEvent} */
1245
+ /**
1246
+ * Event type: {@link OnUnitGroupCreatedEvent}
1247
+ */
1014
1248
  const on_unit_group_created: EventId<OnUnitGroupCreatedEvent>
1015
- /** Event type: {@link OnUnitAddedToGroupEvent} */
1249
+ /**
1250
+ * Event type: {@link OnUnitAddedToGroupEvent}
1251
+ */
1016
1252
  const on_unit_added_to_group: EventId<OnUnitAddedToGroupEvent>
1017
- /** Event type: {@link OnUnitRemovedFromGroupEvent} */
1253
+ /**
1254
+ * Event type: {@link OnUnitRemovedFromGroupEvent}
1255
+ */
1018
1256
  const on_unit_removed_from_group: EventId<OnUnitRemovedFromGroupEvent>
1019
- /** Event type: {@link OnUnitGroupFinishedGatheringEvent} */
1257
+ /**
1258
+ * Event type: {@link OnUnitGroupFinishedGatheringEvent}
1259
+ */
1020
1260
  const on_unit_group_finished_gathering: EventId<OnUnitGroupFinishedGatheringEvent>
1021
- /** Event type: {@link OnBuildBaseArrivedEvent} */
1261
+ /**
1262
+ * Event type: {@link OnBuildBaseArrivedEvent}
1263
+ */
1022
1264
  const on_build_base_arrived: EventId<OnBuildBaseArrivedEvent>
1023
- /** Event type: {@link OnChartTagAddedEvent} */
1265
+ /**
1266
+ * Event type: {@link OnChartTagAddedEvent}
1267
+ */
1024
1268
  const on_chart_tag_added: EventId<OnChartTagAddedEvent>
1025
- /** Event type: {@link OnChartTagModifiedEvent} */
1269
+ /**
1270
+ * Event type: {@link OnChartTagModifiedEvent}
1271
+ */
1026
1272
  const on_chart_tag_modified: EventId<OnChartTagModifiedEvent>
1027
- /** Event type: {@link OnChartTagRemovedEvent} */
1273
+ /**
1274
+ * Event type: {@link OnChartTagRemovedEvent}
1275
+ */
1028
1276
  const on_chart_tag_removed: EventId<OnChartTagRemovedEvent>
1029
- /** Event type: {@link OnLuaShortcutEvent} */
1277
+ /**
1278
+ * Event type: {@link OnLuaShortcutEvent}
1279
+ */
1030
1280
  const on_lua_shortcut: EventId<OnLuaShortcutEvent>
1031
- /** Event type: {@link OnGuiLocationChangedEvent} */
1281
+ /**
1282
+ * Event type: {@link OnGuiLocationChangedEvent}
1283
+ */
1032
1284
  const on_gui_location_changed: EventId<OnGuiLocationChangedEvent>
1033
- /** Event type: {@link OnGuiSelectedTabChangedEvent} */
1285
+ /**
1286
+ * Event type: {@link OnGuiSelectedTabChangedEvent}
1287
+ */
1034
1288
  const on_gui_selected_tab_changed: EventId<OnGuiSelectedTabChangedEvent>
1035
- /** Event type: {@link OnGuiSwitchStateChangedEvent} */
1289
+ /**
1290
+ * Event type: {@link OnGuiSwitchStateChangedEvent}
1291
+ */
1036
1292
  const on_gui_switch_state_changed: EventId<OnGuiSwitchStateChangedEvent>
1037
- /** Event type: {@link OnForceCeaseFireChangedEvent} */
1293
+ /**
1294
+ * Event type: {@link OnForceCeaseFireChangedEvent}
1295
+ */
1038
1296
  const on_force_cease_fire_changed: EventId<OnForceCeaseFireChangedEvent>
1039
- /** Event type: {@link OnForceFriendsChangedEvent} */
1297
+ /**
1298
+ * Event type: {@link OnForceFriendsChangedEvent}
1299
+ */
1040
1300
  const on_force_friends_changed: EventId<OnForceFriendsChangedEvent>
1041
- /** Event type: {@link OnStringTranslatedEvent} */
1301
+ /**
1302
+ * Event type: {@link OnStringTranslatedEvent}
1303
+ */
1042
1304
  const on_string_translated: EventId<OnStringTranslatedEvent>
1043
- /** Event type: {@link OnScriptTriggerEffectEvent} */
1305
+ /**
1306
+ * Event type: {@link OnScriptTriggerEffectEvent}
1307
+ */
1044
1308
  const on_script_trigger_effect: EventId<OnScriptTriggerEffectEvent>
1045
- /** Event type: {@link OnPlayerSetQuickBarSlotEvent} */
1309
+ /**
1310
+ * Event type: {@link OnPlayerSetQuickBarSlotEvent}
1311
+ */
1046
1312
  const on_player_set_quick_bar_slot: EventId<OnPlayerSetQuickBarSlotEvent>
1047
- /** Event type: {@link OnPrePlayerToggledMapEditorEvent} */
1313
+ /**
1314
+ * Event type: {@link OnPrePlayerToggledMapEditorEvent}
1315
+ */
1048
1316
  const on_pre_player_toggled_map_editor: EventId<OnPrePlayerToggledMapEditorEvent>
1049
- /** Event type: {@link OnPreScriptInventoryResizedEvent} */
1317
+ /**
1318
+ * Event type: {@link OnPreScriptInventoryResizedEvent}
1319
+ */
1050
1320
  const on_pre_script_inventory_resized: EventId<OnPreScriptInventoryResizedEvent>
1051
- /** Event type: {@link OnScriptInventoryResizedEvent} */
1321
+ /**
1322
+ * Event type: {@link OnScriptInventoryResizedEvent}
1323
+ */
1052
1324
  const on_script_inventory_resized: EventId<OnScriptInventoryResizedEvent>
1053
- /** Event type: {@link OnEntityDestroyedEvent} */
1325
+ /**
1326
+ * Event type: {@link OnEntityDestroyedEvent}
1327
+ */
1054
1328
  const on_entity_destroyed: EventId<OnEntityDestroyedEvent>
1055
- /** Event type: {@link OnPlayerClickedGpsTagEvent} */
1329
+ /**
1330
+ * Event type: {@link OnPlayerClickedGpsTagEvent}
1331
+ */
1056
1332
  const on_player_clicked_gps_tag: EventId<OnPlayerClickedGpsTagEvent>
1057
- /** Event type: {@link OnPlayerFlushedFluidEvent} */
1333
+ /**
1334
+ * Event type: {@link OnPlayerFlushedFluidEvent}
1335
+ */
1058
1336
  const on_player_flushed_fluid: EventId<OnPlayerFlushedFluidEvent>
1059
- /** Event type: {@link OnPermissionGroupEditedEvent} */
1337
+ /**
1338
+ * Event type: {@link OnPermissionGroupEditedEvent}
1339
+ */
1060
1340
  const on_permission_group_edited: EventId<OnPermissionGroupEditedEvent>
1061
- /** Event type: {@link OnPrePermissionStringImportedEvent} */
1341
+ /**
1342
+ * Event type: {@link OnPrePermissionStringImportedEvent}
1343
+ */
1062
1344
  const on_pre_permission_string_imported: EventId<OnPrePermissionStringImportedEvent>
1063
- /** Event type: {@link OnPermissionStringImportedEvent} */
1345
+ /**
1346
+ * Event type: {@link OnPermissionStringImportedEvent}
1347
+ */
1064
1348
  const on_permission_string_imported: EventId<OnPermissionStringImportedEvent>
1065
- /** Event type: {@link OnPrePermissionGroupDeletedEvent} */
1349
+ /**
1350
+ * Event type: {@link OnPrePermissionGroupDeletedEvent}
1351
+ */
1066
1352
  const on_pre_permission_group_deleted: EventId<OnPrePermissionGroupDeletedEvent>
1067
- /** Event type: {@link OnPermissionGroupDeletedEvent} */
1353
+ /**
1354
+ * Event type: {@link OnPermissionGroupDeletedEvent}
1355
+ */
1068
1356
  const on_permission_group_deleted: EventId<OnPermissionGroupDeletedEvent>
1069
- /** Event type: {@link OnPermissionGroupAddedEvent} */
1357
+ /**
1358
+ * Event type: {@link OnPermissionGroupAddedEvent}
1359
+ */
1070
1360
  const on_permission_group_added: EventId<OnPermissionGroupAddedEvent>
1071
- /** Event type: {@link OnCutsceneCancelledEvent} */
1361
+ /**
1362
+ * Event type: {@link OnCutsceneCancelledEvent}
1363
+ */
1072
1364
  const on_cutscene_cancelled: EventId<OnCutsceneCancelledEvent>
1073
- /** Event type: {@link OnPlayerConfiguredSpiderRemoteEvent} */
1365
+ /**
1366
+ * Event type: {@link OnPlayerConfiguredSpiderRemoteEvent}
1367
+ */
1074
1368
  const on_player_configured_spider_remote: EventId<OnPlayerConfiguredSpiderRemoteEvent>
1075
- /** Event type: {@link OnPlayerUsedSpiderRemoteEvent} */
1369
+ /**
1370
+ * Event type: {@link OnPlayerUsedSpiderRemoteEvent}
1371
+ */
1076
1372
  const on_player_used_spider_remote: EventId<OnPlayerUsedSpiderRemoteEvent>
1077
- /** Event type: {@link OnSpiderCommandCompletedEvent} */
1373
+ /**
1374
+ * Event type: {@link OnSpiderCommandCompletedEvent}
1375
+ */
1078
1376
  const on_spider_command_completed: EventId<OnSpiderCommandCompletedEvent>
1079
- /** Event type: {@link OnEntityLogisticSlotChangedEvent} */
1377
+ /**
1378
+ * Event type: {@link OnEntityLogisticSlotChangedEvent}
1379
+ */
1080
1380
  const on_entity_logistic_slot_changed: EventId<OnEntityLogisticSlotChangedEvent>
1081
- /** Event type: {@link OnEquipmentInsertedEvent} */
1381
+ /**
1382
+ * Event type: {@link OnEquipmentInsertedEvent}
1383
+ */
1082
1384
  const on_equipment_inserted: EventId<OnEquipmentInsertedEvent>
1083
- /** Event type: {@link OnEquipmentRemovedEvent} */
1385
+ /**
1386
+ * Event type: {@link OnEquipmentRemovedEvent}
1387
+ */
1084
1388
  const on_equipment_removed: EventId<OnEquipmentRemovedEvent>
1085
1389
  }
1086
1390
  /**
1087
- * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain
1088
- * and when they get raised.
1391
+ * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
1089
1392
  *
1090
1393
  * {@link https://lua-api.factorio.com/latest/defines.html#defines.events View documentation}
1091
1394
  */
@@ -1398,9 +1701,7 @@ declare namespace defines {
1398
1701
  middle,
1399
1702
  }
1400
1703
  /**
1401
- * A dictionary mapping all top-level prototypes by name to a list of their associated subtypes. This list is
1402
- * organized as a lookup table, meaning it maps the sub-prototype names to `0`. As an example,
1403
- * `defines.prototypes['entity']` looks like this: `{furnace=0, inserter=0, container=0, ...}`.
1704
+ * A dictionary mapping all top-level prototypes by name to a list of their associated subtypes. This list is organized as a lookup table, meaning it maps the sub-prototype names to `0`. As an example, `defines.prototypes['entity']` looks like this: `{furnace=0, inserter=0, container=0, ...}`.
1404
1705
  *
1405
1706
  * {@link https://lua-api.factorio.com/latest/defines.html#defines.prototypes View documentation}
1406
1707
  */