typed-factorio 0.18.1 → 0.19.0

package/generated/events.d.ts

@@ -8,17 +8,29 @@
  * {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent View documentation}
  */
 interface CustomInputEvent extends EventData {
-  /** The player that activated the custom input. */
+  /**
+   * The player that activated the custom input.
+   */
   readonly player_index: uint
-  /** The prototype name of the custom input that was activated. */
+  /**
+   * The prototype name of the custom input that was activated.
+   */
   readonly input_name: string
-  /** The mouse cursor position when the custom input was activated. */
-  readonly cursor_position: PositionTable
-  /** Information about the prototype that is selected when the custom input is used. `nil` if none is selected. */
+  /**
+   * The mouse cursor position when the custom input was activated.
+   */
+  readonly cursor_position: MapPositionTable
+  /**
+   * Information about the prototype that is selected when the custom input is used. `nil` if none is selected.
+   */
   readonly selected_prototype?: SelectedPrototypeData
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: string
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -28,14 +40,22 @@ interface CustomInputEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_ai_command_completed View documentation}
  */
 interface OnAiCommandCompletedEvent extends EventData {
-  /** Unit_number/group_number of the unit/group which just completed a command. */
+  /**
+   * unit_number/group_number of the unit/group which just completed a command.
+   */
   readonly unit_number: uint
   readonly result: defines.behavior_result
-  /** Was this command generated by a distraction. */
+  /**
+   * Was this command generated by a distraction.
+   */
   readonly was_distracted: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_ai_command_completed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -55,26 +75,34 @@ interface OnAreaClonedEvent extends EventData {
   readonly clone_decoratives: boolean
   readonly clear_destination_entities: boolean
   readonly clear_destination_decoratives: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_area_cloned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when a biter migration builds a base.
  *
- * **Note**: This will be called multiple times for each migration, once for every biter that is sacrificed to build
- * part of the new base.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_biter_base_built View documentation}
+ * @remarks This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
  */
 interface OnBiterBaseBuiltEvent extends EventData {
-  /** The entity that was built. */
+  /**
+   * The entity that was built.
+   */
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_biter_base_built
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -95,9 +123,13 @@ interface OnBrushClonedEvent extends EventData {
   readonly clone_decoratives: boolean
   readonly clear_destination_entities: boolean
   readonly clear_destination_decoratives: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_brush_cloned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -107,13 +139,21 @@ interface OnBrushClonedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_build_base_arrived View documentation}
  */
 interface OnBuildBaseArrivedEvent extends EventData {
-  /** The unit the command was assigned to. */
+  /**
+   * The unit the command was assigned to.
+   */
   readonly unit?: LuaEntity
-  /** The unit group the command was assigned to. */
+  /**
+   * The unit group the command was assigned to.
+   */
   readonly group?: LuaUnitGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_build_base_arrived
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -126,28 +166,39 @@ interface OnBuiltEntityEvent extends EventData {
   readonly created_entity: LuaEntity
   readonly player_index: uint
   readonly stack: LuaItemStack
-  /** The item prototype used to build the entity. Note this won't exist in some situations (built from blueprint, undo, etc). */
+  /**
+   * The item prototype used to build the entity. Note this won't exist in some situations (built from blueprint, undo, etc).
+   */
   readonly item?: LuaItemPrototype
-  /** The tags associated with this entity if any. */
+  /**
+   * The tags associated with this entity if any.
+   */
   readonly tags?: Tags
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_built_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when the deconstruction of an entity is canceled. Can be filtered using
- * {@link LuaEntityDeconstructionCancelledEventFilter}.
+ * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_deconstruction View documentation}
  */
 interface OnCancelledDeconstructionEvent extends EventData {
   readonly entity: LuaEntity
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_cancelled_deconstruction
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -159,25 +210,34 @@ interface OnCancelledDeconstructionEvent extends EventData {
 interface OnCancelledUpgradeEvent extends EventData {
   readonly entity: LuaEntity
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_cancelled_upgrade
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when a character corpse expires due to timeout or all of the items being removed from it.
  *
- * **Note**: this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_character_corpse_expired View documentation}
+ * @remarks this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
  */
 interface OnCharacterCorpseExpiredEvent extends EventData {
-  /** The corpse. */
+  /**
+   * The corpse.
+   */
   readonly corpse: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_character_corpse_expired
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -190,9 +250,13 @@ interface OnChartTagAddedEvent extends EventData {
   readonly tag: LuaCustomChartTag
   readonly force: LuaForce
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_chart_tag_added
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -208,9 +272,13 @@ interface OnChartTagModifiedEvent extends EventData {
   readonly old_text: string
   readonly old_icon?: SignalID
   readonly old_player?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_chart_tag_modified
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -223,9 +291,13 @@ interface OnChartTagRemovedEvent extends EventData {
   readonly tag: LuaCustomChartTag
   readonly force: LuaForce
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_chart_tag_removed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -237,27 +309,39 @@ interface OnChartTagRemovedEvent extends EventData {
 interface OnChunkChartedEvent extends EventData {
   readonly surface_index: uint
   readonly position: ChunkPositionTable
-  /** Area of the chunk. */
+  /**
+   * Area of the chunk.
+   */
   readonly area: BoundingBoxRead
   readonly force: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_chunk_charted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when one or more chunks are deleted using {@link LuaSurface.delete_chunk LuaSurface::delete_chunk}.
+ * Called when one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_chunk_deleted View documentation}
  */
 interface OnChunkDeletedEvent extends EventData {
   readonly surface_index: uint
-  /** The chunks deleted. */
+  /**
+   * The chunks deleted.
+   */
   readonly positions: ChunkPositionTable[]
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_chunk_deleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -267,15 +351,25 @@ interface OnChunkDeletedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_chunk_generated View documentation}
  */
 interface OnChunkGeneratedEvent extends EventData {
-  /** Area of the chunk. */
+  /**
+   * Area of the chunk.
+   */
   readonly area: BoundingBoxRead
-  /** Position of the chunk. */
+  /**
+   * Position of the chunk.
+   */
   readonly position: ChunkPositionTable
-  /** The surface the chunk is on. */
+  /**
+   * The surface the chunk is on.
+   */
   readonly surface: LuaSurface
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_chunk_generated
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -286,29 +380,42 @@ interface OnChunkGeneratedEvent extends EventData {
  */
 interface OnCombatRobotExpiredEvent extends EventData {
   readonly robot: LuaEntity
-  /** The entity that owns the robot if any. */
+  /**
+   * The entity that owns the robot if any.
+   */
   readonly owner?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_combat_robot_expired
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when a message is sent to the in-game console, either by a player or through the server interface.
  *
- * **Note**: This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_console_chat View documentation}
+ * @remarks This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
  */
 interface OnConsoleChatEvent extends EventData {
-  /** The player doing the chatting, if any. */
+  /**
+   * The player doing the chatting, if any.
+   */
   readonly player_index?: uint
-  /** The chat message that was sent. */
+  /**
+   * The chat message that was sent.
+   */
   readonly message: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_console_chat
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -318,15 +425,25 @@ interface OnConsoleChatEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_console_command View documentation}
  */
 interface OnConsoleCommandEvent extends EventData {
-  /** The player if any. */
+  /**
+   * The player if any.
+   */
   readonly player_index?: uint
-  /** The command as typed without the preceding forward slash ('/'). */
+  /**
+   * The command as typed without the preceding forward slash ('/').
+   */
   readonly command: string
-  /** The parameters provided if any. */
+  /**
+   * The parameters provided if any.
+   */
   readonly parameters: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_console_command
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -336,11 +453,17 @@ interface OnConsoleCommandEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_cancelled View documentation}
  */
 interface OnCutsceneCancelledEvent extends EventData {
-  /** The player the cutscene was shown to. */
+  /**
+   * The player the cutscene was shown to.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_cutscene_cancelled
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -349,34 +472,44 @@ interface OnCutsceneCancelledEvent extends EventData {
  *
  * This refers to an index in the table previously passed to set_controller which started the cutscene.
  *
- * **Note**: Due to implementation omission, waypoint_index is 0-based.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_waypoint_reached View documentation}
+ * @remarks Due to implementation omission, waypoint_index is 0-based.
  */
 interface OnCutsceneWaypointReachedEvent extends EventData {
-  /** The player index of the player viewing the cutscene. */
+  /**
+   * The player index of the player viewing the cutscene.
+   */
   readonly player_index: uint
-  /** The index of the waypoint we just completed. */
+  /**
+   * The index of the waypoint we just completed.
+   */
   readonly waypoint_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_cutscene_waypoint_reached
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when the map difficulty settings are changed.
  *
- * **Note**: It's not guaranteed that both settings are changed - just that at least one has been changed.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_difficulty_settings_changed View documentation}
+ * @remarks It's not guaranteed that both settings are changed - just that at least one has been changed.
  */
 interface OnDifficultySettingsChangedEvent extends EventData {
   readonly old_recipe_difficulty: uint
   readonly old_technology_difficulty: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_difficulty_settings_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -388,53 +521,79 @@ interface OnDifficultySettingsChangedEvent extends EventData {
 interface OnEntityClonedEvent extends EventData {
   readonly source: LuaEntity
   readonly destination: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_cloned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter}.
  *
- * **Note**: This is not called when an entities health is set directly by another mod.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_entity_damaged View documentation}
+ * @remarks This is not called when an entities health is set directly by another mod.
  */
 interface OnEntityDamagedEvent extends EventData {
   readonly entity: LuaEntity
   readonly damage_type: LuaDamagePrototype
-  /** The damage amount before resistances. */
+  /**
+   * The damage amount before resistances.
+   */
   readonly original_damage_amount: float
-  /** The damage amount after resistances. */
+  /**
+   * The damage amount after resistances.
+   */
   readonly final_damage_amount: float
-  /** The health of the entity after the damage was applied. */
+  /**
+   * The health of the entity after the damage was applied.
+   */
   readonly final_health: float
-  /** The entity that did the attacking if available. */
+  /**
+   * The entity that did the attacking if available.
+   */
   readonly cause?: LuaEntity
-  /** The force that did the attacking if any. */
+  /**
+   * The force that did the attacking if any.
+   */
   readonly force?: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_damaged
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called after an entity is destroyed that has been registered with
- * {@link LuaBootstrap.register_on_entity_destroyed LuaBootstrap::register_on_entity_destroyed}
+ * Called after an entity is destroyed that has been registered with {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap::register_on_entity_destroyed}
  *
- * **Note**: Depending on when a given entity is destroyed this will be fired at the end of the current tick or end of
- * the next tick.
+ * at the end of the next tick.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_entity_destroyed View documentation}
+ * @remarks Depending on when a given entity is destroyed, this event will be fired at the end of the current tick or
  */
 interface OnEntityDestroyedEvent extends EventData {
+  /**
+   * The number returned by {@link LuaBootstrap#register_on_entity_destroyed register_on_entity_destroyed} to uniquely identify this entity during this event.
+   */
   readonly registration_number: uint64
+  /**
+   * The {@link LuaEntity#unit_number LuaEntity::unit_number} of the destroyed entity, if it had one.
+   */
   readonly unit_number?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_destroyed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -444,40 +603,62 @@ interface OnEntityDestroyedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_entity_died View documentation}
  */
 interface OnEntityDiedEvent extends EventData {
-  /** The entity that died. */
+  /**
+   * The entity that died.
+   */
   readonly entity: LuaEntity
-  /** The entity that did the killing if available. */
+  /**
+   * The entity that did the killing if available.
+   */
   readonly cause?: LuaEntity
-  /** The loot generated by this entity if any. */
+  /**
+   * The loot generated by this entity if any.
+   */
   readonly loot: LuaInventory
-  /** The force that did the killing if any. */
+  /**
+   * The force that did the killing if any.
+   */
   readonly force?: LuaForce
-  /** The damage type if any. */
+  /**
+   * The damage type if any.
+   */
   readonly damage_type?: LuaDamagePrototype
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_died
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when one of an entity's personal logistic slots changes.
  *
- * **Note**: "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the
- * request slots on logistic chests.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_entity_logistic_slot_changed View documentation}
+ * @remarks "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the request slots on logistic chests.
  */
 interface OnEntityLogisticSlotChangedEvent extends EventData {
-  /** The player who changed the slot, or `nil` if changed by script. */
+  /**
+   * The player who changed the slot, or `nil` if changed by script.
+   */
   readonly player_index?: uint
-  /** The entity for whom a logistic slot was changed. */
+  /**
+   * The entity for whom a logistic slot was changed.
+   */
   readonly entity: LuaEntity
-  /** The slot index that was changed. */
+  /**
+   * The slot index that was changed.
+   */
   readonly slot_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_logistic_slot_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -487,14 +668,20 @@ interface OnEntityLogisticSlotChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_entity_renamed View documentation}
  */
 interface OnEntityRenamedEvent extends EventData {
-  /** If by_script is true this will not be included. */
+  /**
+   * If by_script is true this will not be included.
+   */
   readonly player_index?: uint
   readonly by_script: boolean
   readonly entity: LuaEntity
   readonly old_name: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_renamed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -505,13 +692,21 @@ interface OnEntityRenamedEvent extends EventData {
  */
 interface OnEntitySettingsPastedEvent extends EventData {
   readonly player_index: uint
-  /** The source entity settings were copied from. */
+  /**
+   * The source entity settings were copied from.
+   */
   readonly source: LuaEntity
-  /** The destination entity settings were copied to. */
+  /**
+   * The destination entity settings were copied to.
+   */
   readonly destination: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_settings_pasted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -523,9 +718,13 @@ interface OnEntitySettingsPastedEvent extends EventData {
 interface OnEntitySpawnedEvent extends EventData {
   readonly spawner: LuaEntity
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_entity_spawned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -535,13 +734,21 @@ interface OnEntitySpawnedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_equipment_inserted View documentation}
  */
 interface OnEquipmentInsertedEvent extends EventData {
-  /** The equipment grid inserted into. */
+  /**
+   * The equipment grid inserted into.
+   */
   readonly grid: LuaEquipmentGrid
-  /** The equipment inserted. */
+  /**
+   * The equipment inserted.
+   */
   readonly equipment: LuaEquipment
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_equipment_inserted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -551,15 +758,25 @@ interface OnEquipmentInsertedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_equipment_removed View documentation}
  */
 interface OnEquipmentRemovedEvent extends EventData {
-  /** The equipment grid removed from. */
+  /**
+   * The equipment grid removed from.
+   */
   readonly grid: LuaEquipmentGrid
-  /** The equipment removed. */
+  /**
+   * The equipment removed.
+   */
   readonly equipment: string
-  /** The count of equipment removed. */
+  /**
+   * The count of equipment removed.
+   */
   readonly count: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_equipment_removed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -569,32 +786,46 @@ interface OnEquipmentRemovedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_force_cease_fire_changed View documentation}
  */
 interface OnForceCeaseFireChangedEvent extends EventData {
-  /** The force who's cease fire changed. */
+  /**
+   * The force who's cease fire changed.
+   */
   readonly force: LuaForce
-  /** Which force was added or removed. */
+  /**
+   * Which force was added or removed.
+   */
   readonly other_force: LuaForce
-  /** If the other force was added or removed. */
+  /**
+   * If the other force was added or removed.
+   */
   readonly added: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_force_cease_fire_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when a new force is created using `game.create_force()`
  *
- * **Note**: This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will
- * always exist.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_force_created View documentation}
+ * @remarks This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
  */
 interface OnForceCreatedEvent extends EventData {
-  /** The newly created force. */
+  /**
+   * The newly created force.
+   */
   readonly force: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_force_created
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -604,48 +835,71 @@ interface OnForceCreatedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_force_friends_changed View documentation}
  */
 interface OnForceFriendsChangedEvent extends EventData {
-  /** The force who's friends changed. */
+  /**
+   * The force who's friends changed.
+   */
   readonly force: LuaForce
-  /** Which force was added or removed. */
+  /**
+   * Which force was added or removed.
+   */
   readonly other_force: LuaForce
-  /** If the other force was added or removed. */
+  /**
+   * If the other force was added or removed.
+   */
   readonly added: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_force_friends_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when {@link LuaForce.reset LuaForce::reset} is finished.
+ * Called when {@link LuaForce#reset LuaForce::reset} is finished.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_force_reset View documentation}
  */
 interface OnForceResetEvent extends EventData {
   readonly force: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_force_reset
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called after two forces have been merged using `game.merge_forces()`.
  *
- * **Note**: The source force is invalidated before this event is called and the name can be re-used in this event if desired.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_forces_merged View documentation}
+ * @remarks The source force is invalidated before this event is called and the name can be re-used in this event if desired.
  */
 interface OnForcesMergedEvent extends EventData {
-  /** The force destroyed. */
+  /**
+   * The force destroyed.
+   */
   readonly source_name: string
-  /** The index of the destroyed force. */
+  /**
+   * The index of the destroyed force.
+   */
   readonly source_index: uint
-  /** The force entities where reassigned to. */
+  /**
+   * The force entities where reassigned to.
+   */
   readonly destination: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_forces_merged
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -655,28 +909,38 @@ interface OnForcesMergedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_forces_merging View documentation}
  */
 interface OnForcesMergingEvent extends EventData {
-  /** The force to be destroyed */
+  /**
+   * The force to be destroyed
+   */
   readonly source: LuaForce
-  /** The force to reassign entities to. */
+  /**
+   * The force to reassign entities to.
+   */
   readonly destination: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_forces_merging
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * 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.
- *
- * **Note**: This event is not fired when the scenario is loaded via the map editor.
+ * 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.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_game_created_from_scenario View documentation}
+ * @remarks This event is not fired when the scenario is loaded via the map editor.
  */
 interface OnGameCreatedFromScenarioEvent extends EventData {
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_game_created_from_scenario
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -686,13 +950,21 @@ interface OnGameCreatedFromScenarioEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_checked_state_changed View documentation}
  */
 interface OnGuiCheckedStateChangedEvent extends EventData {
-  /** The element whose checked state changed. */
+  /**
+   * The element whose checked state changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_checked_state_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -702,56 +974,92 @@ interface OnGuiCheckedStateChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_click View documentation}
  */
 interface OnGuiClickEvent extends EventData {
-  /** The clicked element. */
+  /**
+   * The clicked element.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the clicking. */
+  /**
+   * The player who did the clicking.
+   */
   readonly player_index: uint
-  /** The mouse button used if any. */
+  /**
+   * The mouse button used if any.
+   */
   readonly button: defines.mouse_button_type
-  /** If alt was pressed. */
+  /**
+   * If alt was pressed.
+   */
   readonly alt: boolean
-  /** If control was pressed. */
+  /**
+   * If control was pressed.
+   */
   readonly control: boolean
-  /** If shift was pressed. */
+  /**
+   * If shift was pressed.
+   */
   readonly shift: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_click
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when the player closes the GUI they have open.
  *
- * **Note**: This is only called if the player explicitly closed the GUI.
- *
- * **Note**: 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.
+ * 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.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_closed View documentation}
+ * @remarks It's not advised to open any other GUI during this event because if this is run as a request to open a different GUI the game will force close the new opened GUI without notice to ensure the original requested GUI is opened.
  */
 interface OnGuiClosedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** The GUI type that was open. */
+  /**
+   * The GUI type that was open.
+   */
   readonly gui_type: defines.gui_type
-  /** The entity that was open */
+  /**
+   * The entity that was open
+   */
   readonly entity?: LuaEntity
-  /** The item that was open */
+  /**
+   * The item that was open
+   */
   readonly item?: LuaItemStack
-  /** The equipment that was open */
+  /**
+   * The equipment that was open
+   */
   readonly equipment?: LuaEquipment
-  /** The other player that was open */
+  /**
+   * The other player that was open
+   */
   readonly other_player?: LuaPlayer
-  /** The custom GUI element that was open */
+  /**
+   * The custom GUI element that was open
+   */
   readonly element?: LuaGuiElement
-  /** The technology that was automatically selected when opening the research GUI */
+  /**
+   * The technology that was automatically selected when opening the research GUI
+   */
   readonly technology?: LuaTechnology
-  /** The tile position that was open */
+  /**
+   * The tile position that was open
+   */
   readonly tile_position?: TilePositionTable
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_closed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -761,19 +1069,33 @@ interface OnGuiClosedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_confirmed View documentation}
  */
 interface OnGuiConfirmedEvent extends EventData {
-  /** The confirmed element. */
+  /**
+   * The confirmed element.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the confirming. */
+  /**
+   * The player who did the confirming.
+   */
   readonly player_index: uint
-  /** If alt was pressed. */
+  /**
+   * If alt was pressed.
+   */
   readonly alt: boolean
-  /** If control was pressed. */
+  /**
+   * If control was pressed.
+   */
   readonly control: boolean
-  /** If shift was pressed. */
+  /**
+   * If shift was pressed.
+   */
   readonly shift: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_confirmed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -783,13 +1105,21 @@ interface OnGuiConfirmedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_elem_changed View documentation}
  */
 interface OnGuiElemChangedEvent extends EventData {
-  /** The element whose element value changed. */
+  /**
+   * The element whose element value changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_elem_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -799,13 +1129,21 @@ interface OnGuiElemChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_location_changed View documentation}
  */
 interface OnGuiLocationChangedEvent extends EventData {
-  /** The element whose location changed. */
+  /**
+   * The element whose location changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_location_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -815,23 +1153,41 @@ interface OnGuiLocationChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_opened View documentation}
  */
 interface OnGuiOpenedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** The GUI type that was opened. */
+  /**
+   * The GUI type that was opened.
+   */
   readonly gui_type: defines.gui_type
-  /** The entity that was opened */
+  /**
+   * The entity that was opened
+   */
   readonly entity?: LuaEntity
-  /** The item that was opened */
+  /**
+   * The item that was opened
+   */
   readonly item?: LuaItemStack
-  /** The equipment that was opened */
+  /**
+   * The equipment that was opened
+   */
   readonly equipment?: LuaEquipment
-  /** The other player that was opened */
+  /**
+   * The other player that was opened
+   */
   readonly other_player?: LuaPlayer
-  /** The custom GUI element that was opened */
+  /**
+   * The custom GUI element that was opened
+   */
   readonly element?: LuaGuiElement
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_opened
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -841,13 +1197,21 @@ interface OnGuiOpenedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_selected_tab_changed View documentation}
  */
 interface OnGuiSelectedTabChangedEvent extends EventData {
-  /** The tabbed pane whose selected tab changed. */
+  /**
+   * The tabbed pane whose selected tab changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_selected_tab_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -857,13 +1221,21 @@ interface OnGuiSelectedTabChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_selection_state_changed View documentation}
  */
 interface OnGuiSelectionStateChangedEvent extends EventData {
-  /** The element whose selection state changed. */
+  /**
+   * The element whose selection state changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_selection_state_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -873,13 +1245,21 @@ interface OnGuiSelectionStateChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_switch_state_changed View documentation}
  */
 interface OnGuiSwitchStateChangedEvent extends EventData {
-  /** The switch whose switch state changed. */
+  /**
+   * The switch whose switch state changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_switch_state_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -889,15 +1269,25 @@ interface OnGuiSwitchStateChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_text_changed View documentation}
  */
 interface OnGuiTextChangedEvent extends EventData {
-  /** The edited element. */
+  /**
+   * The edited element.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the edit. */
+  /**
+   * The player who did the edit.
+   */
   readonly player_index: uint
-  /** The new text in the element. */
+  /**
+   * The new text in the element.
+   */
   readonly text: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_text_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -907,13 +1297,21 @@ interface OnGuiTextChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_gui_value_changed View documentation}
  */
 interface OnGuiValueChangedEvent extends EventData {
-  /** The element whose value changed. */
+  /**
+   * The element whose value changed.
+   */
   readonly element: LuaGuiElement
-  /** The player who did the change. */
+  /**
+   * The player who did the change.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_gui_value_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -924,9 +1322,13 @@ interface OnGuiValueChangedEvent extends EventData {
  */
 interface OnLandMineArmedEvent extends EventData {
   readonly mine: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_land_mine_armed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -937,32 +1339,40 @@ interface OnLandMineArmedEvent extends EventData {
  */
 interface OnLuaShortcutEvent extends EventData {
   readonly player_index: uint
-  /** Shortcut prototype name of the shortcut that was clicked. */
+  /**
+   * Shortcut prototype name of the shortcut that was clicked.
+   */
   readonly prototype_name: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_lua_shortcut
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered
- * using {@link LuaEntityMarkedForDeconstructionEventFilter}.
+ * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_deconstruction View documentation}
  */
 interface OnMarkedForDeconstructionEvent extends EventData {
   readonly entity: LuaEntity
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_marked_for_deconstruction
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using
- * {@link LuaEntityMarkedForUpgradeEventFilter}.
+ * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_upgrade View documentation}
  */
@@ -970,11 +1380,17 @@ interface OnMarkedForUpgradeEvent extends EventData {
   readonly entity: LuaEntity
   readonly target: LuaEntityPrototype
   readonly player_index?: uint
-  /** The new direction (if any) */
+  /**
+   * The new direction (if any)
+   */
   readonly direction?: defines.direction
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_marked_for_upgrade
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -984,17 +1400,29 @@ interface OnMarkedForUpgradeEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_market_item_purchased View documentation}
  */
 interface OnMarketItemPurchasedEvent extends EventData {
-  /** The player who did the purchasing. */
+  /**
+   * The player who did the purchasing.
+   */
   readonly player_index: uint
-  /** The market entity. */
+  /**
+   * The market entity.
+   */
   readonly market: LuaEntity
-  /** The index of the offer purchased. */
+  /**
+   * The index of the offer purchased.
+   */
   readonly offer_index: uint
-  /** The amount of offers purchased. */
+  /**
+   * The amount of offers purchased.
+   */
   readonly count: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_market_item_purchased
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1004,13 +1432,21 @@ interface OnMarketItemPurchasedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_mod_item_opened View documentation}
  */
 interface OnModItemOpenedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** The item clicked on. */
+  /**
+   * The item clicked on.
+   */
   readonly item: LuaItemPrototype
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_mod_item_opened
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1020,13 +1456,21 @@ interface OnModItemOpenedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_added View documentation}
  */
 interface OnPermissionGroupAddedEvent extends EventData {
-  /** The player that added the group. */
+  /**
+   * The player that added the group.
+   */
   readonly player_index: uint
-  /** The group added. */
+  /**
+   * The group added.
+   */
   readonly group: LuaPermissionGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_permission_group_added
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1036,15 +1480,25 @@ interface OnPermissionGroupAddedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_deleted View documentation}
  */
 interface OnPermissionGroupDeletedEvent extends EventData {
-  /** The player doing the deletion. */
+  /**
+   * The player doing the deletion.
+   */
   readonly player_index: uint
-  /** The group that was deleted. */
+  /**
+   * The group that was deleted.
+   */
   readonly group_name: string
-  /** The group id that was deleted. */
+  /**
+   * The group id that was deleted.
+   */
   readonly id: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_permission_group_deleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1054,11 +1508,17 @@ interface OnPermissionGroupDeletedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_edited View documentation}
  */
 interface OnPermissionGroupEditedEvent extends EventData {
-  /** The player that did the editing. */
+  /**
+   * The player that did the editing.
+   */
   readonly player_index: uint
-  /** The group being edited. */
+  /**
+   * The group being edited.
+   */
   readonly group: LuaPermissionGroup
-  /** The edit type: "add-permission", "remove-permission", "enable-all", "disable-all", "add-player", "remove-player", "rename". */
+  /**
+   * The edit type: "add-permission", "remove-permission", "enable-all", "disable-all", "add-player", "remove-player", "rename".
+   */
   readonly type:
     | "add-permission"
     | "remove-permission"
@@ -1067,17 +1527,29 @@ interface OnPermissionGroupEditedEvent extends EventData {
     | "add-player"
     | "remove-player"
     | "rename"
-  /** The action when the `type` is "add-permission" or "remove-permission". */
+  /**
+   * The action when the `type` is "add-permission" or "remove-permission".
+   */
   readonly action: defines.input_action
-  /** The other player when the `type` is "add-player" or "remove-player". */
+  /**
+   * The other player when the `type` is "add-player" or "remove-player".
+   */
   readonly other_player_index: uint
-  /** The old group name when the `type` is "rename". */
+  /**
+   * The old group name when the `type` is "rename".
+   */
   readonly old_name: string
-  /** The new group name when the `type` is "rename". */
+  /**
+   * The new group name when the `type` is "rename".
+   */
   readonly new_name: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_permission_group_edited
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1087,11 +1559,17 @@ interface OnPermissionGroupEditedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_permission_string_imported View documentation}
  */
 interface OnPermissionStringImportedEvent extends EventData {
-  /** The player that imported the string. */
+  /**
+   * The player that imported the string.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_permission_string_imported
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1103,9 +1581,13 @@ interface OnPermissionStringImportedEvent extends EventData {
 interface OnPickedUpItemEvent extends EventData {
   readonly item_stack: SimpleItemStack
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_picked_up_item
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1115,21 +1597,37 @@ interface OnPickedUpItemEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area View documentation}
  */
 interface OnPlayerAltSelectedAreaEvent extends EventData {
-  /** The player doing the selection. */
+  /**
+   * The player doing the selection.
+   */
   readonly player_index: uint
-  /** The surface selected. */
+  /**
+   * The surface selected.
+   */
   readonly surface: LuaSurface
-  /** The area selected. */
+  /**
+   * The area selected.
+   */
   readonly area: BoundingBoxRead
-  /** The item used to select the area. */
+  /**
+   * The item used to select the area.
+   */
   readonly item: string
-  /** The entities selected. */
+  /**
+   * The entities selected.
+   */
   readonly entities: LuaEntity[]
-  /** The tiles selected. */
+  /**
+   * The tiles selected.
+   */
   readonly tiles: LuaTile[]
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_alt_selected_area
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1140,9 +1638,13 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
  */
 interface OnPlayerAmmoInventoryChangedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_ammo_inventory_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1153,9 +1655,13 @@ interface OnPlayerAmmoInventoryChangedEvent extends EventData {
  */
 interface OnPlayerArmorInventoryChangedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_armor_inventory_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1165,17 +1671,29 @@ interface OnPlayerArmorInventoryChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_banned View documentation}
  */
 interface OnPlayerBannedEvent extends EventData {
-  /** The player banned. */
+  /**
+   * The player banned.
+   */
   readonly player_index?: uint
-  /** The banned player name. */
+  /**
+   * The banned player name.
+   */
   readonly player_name: string
-  /** The player that did the banning if any. */
+  /**
+   * The player that did the banning if any.
+   */
   readonly by_player?: uint
-  /** The reason given if any. */
+  /**
+   * The reason given if any.
+   */
   readonly reason?: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_banned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1186,19 +1704,33 @@ interface OnPlayerBannedEvent extends EventData {
  */
 interface OnPlayerBuiltTileEvent extends EventData {
   readonly player_index: uint
-  /** The surface the tile(s) were built on. */
+  /**
+   * The surface the tile(s) were built on.
+   */
   readonly surface_index: uint
-  /** The position data. */
+  /**
+   * The position data.
+   */
   readonly tiles: OldTileAndPosition[]
-  /** The tile prototype that was placed. */
+  /**
+   * The tile prototype that was placed.
+   */
   readonly tile: LuaTilePrototype
-  /** The item type used to build the tiles */
+  /**
+   * The item type used to build the tiles
+   */
   readonly item?: LuaItemPrototype
-  /** The stack used to build the tiles (may be empty if all of the items where used to build the tiles). */
+  /**
+   * The stack used to build the tiles (may be empty if all of the items where used to build the tiles).
+   */
   readonly stack?: LuaItemStack
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_built_tile
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1208,17 +1740,29 @@ interface OnPlayerBuiltTileEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_cancelled_crafting View documentation}
  */
 interface OnPlayerCancelledCraftingEvent extends EventData {
-  /** The player that did the crafting. */
+  /**
+   * The player that did the crafting.
+   */
   readonly player_index: uint
-  /** The crafting items returned to the player's inventory. */
+  /**
+   * The crafting items returned to the player's inventory.
+   */
   readonly items: LuaInventory
-  /** The recipe that has been cancelled. */
+  /**
+   * The recipe that has been cancelled.
+   */
   readonly recipe: LuaRecipe
-  /** The number of crafts that have been cancelled. */
+  /**
+   * The number of crafts that have been cancelled.
+   */
   readonly cancel_count: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_cancelled_crafting
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1228,13 +1772,21 @@ interface OnPlayerCancelledCraftingEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_force View documentation}
  */
 interface OnPlayerChangedForceEvent extends EventData {
-  /** The player who changed forces. */
+  /**
+   * The player who changed forces.
+   */
   readonly player_index: uint
-  /** The old force. */
+  /**
+   * The old force.
+   */
   readonly force: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_changed_force
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1244,29 +1796,42 @@ interface OnPlayerChangedForceEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_position View documentation}
  */
 interface OnPlayerChangedPositionEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_changed_position
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called after a player changes surfaces.
  *
- * **Note**: In the instance a player is moved off a surface due to it being deleted this is not called.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_surface View documentation}
+ * @remarks In the instance a player is moved off a surface due to it being deleted this is not called.
  */
 interface OnPlayerChangedSurfaceEvent extends EventData {
-  /** The player who changed surfaces. */
+  /**
+   * The player who changed surfaces.
+   */
   readonly player_index: uint
-  /** The surface index the player was on. */
+  /**
+   * The surface index the player was on.
+   */
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_changed_surface
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1276,11 +1841,17 @@ interface OnPlayerChangedSurfaceEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_disabled View documentation}
  */
 interface OnPlayerCheatModeDisabledEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_cheat_mode_disabled
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1290,11 +1861,17 @@ interface OnPlayerCheatModeDisabledEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_enabled View documentation}
  */
 interface OnPlayerCheatModeEnabledEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_cheat_mode_enabled
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1304,15 +1881,25 @@ interface OnPlayerCheatModeEnabledEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag View documentation}
  */
 interface OnPlayerClickedGpsTagEvent extends EventData {
-  /** Index of the player */
+  /**
+   * Index of the player
+   */
   readonly player_index: uint
-  /** Map position contained in gps tag */
-  readonly position: PositionTable
-  /** Surface name contained in gps tag, even when such surface does not exists */
+  /**
+   * Map position contained in gps tag
+   */
+  readonly position: MapPositionTable
+  /**
+   * Surface name contained in gps tag, even when such surface does not exists
+   */
   readonly surface: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_clicked_gps_tag
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1322,11 +1909,17 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_blueprint View documentation}
  */
 interface OnPlayerConfiguredBlueprintEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_configured_blueprint
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1336,32 +1929,49 @@ interface OnPlayerConfiguredBlueprintEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_spider_remote View documentation}
  */
 interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
-  /** The player that configured the remote. */
+  /**
+   * The player that configured the remote.
+   */
   readonly player_index: uint
-  /** Spider vehicle to which remote was connected to. */
+  /**
+   * Spider vehicle to which remote was connected to.
+   */
   readonly vehicle: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_configured_spider_remote
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * 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}).
+ * 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}).
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_crafted_item View documentation}
  */
 interface OnPlayerCraftedItemEvent extends EventData {
-  /** The item that has been crafted. */
+  /**
+   * The item that has been crafted.
+   */
   readonly item_stack: LuaItemStack
-  /** The player doing the crafting. */
+  /**
+   * The player doing the crafting.
+   */
   readonly player_index: uint
-  /** The recipe used to craft this item. */
+  /**
+   * The recipe used to craft this item.
+   */
   readonly recipe: LuaRecipe
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_crafted_item
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1372,9 +1982,13 @@ interface OnPlayerCraftedItemEvent extends EventData {
  */
 interface OnPlayerCreatedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_created
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1385,9 +1999,13 @@ interface OnPlayerCreatedEvent extends EventData {
  */
 interface OnPlayerCursorStackChangedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_cursor_stack_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1397,19 +2015,33 @@ interface OnPlayerCursorStackChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_deconstructed_area View documentation}
  */
 interface OnPlayerDeconstructedAreaEvent extends EventData {
-  /** The player doing the selection. */
+  /**
+   * The player doing the selection.
+   */
   readonly player_index: uint
-  /** The surface selected. */
+  /**
+   * The surface selected.
+   */
   readonly surface: LuaSurface
-  /** The area selected. */
+  /**
+   * The area selected.
+   */
   readonly area: BoundingBoxRead
-  /** The item used to select the area. */
+  /**
+   * The item used to select the area.
+   */
   readonly item: string
-  /** If normal selection or alt selection was used. */
+  /**
+   * If normal selection or alt selection was used.
+   */
   readonly alt: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_deconstructed_area
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1419,11 +2051,17 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_demoted View documentation}
  */
 interface OnPlayerDemotedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_demoted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1435,9 +2073,13 @@ interface OnPlayerDemotedEvent extends EventData {
 interface OnPlayerDiedEvent extends EventData {
   readonly player_index: uint
   readonly cause?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_died
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1447,13 +2089,21 @@ interface OnPlayerDiedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_display_resolution_changed View documentation}
  */
 interface OnPlayerDisplayResolutionChangedEvent extends EventData {
-  /** The player */
+  /**
+   * The player
+   */
   readonly player_index: uint
-  /** The old display resolution */
+  /**
+   * The old display resolution
+   */
   readonly old_resolution: DisplayResolution
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_display_resolution_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1463,13 +2113,21 @@ interface OnPlayerDisplayResolutionChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_display_scale_changed View documentation}
  */
 interface OnPlayerDisplayScaleChangedEvent extends EventData {
-  /** The player */
+  /**
+   * The player
+   */
   readonly player_index: uint
-  /** The old display scale */
+  /**
+   * The old display scale
+   */
   readonly old_scale: double
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_display_scale_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1480,11 +2138,17 @@ interface OnPlayerDisplayScaleChangedEvent extends EventData {
  */
 interface OnPlayerDrivingChangedStateEvent extends EventData {
   readonly player_index: uint
-  /** The vehicle if any. */
+  /**
+   * The vehicle if any.
+   */
   readonly entity?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_driving_changed_state
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1495,11 +2159,17 @@ interface OnPlayerDrivingChangedStateEvent extends EventData {
  */
 interface OnPlayerDroppedItemEvent extends EventData {
   readonly player_index: uint
-  /** The item-on-ground entity. */
+  /**
+   * The item-on-ground entity.
+   */
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_dropped_item
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1509,15 +2179,25 @@ interface OnPlayerDroppedItemEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_fast_transferred View documentation}
  */
 interface OnPlayerFastTransferredEvent extends EventData {
-  /** The player transferred from or to. */
+  /**
+   * The player transferred from or to.
+   */
   readonly player_index: uint
-  /** The entity transferred from or to. */
+  /**
+   * The entity transferred from or to.
+   */
   readonly entity: LuaEntity
-  /** Whether the transfer was from player to entity. If `false`, the transfer was from entity to player. */
+  /**
+   * Whether the transfer was from player to entity. If `false`, the transfer was from entity to player.
+   */
   readonly from_player: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_fast_transferred
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1527,19 +2207,33 @@ interface OnPlayerFastTransferredEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_flushed_fluid View documentation}
  */
 interface OnPlayerFlushedFluidEvent extends EventData {
-  /** Index of the player */
+  /**
+   * Index of the player
+   */
   readonly player_index: uint
-  /** Name of a fluid that was flushed */
+  /**
+   * Name of a fluid that was flushed
+   */
   readonly fluid: string
-  /** Amount of fluid that was removed */
+  /**
+   * Amount of fluid that was removed
+   */
   readonly amount: double
-  /** Entity from which flush was performed */
+  /**
+   * Entity from which flush was performed
+   */
   readonly entity: LuaEntity
-  /** True if flush was requested only on this entity */
+  /**
+   * True if flush was requested only on this entity
+   */
   readonly only_this_entity: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_flushed_fluid
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1550,9 +2244,13 @@ interface OnPlayerFlushedFluidEvent extends EventData {
  */
 interface OnPlayerGunInventoryChangedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_gun_inventory_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1563,9 +2261,13 @@ interface OnPlayerGunInventoryChangedEvent extends EventData {
  */
 interface OnPlayerJoinedGameEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_joined_game
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1575,15 +2277,25 @@ interface OnPlayerJoinedGameEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_kicked View documentation}
  */
 interface OnPlayerKickedEvent extends EventData {
-  /** The player kicked. */
+  /**
+   * The player kicked.
+   */
   readonly player_index: uint
-  /** The player that did the kicking if any. */
+  /**
+   * The player that did the kicking if any.
+   */
   readonly by_player?: uint
-  /** The reason given if any. */
+  /**
+   * The reason given if any.
+   */
   readonly reason?: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_kicked
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1595,9 +2307,13 @@ interface OnPlayerKickedEvent extends EventData {
 interface OnPlayerLeftGameEvent extends EventData {
   readonly player_index: uint
   readonly reason: defines.disconnect_reason
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_left_game
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1608,32 +2324,42 @@ interface OnPlayerLeftGameEvent extends EventData {
  */
 interface OnPlayerMainInventoryChangedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_main_inventory_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event
- * any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered
- * using {@link LuaPlayerMinedEntityEventFilter}.
- *
- * **Note**: 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.
+ * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using {@link LuaPlayerMinedEntityEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_entity View documentation}
+ * @remarks The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
  */
 interface OnPlayerMinedEntityEvent extends EventData {
-  /** The index of the player doing the mining. */
+  /**
+   * The index of the player doing the mining.
+   */
   readonly player_index: uint
-  /** The entity that has been mined. */
+  /**
+   * The entity that has been mined.
+   */
   readonly entity: LuaEntity
-  /** The temporary inventory that holds the result of mining the entity. */
+  /**
+   * The temporary inventory that holds the result of mining the entity.
+   */
   readonly buffer: LuaInventory
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_mined_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1643,12 +2369,18 @@ interface OnPlayerMinedEntityEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_item View documentation}
  */
 interface OnPlayerMinedItemEvent extends EventData {
-  /** The item given to the player */
+  /**
+   * The item given to the player
+   */
   readonly item_stack: SimpleItemStack
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_mined_item
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1659,13 +2391,21 @@ interface OnPlayerMinedItemEvent extends EventData {
  */
 interface OnPlayerMinedTileEvent extends EventData {
   readonly player_index: uint
-  /** The surface the tile(s) were mined from. */
+  /**
+   * The surface the tile(s) were mined from.
+   */
   readonly surface_index: uint
-  /** The position data. */
+  /**
+   * The position data.
+   */
   readonly tiles: OldTileAndPosition[]
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_mined_tile
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1675,11 +2415,17 @@ interface OnPlayerMinedTileEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_muted View documentation}
  */
 interface OnPlayerMutedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_muted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1689,15 +2435,25 @@ interface OnPlayerMutedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_pipette View documentation}
  */
 interface OnPlayerPipetteEvent extends EventData {
-  /** The player */
+  /**
+   * The player
+   */
   readonly player_index: uint
-  /** The item put in the cursor */
+  /**
+   * The item put in the cursor
+   */
   readonly item: LuaItemPrototype
-  /** If cheat mode was used to give a free stack of the item. */
+  /**
+   * If cheat mode was used to give a free stack of the item.
+   */
   readonly used_cheat_mode: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_pipette
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1708,13 +2464,21 @@ interface OnPlayerPipetteEvent extends EventData {
  */
 interface OnPlayerPlacedEquipmentEvent extends EventData {
   readonly player_index: uint
-  /** The equipment put in the equipment grid. */
+  /**
+   * The equipment put in the equipment grid.
+   */
   readonly equipment: LuaEquipment
-  /** The equipment grid the equipment was put in. */
+  /**
+   * The equipment grid the equipment was put in.
+   */
   readonly grid: LuaEquipmentGrid
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_placed_equipment
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1724,26 +2488,37 @@ interface OnPlayerPlacedEquipmentEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_promoted View documentation}
  */
 interface OnPlayerPromotedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_promoted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is
- * different in that the player is deleted as if he never existed in the save file.
+ * Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_removed View documentation}
  */
 interface OnPlayerRemovedEvent extends EventData {
-  /** The player index that was removed */
+  /**
+   * The player index that was removed
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_removed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1754,15 +2529,25 @@ interface OnPlayerRemovedEvent extends EventData {
  */
 interface OnPlayerRemovedEquipmentEvent extends EventData {
   readonly player_index: uint
-  /** The equipment grid removed from. */
+  /**
+   * The equipment grid removed from.
+   */
   readonly grid: LuaEquipmentGrid
-  /** The equipment removed. */
+  /**
+   * The equipment removed.
+   */
   readonly equipment: string
-  /** The count of equipment removed. */
+  /**
+   * The count of equipment removed.
+   */
   readonly count: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_removed_equipment
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1774,9 +2559,13 @@ interface OnPlayerRemovedEquipmentEvent extends EventData {
 interface OnPlayerRepairedEntityEvent extends EventData {
   readonly player_index: uint
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_repaired_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1787,29 +2576,42 @@ interface OnPlayerRepairedEntityEvent extends EventData {
  */
 interface OnPlayerRespawnedEvent extends EventData {
   readonly player_index: uint
-  /** The player port used to respawn if one was used. */
+  /**
+   * The player port used to respawn if one was used.
+   */
   readonly player_port?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_respawned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * 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.
+ * 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.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_rotated_entity View documentation}
  */
 interface OnPlayerRotatedEntityEvent extends EventData {
-  /** The rotated entity. */
+  /**
+   * The rotated entity.
+   */
   readonly entity: LuaEntity
-  /** The previous direction */
+  /**
+   * The previous direction
+   */
   readonly previous_direction: defines.direction
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_rotated_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1819,21 +2621,37 @@ interface OnPlayerRotatedEntityEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_selected_area View documentation}
  */
 interface OnPlayerSelectedAreaEvent extends EventData {
-  /** The player doing the selection. */
+  /**
+   * The player doing the selection.
+   */
   readonly player_index: uint
-  /** The surface selected. */
+  /**
+   * The surface selected.
+   */
   readonly surface: LuaSurface
-  /** The area selected. */
+  /**
+   * The area selected.
+   */
   readonly area: BoundingBoxRead
-  /** The item used to select the area. */
+  /**
+   * The item used to select the area.
+   */
   readonly item: string
-  /** The entities selected. */
+  /**
+   * The entities selected.
+   */
   readonly entities: LuaEntity[]
-  /** The tiles selected. */
+  /**
+   * The tiles selected.
+   */
   readonly tiles: LuaTile[]
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_selected_area
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1844,9 +2662,13 @@ interface OnPlayerSelectedAreaEvent extends EventData {
  */
 interface OnPlayerSetQuickBarSlotEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_set_quick_bar_slot
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1856,21 +2678,37 @@ interface OnPlayerSetQuickBarSlotEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_setup_blueprint View documentation}
  */
 interface OnPlayerSetupBlueprintEvent extends EventData {
-  /** The player doing the selection. */
+  /**
+   * The player doing the selection.
+   */
   readonly player_index: uint
-  /** The surface selected. */
+  /**
+   * The surface selected.
+   */
   readonly surface: LuaSurface
-  /** The area selected. */
+  /**
+   * The area selected.
+   */
   readonly area: BoundingBoxRead
-  /** The item used to select the area. */
+  /**
+   * The item used to select the area.
+   */
   readonly item: string
-  /** If normal selection or alt selection was used. */
+  /**
+   * If normal selection or alt selection was used.
+   */
   readonly alt: boolean
-  /** The blueprint entity index to source entity mapping. Note: if any mod changes the blueprint this will be incorrect. */
+  /**
+   * The blueprint entity index to source entity mapping. Note: if any mod changes the blueprint this will be incorrect.
+   */
   readonly mapping: LuaLazyLoadedValue<Record<uint, LuaEntity>>
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_setup_blueprint
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1882,13 +2720,16 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
 interface OnPlayerToggledAltModeEvent extends EventData {
   readonly player_index: uint
   /**
-   * The new alt mode value. This value is a shortcut for accessing
-   * {@link GameViewSettings.show_entity_info GameViewSettings::show_entity_info} on the player.
+   * The new alt mode value. This value is a shortcut for accessing {@link GameViewSettings#show_entity_info GameViewSettings::show_entity_info} on the player.
    */
   readonly alt_mode: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_toggled_alt_mode
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1899,9 +2740,13 @@ interface OnPlayerToggledAltModeEvent extends EventData {
  */
 interface OnPlayerToggledMapEditorEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_toggled_map_editor
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1912,9 +2757,13 @@ interface OnPlayerToggledMapEditorEvent extends EventData {
  */
 interface OnPlayerTrashInventoryChangedEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_trash_inventory_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1924,17 +2773,29 @@ interface OnPlayerTrashInventoryChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_unbanned View documentation}
  */
 interface OnPlayerUnbannedEvent extends EventData {
-  /** The player un-banned. */
+  /**
+   * The player un-banned.
+   */
   readonly player_index?: uint
-  /** The player name un-banned. */
+  /**
+   * The player name un-banned.
+   */
   readonly player_name: string
-  /** The player that did the un-banning if any. */
+  /**
+   * The player that did the un-banning if any.
+   */
   readonly by_player?: uint
-  /** The reason the player was banned if any. */
+  /**
+   * The reason the player was banned if any.
+   */
   readonly reason?: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_unbanned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1944,11 +2805,17 @@ interface OnPlayerUnbannedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_unmuted View documentation}
  */
 interface OnPlayerUnmutedEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_unmuted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1958,15 +2825,25 @@ interface OnPlayerUnmutedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_used_capsule View documentation}
  */
 interface OnPlayerUsedCapsuleEvent extends EventData {
-  /** The player. */
+  /**
+   * The player.
+   */
   readonly player_index: uint
-  /** The capsule item used. */
+  /**
+   * The capsule item used.
+   */
   readonly item: LuaItemPrototype
-  /** The position the capsule was used. */
-  readonly position: PositionTable
-  /** Identifier of the event */
+  /**
+   * The position the capsule was used.
+   */
+  readonly position: MapPositionTable
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_used_capsule
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1976,17 +2853,29 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_player_used_spider_remote View documentation}
  */
 interface OnPlayerUsedSpiderRemoteEvent extends EventData {
-  /** The player that used the remote. */
+  /**
+   * The player that used the remote.
+   */
   readonly player_index: uint
-  /** Spider vehicle which was requested to move. */
+  /**
+   * Spider vehicle which was requested to move.
+   */
   readonly vehicle: LuaEntity
-  /** Goal position to which spidertron was sent to. */
-  readonly position: PositionTable
-  /** If the use was successful. It may fail when spidertron has different driver or when player is on different surface. */
+  /**
+   * Goal position to which spidertron was sent to.
+   */
+  readonly position: MapPositionTable
+  /**
+   * If the use was successful. It may fail when spidertron has different driver or when player is on different surface.
+   */
   readonly success: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_player_used_spider_remote
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -1996,25 +2885,45 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_post_entity_died View documentation}
  */
 interface OnPostEntityDiedEvent extends EventData {
-  /** The ghost created by the entity dying if any. */
+  /**
+   * The ghost created by the entity dying if any.
+   */
   readonly ghost?: LuaEntity
-  /** The force that did the killing if any. */
+  /**
+   * The force that did the killing if any.
+   */
   readonly force?: LuaForce
-  /** Position where the entity died. */
-  readonly position: PositionTable
-  /** The entity prototype of the entity that died. */
+  /**
+   * Position where the entity died.
+   */
+  readonly position: MapPositionTable
+  /**
+   * The entity prototype of the entity that died.
+   */
   readonly prototype: LuaEntityPrototype
-  /** The damage type if any. */
+  /**
+   * The damage type if any.
+   */
   readonly damage_type?: LuaDamagePrototype
-  /** The corpses created by the entity dying if any. */
+  /**
+   * The corpses created by the entity dying if any.
+   */
   readonly corpses: LuaEntity[]
-  /** The surface the entity was on. */
+  /**
+   * The surface the entity was on.
+   */
   readonly surface_index: uint
-  /** The unit number the entity had if any. */
+  /**
+   * The unit number the entity had if any.
+   */
   readonly unit_number?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_post_entity_died
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2024,38 +2933,62 @@ interface OnPostEntityDiedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_build View documentation}
  */
 interface OnPreBuildEvent extends EventData {
-  /** The player who did the placing. */
+  /**
+   * The player who did the placing.
+   */
   readonly player_index: uint
-  /** Where the item was placed. */
-  readonly position: PositionTable
-  /** Item was placed using shift building. */
+  /**
+   * Where the item was placed.
+   */
+  readonly position: MapPositionTable
+  /**
+   * Item was placed using shift building.
+   */
   readonly shift_build: boolean
-  /** The direction the item was facing when placed. */
+  /**
+   * The direction the item was facing when placed.
+   */
   readonly direction: defines.direction
-  /** If building this blueprint was flipped horizontally. */
+  /**
+   * If building this blueprint was flipped horizontally.
+   */
   readonly flip_horizontal: boolean
-  /** If building this blueprint was flipped vertically. */
+  /**
+   * If building this blueprint was flipped vertically.
+   */
   readonly flip_vertical: boolean
-  /** Item was placed while moving. */
+  /**
+   * Item was placed while moving.
+   */
   readonly created_by_moving: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_build
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called before one or more chunks are deleted using {@link LuaSurface.delete_chunk LuaSurface::delete_chunk}.
+ * Called before one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_chunk_deleted View documentation}
  */
 interface OnPreChunkDeletedEvent extends EventData {
   readonly surface_index: uint
-  /** The chunks to be deleted. */
+  /**
+   * The chunks to be deleted.
+   */
   readonly positions: ChunkPositionTable[]
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_chunk_deleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2066,29 +2999,42 @@ interface OnPreChunkDeletedEvent extends EventData {
  */
 interface OnPreEntitySettingsPastedEvent extends EventData {
   readonly player_index: uint
-  /** The source entity settings will be copied from. */
+  /**
+   * The source entity settings will be copied from.
+   */
   readonly source: LuaEntity
-  /** The destination entity settings will be copied to. */
+  /**
+   * The destination entity settings will be copied to.
+   */
   readonly destination: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_entity_settings_pasted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using
- * {@link LuaPreGhostDeconstructedEventFilter}.
+ * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_deconstructed View documentation}
  */
 interface OnPreGhostDeconstructedEvent extends EventData {
-  /** The player that did the deconstruction if any. */
+  /**
+   * The player that did the deconstruction if any.
+   */
   readonly player_index?: uint
   readonly ghost: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_ghost_deconstructed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2098,13 +3044,21 @@ interface OnPreGhostDeconstructedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_group_deleted View documentation}
  */
 interface OnPrePermissionGroupDeletedEvent extends EventData {
-  /** The player doing the deletion. */
+  /**
+   * The player doing the deletion.
+   */
   readonly player_index: uint
-  /** The group to be deleted. */
+  /**
+   * The group to be deleted.
+   */
   readonly group: LuaPermissionGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_permission_group_deleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2114,11 +3068,17 @@ interface OnPrePermissionGroupDeletedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_string_imported View documentation}
  */
 interface OnPrePermissionStringImportedEvent extends EventData {
-  /** The player importing the string. */
+  /**
+   * The player importing the string.
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_permission_string_imported
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2128,17 +3088,29 @@ interface OnPrePermissionStringImportedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_crafted_item View documentation}
  */
 interface OnPrePlayerCraftedItemEvent extends EventData {
-  /** The player doing the crafting. */
+  /**
+   * The player doing the crafting.
+   */
   readonly player_index: uint
-  /** The recipe being queued. */
+  /**
+   * The recipe being queued.
+   */
   readonly recipe: LuaRecipe
-  /** The items removed from the players inventory to do the crafting. */
+  /**
+   * The items removed from the players inventory to do the crafting.
+   */
   readonly items: LuaInventory
-  /** The number of times the recipe is being queued. */
+  /**
+   * The number of times the recipe is being queued.
+   */
   readonly queued_count: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_player_crafted_item
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2150,9 +3122,13 @@ interface OnPrePlayerCraftedItemEvent extends EventData {
 interface OnPrePlayerDiedEvent extends EventData {
   readonly player_index: uint
   readonly cause?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_player_died
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2164,40 +3140,54 @@ interface OnPrePlayerDiedEvent extends EventData {
 interface OnPrePlayerLeftGameEvent extends EventData {
   readonly player_index: uint
   readonly reason: defines.disconnect_reason
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_player_left_game
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using
- * {@link LuaPrePlayerMinedEntityEventFilter}.
+ * Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item View documentation}
  */
 interface OnPrePlayerMinedItemEvent extends EventData {
-  /** The entity being mined */
+  /**
+   * The entity being mined
+   */
   readonly entity: LuaEntity
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_player_mined_item
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is
- * different in that the player is deleted as if he never existed in the save file.
+ * Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_removed View documentation}
  */
 interface OnPrePlayerRemovedEvent extends EventData {
-  /** The player index that will be removed */
+  /**
+   * The player index that will be removed
+   */
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_player_removed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2208,9 +3198,13 @@ interface OnPrePlayerRemovedEvent extends EventData {
  */
 interface OnPrePlayerToggledMapEditorEvent extends EventData {
   readonly player_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_player_toggled_map_editor
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2222,11 +3216,17 @@ interface OnPrePlayerToggledMapEditorEvent extends EventData {
 interface OnPreRobotExplodedCliffEvent extends EventData {
   readonly robot: LuaEntity
   readonly cliff: LuaEntity
-  /** The cliff explosive used. */
+  /**
+   * The cliff explosive used.
+   */
   readonly item: LuaItemPrototype
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_robot_exploded_cliff
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2236,18 +3236,30 @@ interface OnPreRobotExplodedCliffEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_pre_script_inventory_resized View documentation}
  */
 interface OnPreScriptInventoryResizedEvent extends EventData {
-  /** If done by console command; the player who ran the command. */
+  /**
+   * If done by console command; the player who ran the command.
+   */
   readonly player_index?: uint
-  /** The mod that did the resizing. This will be `"core"` if done by console command or scenario script. */
+  /**
+   * The mod that did the resizing. This will be `"core"` if done by console command or scenario script.
+   */
   readonly mod: string
   readonly inventory: LuaInventory
-  /** The old inventory size. */
+  /**
+   * The old inventory size.
+   */
   readonly old_size: uint
-  /** The new inventory size. */
+  /**
+   * The new inventory size.
+   */
   readonly new_size: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_script_inventory_resized
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2258,9 +3270,13 @@ interface OnPreScriptInventoryResizedEvent extends EventData {
  */
 interface OnPreSurfaceClearedEvent extends EventData {
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_surface_cleared
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2271,9 +3287,13 @@ interface OnPreSurfaceClearedEvent extends EventData {
  */
 interface OnPreSurfaceDeletedEvent extends EventData {
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_pre_surface_deleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2283,13 +3303,21 @@ interface OnPreSurfaceDeletedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_research_finished View documentation}
  */
 interface OnResearchFinishedEvent extends EventData {
-  /** The researched technology */
+  /**
+   * The researched technology
+   */
   readonly research: LuaTechnology
-  /** If the technology was researched by script. */
+  /**
+   * If the technology was researched by script.
+   */
   readonly by_script: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_research_finished
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2299,13 +3327,21 @@ interface OnResearchFinishedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_research_reversed View documentation}
  */
 interface OnResearchReversedEvent extends EventData {
-  /** The technology un-researched */
+  /**
+   * The technology un-researched
+   */
   readonly research: LuaTechnology
-  /** If the technology was un-researched by script. */
+  /**
+   * If the technology was un-researched by script.
+   */
   readonly by_script: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_research_reversed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2315,12 +3351,18 @@ interface OnResearchReversedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_research_started View documentation}
  */
 interface OnResearchStartedEvent extends EventData {
-  /** The technology being researched */
+  /**
+   * The technology being researched
+   */
   readonly research: LuaTechnology
   readonly last_research?: LuaTechnology
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_research_started
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2331,9 +3373,13 @@ interface OnResearchStartedEvent extends EventData {
  */
 interface OnResourceDepletedEvent extends EventData {
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_resource_depleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2343,17 +3389,29 @@ interface OnResourceDepletedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_entity View documentation}
  */
 interface OnRobotBuiltEntityEvent extends EventData {
-  /** The robot that did the building. */
+  /**
+   * The robot that did the building.
+   */
   readonly robot: LuaEntity
-  /** The entity built. */
+  /**
+   * The entity built.
+   */
   readonly created_entity: LuaEntity
-  /** The item used to do the building. */
+  /**
+   * The item used to do the building.
+   */
   readonly stack: LuaItemStack
-  /** The tags associated with this entity if any. */
+  /**
+   * The tags associated with this entity if any.
+   */
   readonly tags?: Tags
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_built_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2363,21 +3421,37 @@ interface OnRobotBuiltEntityEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_tile View documentation}
  */
 interface OnRobotBuiltTileEvent extends EventData {
-  /** The robot. */
+  /**
+   * The robot.
+   */
   readonly robot: LuaEntity
-  /** The position data. */
+  /**
+   * The position data.
+   */
   readonly tiles: OldTileAndPosition[]
-  /** The tile prototype that was placed. */
+  /**
+   * The tile prototype that was placed.
+   */
   readonly tile: LuaTilePrototype
-  /** The item type used to build the tiles. */
+  /**
+   * The item type used to build the tiles.
+   */
   readonly item: LuaItemPrototype
-  /** The stack used to build the tiles (may be empty if all of the items where used to build the tiles). */
+  /**
+   * The stack used to build the tiles (may be empty if all of the items where used to build the tiles).
+   */
   readonly stack: LuaItemStack
-  /** The surface the tile(s) are build on. */
+  /**
+   * The surface the tile(s) are build on.
+   */
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_built_tile
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2388,11 +3462,17 @@ interface OnRobotBuiltTileEvent extends EventData {
  */
 interface OnRobotExplodedCliffEvent extends EventData {
   readonly robot: LuaEntity
-  /** The cliff explosive used. */
+  /**
+   * The cliff explosive used.
+   */
   readonly item: LuaItemPrototype
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_exploded_cliff
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2402,36 +3482,50 @@ interface OnRobotExplodedCliffEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined View documentation}
  */
 interface OnRobotMinedEvent extends EventData {
-  /** The robot that did the mining. */
+  /**
+   * The robot that did the mining.
+   */
   readonly robot: LuaEntity
-  /** The entity the robot just picked up. */
+  /**
+   * The entity the robot just picked up.
+   */
   readonly item_stack: SimpleItemStack
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_mined
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event
- * any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered
- * using {@link LuaRobotMinedEntityEventFilter}.
- *
- * **Note**: 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.
+ * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using {@link LuaRobotMinedEntityEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_entity View documentation}
+ * @remarks The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
  */
 interface OnRobotMinedEntityEvent extends EventData {
-  /** The robot doing the mining. */
+  /**
+   * The robot doing the mining.
+   */
   readonly robot: LuaEntity
-  /** The entity that has been mined. */
+  /**
+   * The entity that has been mined.
+   */
   readonly entity: LuaEntity
-  /** The temporary inventory that holds the result of mining the entity. */
+  /**
+   * The temporary inventory that holds the result of mining the entity.
+   */
   readonly buffer: LuaInventory
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_mined_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2441,15 +3535,25 @@ interface OnRobotMinedEntityEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_tile View documentation}
  */
 interface OnRobotMinedTileEvent extends EventData {
-  /** The robot. */
+  /**
+   * The robot.
+   */
   readonly robot: LuaEntity
-  /** The position data. */
+  /**
+   * The position data.
+   */
   readonly tiles: OldTileAndPosition[]
-  /** The surface the tile(s) were mined on. */
+  /**
+   * The surface the tile(s) were mined on.
+   */
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_mined_tile
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2459,13 +3563,21 @@ interface OnRobotMinedTileEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_robot_pre_mined View documentation}
  */
 interface OnRobotPreMinedEvent extends EventData {
-  /** The robot that's about to do the mining. */
+  /**
+   * The robot that's about to do the mining.
+   */
   readonly robot: LuaEntity
-  /** The entity which is about to be mined. */
+  /**
+   * The entity which is about to be mined.
+   */
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_robot_pre_mined
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2477,11 +3589,17 @@ interface OnRobotPreMinedEvent extends EventData {
 interface OnRocketLaunchOrderedEvent extends EventData {
   readonly rocket: LuaEntity
   readonly rocket_silo: LuaEntity
-  /** The player that is riding the rocket, if any. */
+  /**
+   * The player that is riding the rocket, if any.
+   */
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_rocket_launch_ordered
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2493,11 +3611,17 @@ interface OnRocketLaunchOrderedEvent extends EventData {
 interface OnRocketLaunchedEvent extends EventData {
   readonly rocket: LuaEntity
   readonly rocket_silo?: LuaEntity
-  /** The player that is riding the rocket, if any. */
+  /**
+   * The player that is riding the rocket, if any.
+   */
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_rocket_launched
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2508,18 +3632,24 @@ interface OnRocketLaunchedEvent extends EventData {
  */
 interface OnRuntimeModSettingChangedEvent extends EventData {
   /**
-   * If the `setting_type` is `"global"` and it was changed through the mod settings GUI, this is the index of the
-   * player that changed the global setting. If the `setting_type` is `"runtime-per-user"` and it changed a current
-   * setting of the player, this is the index of the player whose setting was changed. In all other cases, this is `nil`.
+   * If the `setting_type` is `"global"` and it was changed through the mod settings GUI, this is the index of the player that changed the global setting. If the `setting_type` is `"runtime-per-user"` and it changed a current setting of the player, this is the index of the player whose setting was changed. In all other cases, this is `nil`.
    */
   readonly player_index?: uint
-  /** The prototype name of the setting that was changed. */
+  /**
+   * The prototype name of the setting that was changed.
+   */
   readonly setting: string
-  /** Either "runtime-per-user" or "runtime-global". */
+  /**
+   * Either "runtime-per-user" or "runtime-global".
+   */
   readonly setting_type: "runtime-per-user" | "runtime-global"
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_runtime_mod_setting_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2529,38 +3659,62 @@ interface OnRuntimeModSettingChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_script_inventory_resized View documentation}
  */
 interface OnScriptInventoryResizedEvent extends EventData {
-  /** If done by console command; the player who ran the command. */
+  /**
+   * If done by console command; the player who ran the command.
+   */
   readonly player_index?: uint
-  /** The mod that did the resizing. This will be `"core"` if done by console command or scenario script. */
+  /**
+   * The mod that did the resizing. This will be `"core"` if done by console command or scenario script.
+   */
   readonly mod: string
   readonly inventory: LuaInventory
-  /** The old inventory size. */
+  /**
+   * The old inventory size.
+   */
   readonly old_size: uint
-  /** The new inventory size. */
+  /**
+   * The new inventory size.
+   */
   readonly new_size: uint
-  /** Any items which didn't fit into the new inventory size. */
+  /**
+   * Any items which didn't fit into the new inventory size.
+   */
   readonly overflow_inventory: LuaInventory
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_script_inventory_resized
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when a {@link LuaSurface.request_path LuaSurface::request_path} call completes.
+ * Called when a {@link LuaSurface#request_path LuaSurface::request_path} call completes.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_script_path_request_finished View documentation}
  */
 interface OnScriptPathRequestFinishedEvent extends EventData {
-  /** The actual path that the pathfinder has determined. `nil` if pathfinding failed. */
+  /**
+   * The actual path that the pathfinder has determined. `nil` if pathfinding failed.
+   */
   readonly path?: PathfinderWaypoint[]
-  /** Handle to associate the callback with a particular call to {@link LuaSurface.request_path LuaSurface::request_path}. */
+  /**
+   * Handle to associate the callback with a particular call to {@link LuaSurface#request_path LuaSurface::request_path}.
+   */
   readonly id: uint
-  /** Indicates that the pathfinder failed because it is too busy, and that you can retry later. */
+  /**
+   * Indicates that the pathfinder failed because it is too busy, and that you can retry later.
+   */
   readonly try_again_later: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_script_path_request_finished
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2570,36 +3724,53 @@ interface OnScriptPathRequestFinishedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_script_trigger_effect View documentation}
  */
 interface OnScriptTriggerEffectEvent extends EventData {
-  /** The effect_id specified in the trigger effect. */
+  /**
+   * The effect_id specified in the trigger effect.
+   */
   readonly effect_id: string
-  /** The surface the effect happened on. */
+  /**
+   * The surface the effect happened on.
+   */
   readonly surface_index: uint
-  readonly source_position?: PositionTable
+  readonly source_position?: MapPositionTable
   readonly source_entity?: LuaEntity
-  readonly target_position?: PositionTable
+  readonly target_position?: MapPositionTable
   readonly target_entity?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_script_trigger_effect
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using
- * {@link LuaSectorScannedEventFilter}.
+ * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_sector_scanned View documentation}
  */
 interface OnSectorScannedEvent extends EventData {
-  /** The radar that did the scanning. */
+  /**
+   * The radar that did the scanning.
+   */
   readonly radar: LuaEntity
-  /** The chunk scanned. */
+  /**
+   * The chunk scanned.
+   */
   readonly chunk_position: ChunkPositionTable
-  /** Area of the scanned chunk. */
+  /**
+   * Area of the scanned chunk.
+   */
   readonly area: BoundingBoxRead
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_sector_scanned
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2609,13 +3780,21 @@ interface OnSectorScannedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_selected_entity_changed View documentation}
  */
 interface OnSelectedEntityChangedEvent extends EventData {
-  /** The player whose selected entity changed. */
+  /**
+   * The player whose selected entity changed.
+   */
   readonly player_index: uint
-  /** The last selected entity if it still exists and there was one. */
+  /**
+   * The last selected entity if it still exists and there was one.
+   */
   readonly last_entity?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_selected_entity_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2625,32 +3804,49 @@ interface OnSelectedEntityChangedEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_spider_command_completed View documentation}
  */
 interface OnSpiderCommandCompletedEvent extends EventData {
-  /** Spider vehicle which was requested to move. */
+  /**
+   * Spider vehicle which was requested to move.
+   */
   readonly vehicle: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_spider_command_completed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when a translation request generated through
- * {@link LuaPlayer.request_translation LuaPlayer::request_translation} is translated.
+ * Called when a translation request generated through {@link LuaPlayer#request_translation LuaPlayer::request_translation} is translated.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_string_translated View documentation}
  */
 interface OnStringTranslatedEvent extends EventData {
-  /** The player whose locale was used for the translation. */
+  /**
+   * The player whose locale was used for the translation.
+   */
   readonly player_index: uint
-  /** The localised string being translated. */
+  /**
+   * The localised string being translated.
+   */
   readonly localised_string: LocalisedString
-  /** The translated `localised_string`. */
+  /**
+   * The translated `localised_string`.
+   */
   readonly result: string
-  /** Whether the requested localised string was valid and could be translated. */
+  /**
+   * Whether the requested localised string was valid and could be translated.
+   */
   readonly translated: boolean
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_string_translated
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2661,24 +3857,31 @@ interface OnStringTranslatedEvent extends EventData {
  */
 interface OnSurfaceClearedEvent extends EventData {
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_surface_cleared
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
  * Called when a surface is created.
  *
- * **Note**: This is not called when the default surface is created as it will always exist.
- *
  * {@link https://lua-api.factorio.com/latest/events.html#on_surface_created View documentation}
+ * @remarks This is not called when the default surface is created as it will always exist.
  */
 interface OnSurfaceCreatedEvent extends EventData {
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_surface_created
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2689,9 +3892,13 @@ interface OnSurfaceCreatedEvent extends EventData {
  */
 interface OnSurfaceDeletedEvent extends EventData {
   readonly surface_index: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_surface_deleted
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2702,11 +3909,17 @@ interface OnSurfaceDeletedEvent extends EventData {
  */
 interface OnSurfaceImportedEvent extends EventData {
   readonly surface_index: uint
-  /** The original surface name. */
+  /**
+   * The original surface name.
+   */
   readonly original_name: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_surface_imported
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2719,22 +3932,30 @@ interface OnSurfaceRenamedEvent extends EventData {
   readonly surface_index: uint
   readonly old_name: string
   readonly new_name: string
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_surface_renamed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when {@link LuaForce.reset_technology_effects LuaForce::reset_technology_effects} is finished.
+ * Called when {@link LuaForce#reset_technology_effects LuaForce::reset_technology_effects} is finished.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_technology_effects_reset View documentation}
  */
 interface OnTechnologyEffectsResetEvent extends EventData {
   readonly force: LuaForce
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_technology_effects_reset
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2744,9 +3965,13 @@ interface OnTechnologyEffectsResetEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/events.html#on_tick View documentation}
  */
 interface OnTickEvent extends EventData {
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_tick
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2758,9 +3983,13 @@ interface OnTickEvent extends EventData {
 interface OnTrainChangedStateEvent extends EventData {
   readonly train: LuaTrain
   readonly old_state: defines.train_state
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_train_changed_state
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2771,13 +4000,21 @@ interface OnTrainChangedStateEvent extends EventData {
  */
 interface OnTrainCreatedEvent extends EventData {
   readonly train: LuaTrain
-  /** The first old train id when splitting/merging trains. */
+  /**
+   * The first old train id when splitting/merging trains.
+   */
   readonly old_train_id_1?: uint
-  /** The second old train id when splitting/merging trains. */
+  /**
+   * The second old train id when splitting/merging trains.
+   */
   readonly old_train_id_2?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_train_created
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2788,41 +4025,53 @@ interface OnTrainCreatedEvent extends EventData {
  */
 interface OnTrainScheduleChangedEvent extends EventData {
   readonly train: LuaTrain
-  /** The player who made the change if any. */
+  /**
+   * The player who made the change if any.
+   */
   readonly player_index?: uint
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_train_schedule_changed
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined
- * `trigger_created_entity="true"`.
+ * Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity="true"`.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_trigger_created_entity View documentation}
  */
 interface OnTriggerCreatedEntityEvent extends EventData {
   readonly entity: LuaEntity
   readonly source?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_trigger_created_entity
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger
- * prototype defined `trigger_fired_artillery="true"`.
+ * Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery="true"`.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#on_trigger_fired_artillery View documentation}
  */
 interface OnTriggerFiredArtilleryEvent extends EventData {
   readonly entity: LuaEntity
   readonly source?: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_trigger_fired_artillery
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2834,9 +4083,13 @@ interface OnTriggerFiredArtilleryEvent extends EventData {
 interface OnUnitAddedToGroupEvent extends EventData {
   readonly unit: LuaEntity
   readonly group: LuaUnitGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_unit_added_to_group
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2847,9 +4100,13 @@ interface OnUnitAddedToGroupEvent extends EventData {
  */
 interface OnUnitGroupCreatedEvent extends EventData {
   readonly group: LuaUnitGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_unit_group_created
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2860,9 +4117,13 @@ interface OnUnitGroupCreatedEvent extends EventData {
  */
 interface OnUnitGroupFinishedGatheringEvent extends EventData {
   readonly group: LuaUnitGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_unit_group_finished_gathering
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2874,9 +4135,13 @@ interface OnUnitGroupFinishedGatheringEvent extends EventData {
 interface OnUnitRemovedFromGroupEvent extends EventData {
   readonly unit: LuaEntity
   readonly group: LuaUnitGroup
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_unit_removed_from_group
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
@@ -2887,81 +4152,101 @@ interface OnUnitRemovedFromGroupEvent extends EventData {
  */
 interface OnWorkerRobotExpiredEvent extends EventData {
   readonly robot: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.on_worker_robot_expired
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * A static event mods can use to tell other mods they built something by script. This event is only raised if a mod
- * does so with {@link LuaBootstrap.raise_event LuaBootstrap::raise_event} or
- * {@link LuaBootstrap.raise_script_built LuaBootstrap::raise_script_built}, or when `raise_built` is passed to
- * {@link LuaSurface.create_entity LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter}.
+ * A static event mods can use to tell other mods they built something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_built LuaBootstrap::raise_script_built}, or when `raise_built` is passed to {@link LuaSurface#create_entity LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#script_raised_built View documentation}
  */
 interface ScriptRaisedBuiltEvent extends EventData {
-  /** The entity that has been built. */
+  /**
+   * The entity that has been built.
+   */
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.script_raised_built
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod
- * does so with {@link LuaBootstrap.raise_event LuaBootstrap::raise_event} or
- * {@link LuaBootstrap.raise_script_destroy LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to
- * {@link LuaEntity.destroy LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter}.
+ * A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_destroy LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to {@link LuaEntity#destroy LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#script_raised_destroy View documentation}
  */
 interface ScriptRaisedDestroyEvent extends EventData {
-  /** The entity that was destroyed. */
+  /**
+   * The entity that was destroyed.
+   */
   readonly entity: LuaEntity
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.script_raised_destroy
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod
- * does so with {@link LuaBootstrap.raise_event LuaBootstrap::raise_event} or
- * {@link LuaBootstrap.raise_script_revive LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to
- * {@link LuaEntity.revive LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter}.
+ * A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_revive LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity#revive LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#script_raised_revive View documentation}
  */
 interface ScriptRaisedReviveEvent extends EventData {
-  /** The entity that was revived. */
+  /**
+   * The entity that was revived.
+   */
   readonly entity: LuaEntity
-  /** The tags associated with this entity, if any. */
+  /**
+   * The tags associated with this entity, if any.
+   */
   readonly tags?: Tags
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.script_raised_revive
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }
 
 /**
- * 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}.
+ * 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}.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#script_raised_set_tiles View documentation}
  */
 interface ScriptRaisedSetTilesEvent extends EventData {
-  /** The surface whose tiles were changed. */
+  /**
+   * The surface whose tiles were changed.
+   */
   readonly surface_index: uint
-  /** The tiles that were changed. */
+  /**
+   * The tiles that were changed.
+   */
   readonly tiles: TileRead[]
-  /** Identifier of the event */
+  /**
+   * Identifier of the event
+   */
   readonly name: typeof defines.events.script_raised_set_tiles
-  /** Tick the event was generated. */
+  /**
+   * Tick the event was generated.
+   */
   readonly tick: uint
 }