typed-factorio 0.18.1 → 0.19.0

package/generated/defines.d.ts

@@ -15,7 +15,7 @@ declare namespace defines {
     train_out_of_fuel,
   }
   /**
-   * AI command exit status. See {@link LuaEntity.set_command LuaEntity::set_command}
+   * AI command exit status. See {@link LuaEntity#set_command LuaEntity::set_command}
    *
    * {@link https://lua-api.factorio.com/latest/defines.html#defines.behavior_result View documentation}
    */
@@ -528,8 +528,7 @@ declare namespace defines {
      */
     fluid_ingredient_shortage,
     /**
-     * Used by crafting machines, boilers, burner energy sources and reactors: Reactor/burner has full burnt result
-     * inventory, boiler has full output fluidbox.
+     * Used by crafting machines, boilers, burner energy sources and reactors: Reactor/burner has full burnt result inventory, boiler has full output fluidbox.
      *
      * {@link https://lua-api.factorio.com/latest/defines.html#defines.entity_status.full_output View documentation}
      */
@@ -644,21 +643,30 @@ declare namespace defines {
     cant_divide_segments,
   }
   /**
-   * 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.
+   * 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.
    *
    * {@link https://lua-api.factorio.com/latest/defines.html#defines.events View documentation}
    */
   namespace events {
-    /** Event type: {@link OnTickEvent} */
+    /**
+     * Event type: {@link OnTickEvent}
+     */
     const on_tick: EventId<OnTickEvent>
-    /** Event type: {@link OnGuiClickEvent} */
+    /**
+     * Event type: {@link OnGuiClickEvent}
+     */
     const on_gui_click: EventId<OnGuiClickEvent>
-    /** Event type: {@link OnGuiConfirmedEvent} */
+    /**
+     * Event type: {@link OnGuiConfirmedEvent}
+     */
     const on_gui_confirmed: EventId<OnGuiConfirmedEvent>
-    /** Event type: {@link OnGuiTextChangedEvent} */
+    /**
+     * Event type: {@link OnGuiTextChangedEvent}
+     */
     const on_gui_text_changed: EventId<OnGuiTextChangedEvent>
-    /** Event type: {@link OnGuiCheckedStateChangedEvent} */
+    /**
+     * Event type: {@link OnGuiCheckedStateChangedEvent}
+     */
     const on_gui_checked_state_changed: EventId<OnGuiCheckedStateChangedEvent>
     /**
      * Event type: {@link OnEntityDiedEvent}
@@ -678,7 +686,9 @@ declare namespace defines {
      * Event filter: {@link LuaEntityDamagedEventFilter}
      */
     const on_entity_damaged: EventId<OnEntityDamagedEvent, LuaEntityDamagedEventFilter>
-    /** Event type: {@link OnPickedUpItemEvent} */
+    /**
+     * Event type: {@link OnPickedUpItemEvent}
+     */
     const on_picked_up_item: EventId<OnPickedUpItemEvent>
     /**
      * Event type: {@link OnBuiltEntityEvent}
@@ -692,11 +702,17 @@ declare namespace defines {
      * Event filter: {@link LuaSectorScannedEventFilter}
      */
     const on_sector_scanned: EventId<OnSectorScannedEvent, LuaSectorScannedEventFilter>
-    /** Event type: {@link OnPlayerMinedItemEvent} */
+    /**
+     * Event type: {@link OnPlayerMinedItemEvent}
+     */
     const on_player_mined_item: EventId<OnPlayerMinedItemEvent>
-    /** Event type: {@link OnPreBuildEvent} */
+    /**
+     * Event type: {@link OnPreBuildEvent}
+     */
     const on_pre_build: EventId<OnPreBuildEvent>
-    /** Event type: {@link OnRocketLaunchedEvent} */
+    /**
+     * Event type: {@link OnRocketLaunchedEvent}
+     */
     const on_rocket_launched: EventId<OnRocketLaunchedEvent>
     /**
      * Event type: {@link OnPrePlayerMinedItemEvent}
@@ -704,9 +720,13 @@ declare namespace defines {
      * Event filter: {@link LuaPrePlayerMinedEntityEventFilter}
      */
     const on_pre_player_mined_item: EventId<OnPrePlayerMinedItemEvent, LuaPrePlayerMinedEntityEventFilter>
-    /** Event type: {@link OnChunkGeneratedEvent} */
+    /**
+     * Event type: {@link OnChunkGeneratedEvent}
+     */
     const on_chunk_generated: EventId<OnChunkGeneratedEvent>
-    /** Event type: {@link OnPlayerCraftedItemEvent} */
+    /**
+     * Event type: {@link OnPlayerCraftedItemEvent}
+     */
     const on_player_crafted_item: EventId<OnPlayerCraftedItemEvent>
     /**
      * Event type: {@link OnRobotBuiltEntityEvent}
@@ -720,15 +740,25 @@ declare namespace defines {
      * Event filter: {@link LuaPreRobotMinedEntityEventFilter}
      */
     const on_robot_pre_mined: EventId<OnRobotPreMinedEvent, LuaPreRobotMinedEntityEventFilter>
-    /** Event type: {@link OnRobotMinedEvent} */
+    /**
+     * Event type: {@link OnRobotMinedEvent}
+     */
     const on_robot_mined: EventId<OnRobotMinedEvent>
-    /** Event type: {@link OnResearchStartedEvent} */
+    /**
+     * Event type: {@link OnResearchStartedEvent}
+     */
     const on_research_started: EventId<OnResearchStartedEvent>
-    /** Event type: {@link OnResearchFinishedEvent} */
+    /**
+     * Event type: {@link OnResearchFinishedEvent}
+     */
     const on_research_finished: EventId<OnResearchFinishedEvent>
-    /** Event type: {@link OnResearchReversedEvent} */
+    /**
+     * Event type: {@link OnResearchReversedEvent}
+     */
     const on_research_reversed: EventId<OnResearchReversedEvent>
-    /** Event type: {@link OnPlayerRotatedEntityEvent} */
+    /**
+     * Event type: {@link OnPlayerRotatedEntityEvent}
+     */
     const on_player_rotated_entity: EventId<OnPlayerRotatedEntityEvent>
     /**
      * Event type: {@link OnMarkedForDeconstructionEvent}
@@ -748,87 +778,169 @@ declare namespace defines {
       OnCancelledDeconstructionEvent,
       LuaEntityDeconstructionCancelledEventFilter
     >
-    /** Event type: {@link OnTriggerCreatedEntityEvent} */
+    /**
+     * Event type: {@link OnTriggerCreatedEntityEvent}
+     */
     const on_trigger_created_entity: EventId<OnTriggerCreatedEntityEvent>
-    /** Event type: {@link OnTriggerFiredArtilleryEvent} */
+    /**
+     * Event type: {@link OnTriggerFiredArtilleryEvent}
+     */
     const on_trigger_fired_artillery: EventId<OnTriggerFiredArtilleryEvent>
-    /** Event type: {@link OnTrainChangedStateEvent} */
+    /**
+     * Event type: {@link OnTrainChangedStateEvent}
+     */
     const on_train_changed_state: EventId<OnTrainChangedStateEvent>
-    /** Event type: {@link OnPlayerCreatedEvent} */
+    /**
+     * Event type: {@link OnPlayerCreatedEvent}
+     */
     const on_player_created: EventId<OnPlayerCreatedEvent>
-    /** Event type: {@link OnResourceDepletedEvent} */
+    /**
+     * Event type: {@link OnResourceDepletedEvent}
+     */
     const on_resource_depleted: EventId<OnResourceDepletedEvent>
-    /** Event type: {@link OnPlayerDrivingChangedStateEvent} */
+    /**
+     * Event type: {@link OnPlayerDrivingChangedStateEvent}
+     */
     const on_player_driving_changed_state: EventId<OnPlayerDrivingChangedStateEvent>
-    /** Event type: {@link OnForceCreatedEvent} */
+    /**
+     * Event type: {@link OnForceCreatedEvent}
+     */
     const on_force_created: EventId<OnForceCreatedEvent>
-    /** Event type: {@link OnForcesMergingEvent} */
+    /**
+     * Event type: {@link OnForcesMergingEvent}
+     */
     const on_forces_merging: EventId<OnForcesMergingEvent>
-    /** Event type: {@link OnPlayerCursorStackChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerCursorStackChangedEvent}
+     */
     const on_player_cursor_stack_changed: EventId<OnPlayerCursorStackChangedEvent>
-    /** Event type: {@link OnPreEntitySettingsPastedEvent} */
+    /**
+     * Event type: {@link OnPreEntitySettingsPastedEvent}
+     */
     const on_pre_entity_settings_pasted: EventId<OnPreEntitySettingsPastedEvent>
-    /** Event type: {@link OnEntitySettingsPastedEvent} */
+    /**
+     * Event type: {@link OnEntitySettingsPastedEvent}
+     */
     const on_entity_settings_pasted: EventId<OnEntitySettingsPastedEvent>
-    /** Event type: {@link OnPlayerMainInventoryChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerMainInventoryChangedEvent}
+     */
     const on_player_main_inventory_changed: EventId<OnPlayerMainInventoryChangedEvent>
-    /** Event type: {@link OnPlayerArmorInventoryChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerArmorInventoryChangedEvent}
+     */
     const on_player_armor_inventory_changed: EventId<OnPlayerArmorInventoryChangedEvent>
-    /** Event type: {@link OnPlayerAmmoInventoryChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerAmmoInventoryChangedEvent}
+     */
     const on_player_ammo_inventory_changed: EventId<OnPlayerAmmoInventoryChangedEvent>
-    /** Event type: {@link OnPlayerGunInventoryChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerGunInventoryChangedEvent}
+     */
     const on_player_gun_inventory_changed: EventId<OnPlayerGunInventoryChangedEvent>
-    /** Event type: {@link OnPlayerPlacedEquipmentEvent} */
+    /**
+     * Event type: {@link OnPlayerPlacedEquipmentEvent}
+     */
     const on_player_placed_equipment: EventId<OnPlayerPlacedEquipmentEvent>
-    /** Event type: {@link OnPlayerRemovedEquipmentEvent} */
+    /**
+     * Event type: {@link OnPlayerRemovedEquipmentEvent}
+     */
     const on_player_removed_equipment: EventId<OnPlayerRemovedEquipmentEvent>
-    /** Event type: {@link OnPrePlayerDiedEvent} */
+    /**
+     * Event type: {@link OnPrePlayerDiedEvent}
+     */
     const on_pre_player_died: EventId<OnPrePlayerDiedEvent>
-    /** Event type: {@link OnPlayerDiedEvent} */
+    /**
+     * Event type: {@link OnPlayerDiedEvent}
+     */
     const on_player_died: EventId<OnPlayerDiedEvent>
-    /** Event type: {@link OnPlayerRespawnedEvent} */
+    /**
+     * Event type: {@link OnPlayerRespawnedEvent}
+     */
     const on_player_respawned: EventId<OnPlayerRespawnedEvent>
-    /** Event type: {@link OnPlayerJoinedGameEvent} */
+    /**
+     * Event type: {@link OnPlayerJoinedGameEvent}
+     */
     const on_player_joined_game: EventId<OnPlayerJoinedGameEvent>
-    /** Event type: {@link OnPlayerLeftGameEvent} */
+    /**
+     * Event type: {@link OnPlayerLeftGameEvent}
+     */
     const on_player_left_game: EventId<OnPlayerLeftGameEvent>
-    /** Event type: {@link OnPlayerBuiltTileEvent} */
+    /**
+     * Event type: {@link OnPlayerBuiltTileEvent}
+     */
     const on_player_built_tile: EventId<OnPlayerBuiltTileEvent>
-    /** Event type: {@link OnPlayerMinedTileEvent} */
+    /**
+     * Event type: {@link OnPlayerMinedTileEvent}
+     */
     const on_player_mined_tile: EventId<OnPlayerMinedTileEvent>
-    /** Event type: {@link OnRobotBuiltTileEvent} */
+    /**
+     * Event type: {@link OnRobotBuiltTileEvent}
+     */
     const on_robot_built_tile: EventId<OnRobotBuiltTileEvent>
-    /** Event type: {@link OnRobotMinedTileEvent} */
+    /**
+     * Event type: {@link OnRobotMinedTileEvent}
+     */
     const on_robot_mined_tile: EventId<OnRobotMinedTileEvent>
-    /** Event type: {@link OnPlayerSelectedAreaEvent} */
+    /**
+     * Event type: {@link OnPlayerSelectedAreaEvent}
+     */
     const on_player_selected_area: EventId<OnPlayerSelectedAreaEvent>
-    /** Event type: {@link OnPlayerAltSelectedAreaEvent} */
+    /**
+     * Event type: {@link OnPlayerAltSelectedAreaEvent}
+     */
     const on_player_alt_selected_area: EventId<OnPlayerAltSelectedAreaEvent>
-    /** Event type: {@link OnPlayerChangedSurfaceEvent} */
+    /**
+     * Event type: {@link OnPlayerChangedSurfaceEvent}
+     */
     const on_player_changed_surface: EventId<OnPlayerChangedSurfaceEvent>
-    /** Event type: {@link OnSelectedEntityChangedEvent} */
+    /**
+     * Event type: {@link OnSelectedEntityChangedEvent}
+     */
     const on_selected_entity_changed: EventId<OnSelectedEntityChangedEvent>
-    /** Event type: {@link OnMarketItemPurchasedEvent} */
+    /**
+     * Event type: {@link OnMarketItemPurchasedEvent}
+     */
     const on_market_item_purchased: EventId<OnMarketItemPurchasedEvent>
-    /** Event type: {@link OnPlayerDroppedItemEvent} */
+    /**
+     * Event type: {@link OnPlayerDroppedItemEvent}
+     */
     const on_player_dropped_item: EventId<OnPlayerDroppedItemEvent>
-    /** Event type: {@link OnBiterBaseBuiltEvent} */
+    /**
+     * Event type: {@link OnBiterBaseBuiltEvent}
+     */
     const on_biter_base_built: EventId<OnBiterBaseBuiltEvent>
-    /** Event type: {@link OnPlayerChangedForceEvent} */
+    /**
+     * Event type: {@link OnPlayerChangedForceEvent}
+     */
     const on_player_changed_force: EventId<OnPlayerChangedForceEvent>
-    /** Event type: {@link OnEntityRenamedEvent} */
+    /**
+     * Event type: {@link OnEntityRenamedEvent}
+     */
     const on_entity_renamed: EventId<OnEntityRenamedEvent>
-    /** Event type: {@link OnGuiSelectionStateChangedEvent} */
+    /**
+     * Event type: {@link OnGuiSelectionStateChangedEvent}
+     */
     const on_gui_selection_state_changed: EventId<OnGuiSelectionStateChangedEvent>
-    /** Event type: {@link OnRuntimeModSettingChangedEvent} */
+    /**
+     * Event type: {@link OnRuntimeModSettingChangedEvent}
+     */
     const on_runtime_mod_setting_changed: EventId<OnRuntimeModSettingChangedEvent>
-    /** Event type: {@link OnDifficultySettingsChangedEvent} */
+    /**
+     * Event type: {@link OnDifficultySettingsChangedEvent}
+     */
     const on_difficulty_settings_changed: EventId<OnDifficultySettingsChangedEvent>
-    /** Event type: {@link OnSurfaceCreatedEvent} */
+    /**
+     * Event type: {@link OnSurfaceCreatedEvent}
+     */
     const on_surface_created: EventId<OnSurfaceCreatedEvent>
-    /** Event type: {@link OnSurfaceDeletedEvent} */
+    /**
+     * Event type: {@link OnSurfaceDeletedEvent}
+     */
     const on_surface_deleted: EventId<OnSurfaceDeletedEvent>
-    /** Event type: {@link OnPreSurfaceDeletedEvent} */
+    /**
+     * Event type: {@link OnPreSurfaceDeletedEvent}
+     */
     const on_pre_surface_deleted: EventId<OnPreSurfaceDeletedEvent>
     /**
      * Event type: {@link OnPlayerMinedEntityEvent}
@@ -842,25 +954,45 @@ declare namespace defines {
      * Event filter: {@link LuaRobotMinedEntityEventFilter}
      */
     const on_robot_mined_entity: EventId<OnRobotMinedEntityEvent, LuaRobotMinedEntityEventFilter>
-    /** Event type: {@link OnTrainCreatedEvent} */
+    /**
+     * Event type: {@link OnTrainCreatedEvent}
+     */
     const on_train_created: EventId<OnTrainCreatedEvent>
-    /** Event type: {@link OnGuiElemChangedEvent} */
+    /**
+     * Event type: {@link OnGuiElemChangedEvent}
+     */
     const on_gui_elem_changed: EventId<OnGuiElemChangedEvent>
-    /** Event type: {@link OnPlayerSetupBlueprintEvent} */
+    /**
+     * Event type: {@link OnPlayerSetupBlueprintEvent}
+     */
     const on_player_setup_blueprint: EventId<OnPlayerSetupBlueprintEvent>
-    /** Event type: {@link OnPlayerDeconstructedAreaEvent} */
+    /**
+     * Event type: {@link OnPlayerDeconstructedAreaEvent}
+     */
     const on_player_deconstructed_area: EventId<OnPlayerDeconstructedAreaEvent>
-    /** Event type: {@link OnPlayerConfiguredBlueprintEvent} */
+    /**
+     * Event type: {@link OnPlayerConfiguredBlueprintEvent}
+     */
     const on_player_configured_blueprint: EventId<OnPlayerConfiguredBlueprintEvent>
-    /** Event type: {@link OnConsoleChatEvent} */
+    /**
+     * Event type: {@link OnConsoleChatEvent}
+     */
     const on_console_chat: EventId<OnConsoleChatEvent>
-    /** Event type: {@link OnConsoleCommandEvent} */
+    /**
+     * Event type: {@link OnConsoleCommandEvent}
+     */
     const on_console_command: EventId<OnConsoleCommandEvent>
-    /** Event type: {@link OnPlayerRemovedEvent} */
+    /**
+     * Event type: {@link OnPlayerRemovedEvent}
+     */
     const on_player_removed: EventId<OnPlayerRemovedEvent>
-    /** Event type: {@link OnPrePlayerRemovedEvent} */
+    /**
+     * Event type: {@link OnPrePlayerRemovedEvent}
+     */
     const on_pre_player_removed: EventId<OnPrePlayerRemovedEvent>
-    /** Event type: {@link OnPlayerUsedCapsuleEvent} */
+    /**
+     * Event type: {@link OnPlayerUsedCapsuleEvent}
+     */
     const on_player_used_capsule: EventId<OnPlayerUsedCapsuleEvent>
     /**
      * Event type: {@link ScriptRaisedBuiltEvent}
@@ -880,35 +1012,65 @@ declare namespace defines {
      * Event filter: {@link LuaScriptRaisedReviveEventFilter}
      */
     const script_raised_revive: EventId<ScriptRaisedReviveEvent, LuaScriptRaisedReviveEventFilter>
-    /** Event type: {@link ScriptRaisedSetTilesEvent} */
+    /**
+     * Event type: {@link ScriptRaisedSetTilesEvent}
+     */
     const script_raised_set_tiles: EventId<ScriptRaisedSetTilesEvent>
-    /** Event type: {@link OnPlayerPromotedEvent} */
+    /**
+     * Event type: {@link OnPlayerPromotedEvent}
+     */
     const on_player_promoted: EventId<OnPlayerPromotedEvent>
-    /** Event type: {@link OnPlayerDemotedEvent} */
+    /**
+     * Event type: {@link OnPlayerDemotedEvent}
+     */
     const on_player_demoted: EventId<OnPlayerDemotedEvent>
-    /** Event type: {@link OnCombatRobotExpiredEvent} */
+    /**
+     * Event type: {@link OnCombatRobotExpiredEvent}
+     */
     const on_combat_robot_expired: EventId<OnCombatRobotExpiredEvent>
-    /** Event type: {@link OnWorkerRobotExpiredEvent} */
+    /**
+     * Event type: {@link OnWorkerRobotExpiredEvent}
+     */
     const on_worker_robot_expired: EventId<OnWorkerRobotExpiredEvent>
-    /** Event type: {@link OnPlayerChangedPositionEvent} */
+    /**
+     * Event type: {@link OnPlayerChangedPositionEvent}
+     */
     const on_player_changed_position: EventId<OnPlayerChangedPositionEvent>
-    /** Event type: {@link OnModItemOpenedEvent} */
+    /**
+     * Event type: {@link OnModItemOpenedEvent}
+     */
     const on_mod_item_opened: EventId<OnModItemOpenedEvent>
-    /** Event type: {@link OnGuiOpenedEvent} */
+    /**
+     * Event type: {@link OnGuiOpenedEvent}
+     */
     const on_gui_opened: EventId<OnGuiOpenedEvent>
-    /** Event type: {@link OnGuiClosedEvent} */
+    /**
+     * Event type: {@link OnGuiClosedEvent}
+     */
     const on_gui_closed: EventId<OnGuiClosedEvent>
-    /** Event type: {@link OnGuiValueChangedEvent} */
+    /**
+     * Event type: {@link OnGuiValueChangedEvent}
+     */
     const on_gui_value_changed: EventId<OnGuiValueChangedEvent>
-    /** Event type: {@link OnPlayerMutedEvent} */
+    /**
+     * Event type: {@link OnPlayerMutedEvent}
+     */
     const on_player_muted: EventId<OnPlayerMutedEvent>
-    /** Event type: {@link OnPlayerUnmutedEvent} */
+    /**
+     * Event type: {@link OnPlayerUnmutedEvent}
+     */
     const on_player_unmuted: EventId<OnPlayerUnmutedEvent>
-    /** Event type: {@link OnPlayerCheatModeEnabledEvent} */
+    /**
+     * Event type: {@link OnPlayerCheatModeEnabledEvent}
+     */
     const on_player_cheat_mode_enabled: EventId<OnPlayerCheatModeEnabledEvent>
-    /** Event type: {@link OnPlayerCheatModeDisabledEvent} */
+    /**
+     * Event type: {@link OnPlayerCheatModeDisabledEvent}
+     */
     const on_player_cheat_mode_disabled: EventId<OnPlayerCheatModeDisabledEvent>
-    /** Event type: {@link OnCharacterCorpseExpiredEvent} */
+    /**
+     * Event type: {@link OnCharacterCorpseExpiredEvent}
+     */
     const on_character_corpse_expired: EventId<OnCharacterCorpseExpiredEvent>
     /**
      * Event type: {@link OnPreGhostDeconstructedEvent}
@@ -916,51 +1078,97 @@ declare namespace defines {
      * Event filter: {@link LuaPreGhostDeconstructedEventFilter}
      */
     const on_pre_ghost_deconstructed: EventId<OnPreGhostDeconstructedEvent, LuaPreGhostDeconstructedEventFilter>
-    /** Event type: {@link OnPlayerPipetteEvent} */
+    /**
+     * Event type: {@link OnPlayerPipetteEvent}
+     */
     const on_player_pipette: EventId<OnPlayerPipetteEvent>
-    /** Event type: {@link OnPlayerDisplayResolutionChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerDisplayResolutionChangedEvent}
+     */
     const on_player_display_resolution_changed: EventId<OnPlayerDisplayResolutionChangedEvent>
-    /** Event type: {@link OnPlayerDisplayScaleChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerDisplayScaleChangedEvent}
+     */
     const on_player_display_scale_changed: EventId<OnPlayerDisplayScaleChangedEvent>
-    /** Event type: {@link OnPrePlayerCraftedItemEvent} */
+    /**
+     * Event type: {@link OnPrePlayerCraftedItemEvent}
+     */
     const on_pre_player_crafted_item: EventId<OnPrePlayerCraftedItemEvent>
-    /** Event type: {@link OnPlayerCancelledCraftingEvent} */
+    /**
+     * Event type: {@link OnPlayerCancelledCraftingEvent}
+     */
     const on_player_cancelled_crafting: EventId<OnPlayerCancelledCraftingEvent>
-    /** Event type: {@link OnChunkChartedEvent} */
+    /**
+     * Event type: {@link OnChunkChartedEvent}
+     */
     const on_chunk_charted: EventId<OnChunkChartedEvent>
-    /** Event type: {@link OnTechnologyEffectsResetEvent} */
+    /**
+     * Event type: {@link OnTechnologyEffectsResetEvent}
+     */
     const on_technology_effects_reset: EventId<OnTechnologyEffectsResetEvent>
-    /** Event type: {@link OnForceResetEvent} */
+    /**
+     * Event type: {@link OnForceResetEvent}
+     */
     const on_force_reset: EventId<OnForceResetEvent>
-    /** Event type: {@link OnLandMineArmedEvent} */
+    /**
+     * Event type: {@link OnLandMineArmedEvent}
+     */
     const on_land_mine_armed: EventId<OnLandMineArmedEvent>
-    /** Event type: {@link OnForcesMergedEvent} */
+    /**
+     * Event type: {@link OnForcesMergedEvent}
+     */
     const on_forces_merged: EventId<OnForcesMergedEvent>
-    /** Event type: {@link OnPlayerTrashInventoryChangedEvent} */
+    /**
+     * Event type: {@link OnPlayerTrashInventoryChangedEvent}
+     */
     const on_player_trash_inventory_changed: EventId<OnPlayerTrashInventoryChangedEvent>
-    /** Event type: {@link OnPrePlayerLeftGameEvent} */
+    /**
+     * Event type: {@link OnPrePlayerLeftGameEvent}
+     */
     const on_pre_player_left_game: EventId<OnPrePlayerLeftGameEvent>
-    /** Event type: {@link OnPreSurfaceClearedEvent} */
+    /**
+     * Event type: {@link OnPreSurfaceClearedEvent}
+     */
     const on_pre_surface_cleared: EventId<OnPreSurfaceClearedEvent>
-    /** Event type: {@link OnSurfaceClearedEvent} */
+    /**
+     * Event type: {@link OnSurfaceClearedEvent}
+     */
     const on_surface_cleared: EventId<OnSurfaceClearedEvent>
-    /** Event type: {@link OnChunkDeletedEvent} */
+    /**
+     * Event type: {@link OnChunkDeletedEvent}
+     */
     const on_chunk_deleted: EventId<OnChunkDeletedEvent>
-    /** Event type: {@link OnPreChunkDeletedEvent} */
+    /**
+     * Event type: {@link OnPreChunkDeletedEvent}
+     */
     const on_pre_chunk_deleted: EventId<OnPreChunkDeletedEvent>
-    /** Event type: {@link OnTrainScheduleChangedEvent} */
+    /**
+     * Event type: {@link OnTrainScheduleChangedEvent}
+     */
     const on_train_schedule_changed: EventId<OnTrainScheduleChangedEvent>
-    /** Event type: {@link OnPlayerBannedEvent} */
+    /**
+     * Event type: {@link OnPlayerBannedEvent}
+     */
     const on_player_banned: EventId<OnPlayerBannedEvent>
-    /** Event type: {@link OnPlayerKickedEvent} */
+    /**
+     * Event type: {@link OnPlayerKickedEvent}
+     */
     const on_player_kicked: EventId<OnPlayerKickedEvent>
-    /** Event type: {@link OnPlayerUnbannedEvent} */
+    /**
+     * Event type: {@link OnPlayerUnbannedEvent}
+     */
     const on_player_unbanned: EventId<OnPlayerUnbannedEvent>
-    /** Event type: {@link OnRocketLaunchOrderedEvent} */
+    /**
+     * Event type: {@link OnRocketLaunchOrderedEvent}
+     */
     const on_rocket_launch_ordered: EventId<OnRocketLaunchOrderedEvent>
-    /** Event type: {@link OnScriptPathRequestFinishedEvent} */
+    /**
+     * Event type: {@link OnScriptPathRequestFinishedEvent}
+     */
     const on_script_path_request_finished: EventId<OnScriptPathRequestFinishedEvent>
-    /** Event type: {@link OnAiCommandCompletedEvent} */
+    /**
+     * Event type: {@link OnAiCommandCompletedEvent}
+     */
     const on_ai_command_completed: EventId<OnAiCommandCompletedEvent>
     /**
      * Event type: {@link OnMarkedForUpgradeEvent}
@@ -974,7 +1182,9 @@ declare namespace defines {
      * Event filter: {@link LuaUpgradeCancelledEventFilter}
      */
     const on_cancelled_upgrade: EventId<OnCancelledUpgradeEvent, LuaUpgradeCancelledEventFilter>
-    /** Event type: {@link OnPlayerToggledMapEditorEvent} */
+    /**
+     * Event type: {@link OnPlayerToggledMapEditorEvent}
+     */
     const on_player_toggled_map_editor: EventId<OnPlayerToggledMapEditorEvent>
     /**
      * Event type: {@link OnEntityClonedEvent}
@@ -982,17 +1192,29 @@ declare namespace defines {
      * Event filter: {@link LuaEntityClonedEventFilter}
      */
     const on_entity_cloned: EventId<OnEntityClonedEvent, LuaEntityClonedEventFilter>
-    /** Event type: {@link OnAreaClonedEvent} */
+    /**
+     * Event type: {@link OnAreaClonedEvent}
+     */
     const on_area_cloned: EventId<OnAreaClonedEvent>
-    /** Event type: {@link OnBrushClonedEvent} */
+    /**
+     * Event type: {@link OnBrushClonedEvent}
+     */
     const on_brush_cloned: EventId<OnBrushClonedEvent>
-    /** Event type: {@link OnGameCreatedFromScenarioEvent} */
+    /**
+     * Event type: {@link OnGameCreatedFromScenarioEvent}
+     */
     const on_game_created_from_scenario: EventId<OnGameCreatedFromScenarioEvent>
-    /** Event type: {@link OnSurfaceImportedEvent} */
+    /**
+     * Event type: {@link OnSurfaceImportedEvent}
+     */
     const on_surface_imported: EventId<OnSurfaceImportedEvent>
-    /** Event type: {@link OnSurfaceRenamedEvent} */
+    /**
+     * Event type: {@link OnSurfaceRenamedEvent}
+     */
     const on_surface_renamed: EventId<OnSurfaceRenamedEvent>
-    /** Event type: {@link OnPlayerToggledAltModeEvent} */
+    /**
+     * Event type: {@link OnPlayerToggledAltModeEvent}
+     */
     const on_player_toggled_alt_mode: EventId<OnPlayerToggledAltModeEvent>
     /**
      * Event type: {@link OnPlayerRepairedEntityEvent}
@@ -1000,92 +1222,173 @@ declare namespace defines {
      * Event filter: {@link LuaPlayerRepairedEntityEventFilter}
      */
     const on_player_repaired_entity: EventId<OnPlayerRepairedEntityEvent, LuaPlayerRepairedEntityEventFilter>
-    /** Event type: {@link OnPlayerFastTransferredEvent} */
+    /**
+     * Event type: {@link OnPlayerFastTransferredEvent}
+     */
     const on_player_fast_transferred: EventId<OnPlayerFastTransferredEvent>
-    /** Event type: {@link OnPreRobotExplodedCliffEvent} */
+    /**
+     * Event type: {@link OnPreRobotExplodedCliffEvent}
+     */
     const on_pre_robot_exploded_cliff: EventId<OnPreRobotExplodedCliffEvent>
-    /** Event type: {@link OnRobotExplodedCliffEvent} */
+    /**
+     * Event type: {@link OnRobotExplodedCliffEvent}
+     */
     const on_robot_exploded_cliff: EventId<OnRobotExplodedCliffEvent>
-    /** Event type: {@link OnEntitySpawnedEvent} */
+    /**
+     * Event type: {@link OnEntitySpawnedEvent}
+     */
     const on_entity_spawned: EventId<OnEntitySpawnedEvent>
-    /** Event type: {@link OnCutsceneWaypointReachedEvent} */
+    /**
+     * Event type: {@link OnCutsceneWaypointReachedEvent}
+     */
     const on_cutscene_waypoint_reached: EventId<OnCutsceneWaypointReachedEvent>
-    /** Event type: {@link OnUnitGroupCreatedEvent} */
+    /**
+     * Event type: {@link OnUnitGroupCreatedEvent}
+     */
     const on_unit_group_created: EventId<OnUnitGroupCreatedEvent>
-    /** Event type: {@link OnUnitAddedToGroupEvent} */
+    /**
+     * Event type: {@link OnUnitAddedToGroupEvent}
+     */
     const on_unit_added_to_group: EventId<OnUnitAddedToGroupEvent>
-    /** Event type: {@link OnUnitRemovedFromGroupEvent} */
+    /**
+     * Event type: {@link OnUnitRemovedFromGroupEvent}
+     */
     const on_unit_removed_from_group: EventId<OnUnitRemovedFromGroupEvent>
-    /** Event type: {@link OnUnitGroupFinishedGatheringEvent} */
+    /**
+     * Event type: {@link OnUnitGroupFinishedGatheringEvent}
+     */
     const on_unit_group_finished_gathering: EventId<OnUnitGroupFinishedGatheringEvent>
-    /** Event type: {@link OnBuildBaseArrivedEvent} */
+    /**
+     * Event type: {@link OnBuildBaseArrivedEvent}
+     */
     const on_build_base_arrived: EventId<OnBuildBaseArrivedEvent>
-    /** Event type: {@link OnChartTagAddedEvent} */
+    /**
+     * Event type: {@link OnChartTagAddedEvent}
+     */
     const on_chart_tag_added: EventId<OnChartTagAddedEvent>
-    /** Event type: {@link OnChartTagModifiedEvent} */
+    /**
+     * Event type: {@link OnChartTagModifiedEvent}
+     */
     const on_chart_tag_modified: EventId<OnChartTagModifiedEvent>
-    /** Event type: {@link OnChartTagRemovedEvent} */
+    /**
+     * Event type: {@link OnChartTagRemovedEvent}
+     */
     const on_chart_tag_removed: EventId<OnChartTagRemovedEvent>
-    /** Event type: {@link OnLuaShortcutEvent} */
+    /**
+     * Event type: {@link OnLuaShortcutEvent}
+     */
     const on_lua_shortcut: EventId<OnLuaShortcutEvent>
-    /** Event type: {@link OnGuiLocationChangedEvent} */
+    /**
+     * Event type: {@link OnGuiLocationChangedEvent}
+     */
     const on_gui_location_changed: EventId<OnGuiLocationChangedEvent>
-    /** Event type: {@link OnGuiSelectedTabChangedEvent} */
+    /**
+     * Event type: {@link OnGuiSelectedTabChangedEvent}
+     */
     const on_gui_selected_tab_changed: EventId<OnGuiSelectedTabChangedEvent>
-    /** Event type: {@link OnGuiSwitchStateChangedEvent} */
+    /**
+     * Event type: {@link OnGuiSwitchStateChangedEvent}
+     */
     const on_gui_switch_state_changed: EventId<OnGuiSwitchStateChangedEvent>
-    /** Event type: {@link OnForceCeaseFireChangedEvent} */
+    /**
+     * Event type: {@link OnForceCeaseFireChangedEvent}
+     */
     const on_force_cease_fire_changed: EventId<OnForceCeaseFireChangedEvent>
-    /** Event type: {@link OnForceFriendsChangedEvent} */
+    /**
+     * Event type: {@link OnForceFriendsChangedEvent}
+     */
     const on_force_friends_changed: EventId<OnForceFriendsChangedEvent>
-    /** Event type: {@link OnStringTranslatedEvent} */
+    /**
+     * Event type: {@link OnStringTranslatedEvent}
+     */
     const on_string_translated: EventId<OnStringTranslatedEvent>
-    /** Event type: {@link OnScriptTriggerEffectEvent} */
+    /**
+     * Event type: {@link OnScriptTriggerEffectEvent}
+     */
     const on_script_trigger_effect: EventId<OnScriptTriggerEffectEvent>
-    /** Event type: {@link OnPlayerSetQuickBarSlotEvent} */
+    /**
+     * Event type: {@link OnPlayerSetQuickBarSlotEvent}
+     */
     const on_player_set_quick_bar_slot: EventId<OnPlayerSetQuickBarSlotEvent>
-    /** Event type: {@link OnPrePlayerToggledMapEditorEvent} */
+    /**
+     * Event type: {@link OnPrePlayerToggledMapEditorEvent}
+     */
     const on_pre_player_toggled_map_editor: EventId<OnPrePlayerToggledMapEditorEvent>
-    /** Event type: {@link OnPreScriptInventoryResizedEvent} */
+    /**
+     * Event type: {@link OnPreScriptInventoryResizedEvent}
+     */
     const on_pre_script_inventory_resized: EventId<OnPreScriptInventoryResizedEvent>
-    /** Event type: {@link OnScriptInventoryResizedEvent} */
+    /**
+     * Event type: {@link OnScriptInventoryResizedEvent}
+     */
     const on_script_inventory_resized: EventId<OnScriptInventoryResizedEvent>
-    /** Event type: {@link OnEntityDestroyedEvent} */
+    /**
+     * Event type: {@link OnEntityDestroyedEvent}
+     */
     const on_entity_destroyed: EventId<OnEntityDestroyedEvent>
-    /** Event type: {@link OnPlayerClickedGpsTagEvent} */
+    /**
+     * Event type: {@link OnPlayerClickedGpsTagEvent}
+     */
     const on_player_clicked_gps_tag: EventId<OnPlayerClickedGpsTagEvent>
-    /** Event type: {@link OnPlayerFlushedFluidEvent} */
+    /**
+     * Event type: {@link OnPlayerFlushedFluidEvent}
+     */
     const on_player_flushed_fluid: EventId<OnPlayerFlushedFluidEvent>
-    /** Event type: {@link OnPermissionGroupEditedEvent} */
+    /**
+     * Event type: {@link OnPermissionGroupEditedEvent}
+     */
     const on_permission_group_edited: EventId<OnPermissionGroupEditedEvent>
-    /** Event type: {@link OnPrePermissionStringImportedEvent} */
+    /**
+     * Event type: {@link OnPrePermissionStringImportedEvent}
+     */
     const on_pre_permission_string_imported: EventId<OnPrePermissionStringImportedEvent>
-    /** Event type: {@link OnPermissionStringImportedEvent} */
+    /**
+     * Event type: {@link OnPermissionStringImportedEvent}
+     */
     const on_permission_string_imported: EventId<OnPermissionStringImportedEvent>
-    /** Event type: {@link OnPrePermissionGroupDeletedEvent} */
+    /**
+     * Event type: {@link OnPrePermissionGroupDeletedEvent}
+     */
     const on_pre_permission_group_deleted: EventId<OnPrePermissionGroupDeletedEvent>
-    /** Event type: {@link OnPermissionGroupDeletedEvent} */
+    /**
+     * Event type: {@link OnPermissionGroupDeletedEvent}
+     */
     const on_permission_group_deleted: EventId<OnPermissionGroupDeletedEvent>
-    /** Event type: {@link OnPermissionGroupAddedEvent} */
+    /**
+     * Event type: {@link OnPermissionGroupAddedEvent}
+     */
     const on_permission_group_added: EventId<OnPermissionGroupAddedEvent>
-    /** Event type: {@link OnCutsceneCancelledEvent} */
+    /**
+     * Event type: {@link OnCutsceneCancelledEvent}
+     */
     const on_cutscene_cancelled: EventId<OnCutsceneCancelledEvent>
-    /** Event type: {@link OnPlayerConfiguredSpiderRemoteEvent} */
+    /**
+     * Event type: {@link OnPlayerConfiguredSpiderRemoteEvent}
+     */
     const on_player_configured_spider_remote: EventId<OnPlayerConfiguredSpiderRemoteEvent>
-    /** Event type: {@link OnPlayerUsedSpiderRemoteEvent} */
+    /**
+     * Event type: {@link OnPlayerUsedSpiderRemoteEvent}
+     */
     const on_player_used_spider_remote: EventId<OnPlayerUsedSpiderRemoteEvent>
-    /** Event type: {@link OnSpiderCommandCompletedEvent} */
+    /**
+     * Event type: {@link OnSpiderCommandCompletedEvent}
+     */
     const on_spider_command_completed: EventId<OnSpiderCommandCompletedEvent>
-    /** Event type: {@link OnEntityLogisticSlotChangedEvent} */
+    /**
+     * Event type: {@link OnEntityLogisticSlotChangedEvent}
+     */
     const on_entity_logistic_slot_changed: EventId<OnEntityLogisticSlotChangedEvent>
-    /** Event type: {@link OnEquipmentInsertedEvent} */
+    /**
+     * Event type: {@link OnEquipmentInsertedEvent}
+     */
     const on_equipment_inserted: EventId<OnEquipmentInsertedEvent>
-    /** Event type: {@link OnEquipmentRemovedEvent} */
+    /**
+     * Event type: {@link OnEquipmentRemovedEvent}
+     */
     const on_equipment_removed: EventId<OnEquipmentRemovedEvent>
   }
   /**
-   * 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.
+   * 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.
    *
    * {@link https://lua-api.factorio.com/latest/defines.html#defines.events View documentation}
    */
@@ -1398,9 +1701,7 @@ declare namespace defines {
     middle,
   }
   /**
-   * 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, ...}`.
+   * 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, ...}`.
    *
    * {@link https://lua-api.factorio.com/latest/defines.html#defines.prototypes View documentation}
    */