typed-factorio 1.1.0 → 1.3.1

package/Changelog.md

@@ -1,10 +1,22 @@
+# v1.3.1
+
+- Use @linkplain instead of @link for web links. This works around issue #13
+
+# v1.3.0
+
+- Updated to factorio version 1.1.61
+
+# v1.2.0
+
+- Updated to factorio version 1.1.60
+
 # v1.1.0
 
 - Updated to factorio version 1.1.59
 
 # v1.0.0
 
-- This project now has all the features that was originally planned, and can now guarantee reasonable backwards compatibility for future releases. As such, it now deserves the v1.0.0. Goodbye to [Zer0Ver](http://0ver.org)!
+- This project now has all the features that was originally planned, and can now guarantee reasonable backwards compatibility for future releases.
 - Updated to factorio version 1.1.57
 
 # v0.20.0

package/README.md

@@ -71,54 +71,52 @@ The `global` table is just a lua table which can have any shape the mod desires,
 
 ## Type features
 
-Typed-factorio has 100% complete types for the runtime stage. Description-only concepts and some not documented types are filled in manually.
+Here is a quick overview of type features:
 
-Here are some details on particular type features:
-
-### Lua features
-
-The types include [TypescriptToLua language extensions](https://typescripttolua.github.io/docs/advanced/language-extensions/)
-and [lua-types](https://github.com/TypeScriptToLua/lua-types) (for v5.2) as dependencies.
-
-### `nil`
+### Nullability
 
 The types consistently use `undefined` to represent `nil`.
-`null` is not used, because `undefined` in typescript is much more similar to `nil` in lua, and optional parameters/properties already use `undefined`.
 
-A class attribute is marked as possibly undefined only if the _read_ type is possibly `nil`. For properties where `nil` is not possible on _read_, but is possible on _write_, you can write `nil` by using `undefined!` or `myNullableValue!`, e.g. `controlBehavior.parameters = undefined!`.
+A class attribute is marked as possibly undefined only if the _read_ type is possibly `nil`. For properties where `nil` is not possible on _read_, but possible on _write_, you can write `nil` by using `undefined!` or `myNullableValue!`, e.g. `controlBehavior.parameters = undefined!`.
 
-### Variant parameter types
+### Parameter Variants
 
-Variant parameter types (types with "additional fields can be specified depending on type") are handled as a union of all variants (which is often a [discriminated union](https://basarat.gitbook.io/typescript/type-system/discriminated-unions#discriminated-union)). This gives proper type checking for each variant.
-
-The type for a specific variant is prefixed with the variant name, or with "Other" for variants without additional fields (e.g. `AmmoDamageTechnologyModifier`, `OtherTechnologyModifier`).
+Parameters with variants (with "additional fields can be specified depending on type ...") are defined as a union of all variants. The type for a specific variant is prefixed with the variant name, or "Other" types variants without extra properties (e.g. `AmmoDamageTechnologyModifier`, `OtherTechnologyModifier`).
 
 ### Events
 
-`script.on_event()`, `script.get/set_filters()`, and `script.raise_event()` all have type checking on the event data/filter type, inferred from what is passed as the event name/id.
-
-You can pass a type parameter to `script.generate_event_name<T>()`, and it will return an `EventId` that holds type info of the event data. Event functions on `script` can then use the type data when the `EventId` is passed.
+Event IDs (`defines.events`) carry information about their event type and possible filters, which is used by the various methods on `script`.
+You can pass a type parameter to `script.generate_event_name<T>()`, and it will return an `EventId` that holds type info of the event data.
 
-### Array-like types
+### Array-like classes
 
 Classes that have an index operator, a length operator, and have an array-like structure, inherit from `(Readonly)Array`. These are `LuaInventory`, `LuaFluidBox`, `LuaTransportLine`. This allows you to use these classes like arrays, meaning having array methods, and `.length` translating to the lua length operator. However, this also means, like typescript arrays, they are **0-indexed, not 1-indexed**.
 
-### Table or array types, and "Read" concepts
+### Table-or-array concepts, and "Read" variants
 
 For table-or-array types (e.g. Position), there also are types such as `PositionTable` and `PositionArray` that refer to the table or array form.
 
-Table-or-array types will appear in the Table form when known to be in a read position. This also applies to other concepts/complex types that have table-or-array attributes.
+Table-or-array types will appear in Table form when known to be in a read position. This also applies to other concepts/types that have table-or-array attributes.
 
-For some concepts, there is also a special form for when the concept is used in a "read" position, where all table-or-array types are in Table form. These types are suffixed with `Read`, e.g. `ScriptPositionRead`.
+For some concepts, there is also a special form for when it is used in a "read" position, where all table-or-array types are in Table form. These types are suffixed with `Read`, e.g. `ScriptPositionRead`, `BoundingBoxRead`.
 
-### Types with subclasses
+### Classes with subclasses
 
-Some classes have attributes that are documented to only work on particular subclasses. For these classes, e.g. `LuaEntity`, there are specific types that you can _optionally_ use:
+Some classes have attributes that are documented to only work for particular subclasses. For these classes, e.g. `LuaEntity`, there are specific types that you can _optionally_ use:
 
 - a "Base" type, e.g. `BaseEntity`, which only contains members usable by all subclasses
-- individual subclass types, e.g. `CraftingMachineEntity`, which extends the base type with members specific to that subclass
+- individual subclass types, e.g. `CraftingMachineEntity`, which extends the base type with members specific to that subclass.
 
-The simple class name, `LuaEntity` in this example, contains attributes for _all_ subclasses.
+The simple class name, e.g. `LuaEntity`, contains attributes for _all_ subclasses.
+
+For stricter types, use the `Base` type generally, and the specific subclass type when needed.
+You can also create your own type-narrowing functions, like so:
+
+```ts
+function isCraftingMachineEntity(entity: LuaEntity): entity is CraftingMachineEntity {
+  return entity.type === "crafting-machine"
+}
+```
 
 ### LuaGuiElement
 
@@ -132,7 +130,6 @@ This is done both to provide more accurate types, and for possible integration w
 
 This is a recommended **opt-in** feature. To opt in, add `"typed-factorio/strict-index-types"` to `compilerOptions > types` in your tsconfig.json (in addition to `"typed-factorio/runtime"`).
 
-Some `uint` types which represent indices, e.g. player_index, entity_number, can be "branded" numbers with their own type, e.g. `PlayerIndex` and `EntityNumber`. These are assignable to `number`, but a plain `number` is not directly assignable to them. This helps ensure correctness.
-These are indices that do not index into an array-like structure, and otherwise should usually not have arithmetic done to them.
+Some `uint` types which represent unique indices, e.g. player_index, entity_number, can be "branded" numbers with their own type, e.g. `PlayerIndex` and `EntityNumber`. If opted-in, these index-types will be still assignable to `number`, but a plain `number` is not directly assignable to them. This helps ensure correctness.
 You can use these types as keys in an index signature, e.g. `{ [index: PlayerIndex]: "foo" }`.
 You can cast "plain" numbers to these types, e.g. `1 as PlayerIndex`, do this with caution.

package/generated/classes.d.ts

@@ -222,11 +222,11 @@ interface LuaAutoplaceControlPrototype {
  */
 interface LuaBootstrap {
   /**
-   * Register a function to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to {@link LuaGameScript} and the {@link https://lua-api.factorio.com/latest/Global.html global} table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
+   * Register a function to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to {@link LuaGameScript} and the {@linkplain https://lua-api.factorio.com/latest/Global.html global} table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
    *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_init View documentation}
    * @param f The handler for this event. Passing `nil` will unregister it.
-   * @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
+   * @remarks For more context, refer to the {@linkplain https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
    * @example Initialize a `players` table in `global` for later use.
    *
    * ```
@@ -237,26 +237,26 @@ interface LuaBootstrap {
    */
   on_init(f: (() => void) | undefined): void
   /**
-   * Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript} is not available. The {@link https://lua-api.factorio.com/latest/Global.html global} table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
+   * Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript} is not available. The {@linkplain https://lua-api.factorio.com/latest/Global.html global} table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
    *
    * The only legitimate uses of this event are the following:
-   * - Re-setup {@link https://www.lua.org/pil/13.html metatables} as they are not persisted through the save/load cycle.
+   * - Re-setup {@linkplain https://www.lua.org/pil/13.html metatables} as they are not persisted through the save/load cycle.
    * - Re-setup conditional event handlers, meaning subscribing to an event only when some condition is met to save processing time.
-   * - Create local references to data stored in the {@link https://lua-api.factorio.com/latest/Global.html global} table.
+   * - Create local references to data stored in the {@linkplain https://lua-api.factorio.com/latest/Global.html global} table.
    *
-   * For all other purposes, {@link LuaBootstrap#on_init LuaBootstrap::on_init}, {@link LuaBootstrap#on_configuration_changed LuaBootstrap::on_configuration_changed} or {@link https://lua-api.factorio.com/latest/Migrations.html migrations} should be used instead.
+   * For all other purposes, {@link LuaBootstrap#on_init LuaBootstrap::on_init}, {@link LuaBootstrap#on_configuration_changed LuaBootstrap::on_configuration_changed} or {@linkplain https://lua-api.factorio.com/latest/Migrations.html migrations} should be used instead.
    *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_load View documentation}
    * @param f The handler for this event. Passing `nil` will unregister it.
-   * @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
+   * @remarks For more context, refer to the {@linkplain https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
    */
   on_load(f: (() => void) | undefined): void
   /**
-   * Register a function to be run when mod configuration changes. This is called when the major game version or any mod version changed, when any mod was added or removed, when a startup setting has changed, or when any prototypes have been added or removed. It allows the mod to make any changes it deems appropriate to both the data structures in its {@link https://lua-api.factorio.com/latest/Global.html global} table or to the game state through {@link LuaGameScript}.
+   * Register a function to be run when mod configuration changes. This is called when the major game version or any mod version changed, when any mod was added or removed, when a startup setting has changed, or when any prototypes have been added or removed. It allows the mod to make any changes it deems appropriate to both the data structures in its {@linkplain https://lua-api.factorio.com/latest/Global.html global} table or to the game state through {@link LuaGameScript}.
    *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_configuration_changed View documentation}
    * @param f The handler for this event. Passing `nil` will unregister it.
-   * @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
+   * @remarks For more context, refer to the {@linkplain https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
    */
   on_configuration_changed(f: ((param1: ConfigurationChangedData) => void) | undefined): void
   /**
@@ -887,7 +887,7 @@ interface LuaCommandProcessor {
    */
   readonly commands: Record<string, LocalisedString>
   /**
-   * Lists the built-in commands of the core game. The {@link https://wiki.factorio.com/Console wiki} has an overview of these.
+   * Lists the built-in commands of the core game. The {@linkplain https://wiki.factorio.com/Console wiki} has an overview of these.
    *
    * {@link https://lua-api.factorio.com/latest/LuaCommandProcessor.html#LuaCommandProcessor.game_commands View documentation}
    */
@@ -1423,7 +1423,7 @@ interface LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.crafting_queue_progress View documentation}
    */
-  readonly crafting_queue_progress: double
+  crafting_queue_progress: double
   /**
    * Current walking state.
    *
@@ -1554,6 +1554,10 @@ interface LuaControl {
   /**
    * `true` if the player is in a vehicle. Writing to this attribute puts the player in or out of a vehicle.
    *
+   * **Raised events:**
+   * - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_ Raised if the driving state successfully changed.
+   *
+   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.driving View documentation}
    */
   driving: boolean
@@ -2885,6 +2889,9 @@ interface LuaEntity extends LuaControl {
   /**
    * Sets the driver of this vehicle.
    *
+   * **Raised events:**
+   * - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
+   *
    * _Can only be used if this is Vehicle_
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_driver View documentation}
@@ -2905,6 +2912,9 @@ interface LuaEntity extends LuaControl {
   /**
    * Sets the passenger of this car or spidertron.
    *
+   * **Raised events:**
+   * - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
+   *
    * _Can only be used if this is Vehicle_
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_passenger View documentation}
@@ -3800,13 +3810,13 @@ interface LuaEntity extends LuaControl {
    */
   readonly electric_emissions: double | undefined
   /**
-   * A universally unique number identifying this entity for the lifetime of the save. Only entities inheriting from {@link https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner}, as well as {@link https://wiki.factorio.com/Prototype/ItemRequestProxy ItemRequestProxy} and {@link https://wiki.factorio.com/Prototype/EntityGhost EntityGhost} entities, are assigned a unit number. This property is `nil` for entities without unit number.
+   * A universally unique number identifying this entity for the lifetime of the save. Only entities inheriting from {@linkplain https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner}, as well as {@linkplain https://wiki.factorio.com/Prototype/ItemRequestProxy ItemRequestProxy} and {@linkplain https://wiki.factorio.com/Prototype/EntityGhost EntityGhost} entities, are assigned a unit number. This property is `nil` for entities without unit number.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.unit_number View documentation}
    */
   readonly unit_number: UnitNumber | undefined
   /**
-   * The {@link LuaEntity#unit_number unit_number} of the entity contained in this ghost. It is the same as the unit number of the {@link https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner} that was destroyed to create this ghost. If it was created by other means, or if the inner entity doesn not support unit numbers, this property is `nil`.
+   * The {@link LuaEntity#unit_number unit_number} of the entity contained in this ghost. It is the same as the unit number of the {@linkplain https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner} that was destroyed to create this ghost. If it was created by other means, or if the inner entity doesn not support unit numbers, this property is `nil`.
    *
    * _Can only be used if this is EntityGhost_
    *
@@ -3848,7 +3858,7 @@ interface LuaEntity extends LuaControl {
    */
   readonly bounding_box: BoundingBoxRead
   /**
-   * The secondary bounding box of this entity or `nil` if it doesn't have one.
+   * The secondary bounding box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_bounding_box View documentation}
    */
@@ -3860,7 +3870,7 @@ interface LuaEntity extends LuaControl {
    */
   readonly selection_box: BoundingBoxRead
   /**
-   * The secondary selection box of this entity or `nil` if it doesn't have one.
+   * The secondary selection box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_selection_box View documentation}
    */
@@ -5378,7 +5388,7 @@ interface BaseEntity extends LuaControl {
    */
   readonly electric_emissions: double | undefined
   /**
-   * A universally unique number identifying this entity for the lifetime of the save. Only entities inheriting from {@link https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner}, as well as {@link https://wiki.factorio.com/Prototype/ItemRequestProxy ItemRequestProxy} and {@link https://wiki.factorio.com/Prototype/EntityGhost EntityGhost} entities, are assigned a unit number. This property is `nil` for entities without unit number.
+   * A universally unique number identifying this entity for the lifetime of the save. Only entities inheriting from {@linkplain https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner}, as well as {@linkplain https://wiki.factorio.com/Prototype/ItemRequestProxy ItemRequestProxy} and {@linkplain https://wiki.factorio.com/Prototype/EntityGhost EntityGhost} entities, are assigned a unit number. This property is `nil` for entities without unit number.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.unit_number View documentation}
    */
@@ -5402,7 +5412,7 @@ interface BaseEntity extends LuaControl {
    */
   readonly bounding_box: BoundingBoxRead
   /**
-   * The secondary bounding box of this entity or `nil` if it doesn't have one.
+   * The secondary bounding box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_bounding_box View documentation}
    */
@@ -5414,7 +5424,7 @@ interface BaseEntity extends LuaControl {
    */
   readonly selection_box: BoundingBoxRead
   /**
-   * The secondary selection box of this entity or `nil` if it doesn't have one.
+   * The secondary selection box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_selection_box View documentation}
    */
@@ -5796,7 +5806,7 @@ interface EntityGhostEntity extends BaseEntity {
    */
   ghost_has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
-   * The {@link LuaEntity#unit_number unit_number} of the entity contained in this ghost. It is the same as the unit number of the {@link https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner} that was destroyed to create this ghost. If it was created by other means, or if the inner entity doesn not support unit numbers, this property is `nil`.
+   * The {@link LuaEntity#unit_number unit_number} of the entity contained in this ghost. It is the same as the unit number of the {@linkplain https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner} that was destroyed to create this ghost. If it was created by other means, or if the inner entity doesn not support unit numbers, this property is `nil`.
    *
    * _Can only be used if this is EntityGhost_
    *
@@ -6293,6 +6303,9 @@ interface VehicleEntity extends BaseEntity {
   /**
    * Sets the driver of this vehicle.
    *
+   * **Raised events:**
+   * - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
+   *
    * _Can only be used if this is Vehicle_
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_driver View documentation}
@@ -6313,6 +6326,9 @@ interface VehicleEntity extends BaseEntity {
   /**
    * Sets the passenger of this car or spidertron.
    *
+   * **Raised events:**
+   * - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
+   *
    * _Can only be used if this is Vehicle_
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_passenger View documentation}
@@ -7595,6 +7611,12 @@ interface LuaEntityPrototype {
    * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.guns View documentation}
    */
   readonly guns: Record<string, LuaItemPrototype> | undefined
+  /**
+   * A vector of the gun prototypes this prototype uses, or `nil`.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.indexed_guns View documentation}
+   */
+  readonly indexed_guns: LuaItemPrototype[] | undefined
   /**
    * The default speed of this flying robot, rolling stock or unit, `nil` if not one of these.
    *
@@ -8334,6 +8356,58 @@ interface LuaEntityPrototype {
         readonly robots_shrink_when_entering_and_exiting: boolean
       }
     | undefined
+  /**
+   * Gets the height of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.height View documentation}
+   */
+  readonly height: double | undefined
+  /**
+   * Gets the torso rotation speed of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.torso_rotation_speed View documentation}
+   */
+  readonly torso_rotation_speed: double | undefined
+  /**
+   * Does this prototoype automaticly cycle weapons. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.automatic_weapon_cycling View documentation}
+   */
+  readonly automatic_weapon_cycling: boolean | undefined
+  /**
+   * Gets the chain shooting cooldown modifier of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chain_shooting_cooldown_modifier View documentation}
+   */
+  readonly chain_shooting_cooldown_modifier: double | undefined
+  /**
+   * Gets the chunk exploration radius of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chunk_exploration_radius View documentation}
+   */
+  readonly chunk_exploration_radius: double | undefined
+  /**
+   * Gets the animation speed coefficient of this belt . `nil` if this is not transport belt connectable.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.animation_speed_coefficient View documentation}
+   */
+  readonly animation_speed_coefficient: double | undefined
+  /**
+   * Get the manual range modifier for artillery turret and artillery wagon prototypes. `nil` if not artillery type prototype
+   *
+   * subclass(ArtilleryWagon, ArtilleryTurret)
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.manual_range_modifier View documentation}
+   */
+  readonly manual_range_modifier: double | undefined
+  /**
+   * The dying time of this corpse prototype. `nil` if not a corpse prototype.
+   *
+   * _Can only be used if this is Corpse_
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.dying_speed View documentation}
+   */
+  readonly dying_speed: float | undefined
   /**
    * Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
    *
@@ -8984,6 +9058,12 @@ interface BaseEntityPrototype {
    * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.guns View documentation}
    */
   readonly guns: Record<string, LuaItemPrototype> | undefined
+  /**
+   * A vector of the gun prototypes this prototype uses, or `nil`.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.indexed_guns View documentation}
+   */
+  readonly indexed_guns: LuaItemPrototype[] | undefined
   /**
    * The default speed of this flying robot, rolling stock or unit, `nil` if not one of these.
    *
@@ -9645,6 +9725,50 @@ interface BaseEntityPrototype {
         readonly robots_shrink_when_entering_and_exiting: boolean
       }
     | undefined
+  /**
+   * Gets the height of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.height View documentation}
+   */
+  readonly height: double | undefined
+  /**
+   * Gets the torso rotation speed of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.torso_rotation_speed View documentation}
+   */
+  readonly torso_rotation_speed: double | undefined
+  /**
+   * Does this prototoype automaticly cycle weapons. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.automatic_weapon_cycling View documentation}
+   */
+  readonly automatic_weapon_cycling: boolean | undefined
+  /**
+   * Gets the chain shooting cooldown modifier of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chain_shooting_cooldown_modifier View documentation}
+   */
+  readonly chain_shooting_cooldown_modifier: double | undefined
+  /**
+   * Gets the chunk exploration radius of this prototype. `nil` if this is not a spider vechicle.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chunk_exploration_radius View documentation}
+   */
+  readonly chunk_exploration_radius: double | undefined
+  /**
+   * Gets the animation speed coefficient of this belt . `nil` if this is not transport belt connectable.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.animation_speed_coefficient View documentation}
+   */
+  readonly animation_speed_coefficient: double | undefined
+  /**
+   * Get the manual range modifier for artillery turret and artillery wagon prototypes. `nil` if not artillery type prototype
+   *
+   * subclass(ArtilleryWagon, ArtilleryTurret)
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.manual_range_modifier View documentation}
+   */
+  readonly manual_range_modifier: double | undefined
   /**
    * Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
    */
@@ -9752,6 +9876,17 @@ interface EntityWithOwnerEntityPrototype extends BaseEntityPrototype {
   readonly allow_run_time_change_of_is_military_target: boolean
 }
 
+interface CorpseEntityPrototype extends BaseEntityPrototype {
+  /**
+   * The dying time of this corpse prototype. `nil` if not a corpse prototype.
+   *
+   * _Can only be used if this is Corpse_
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.dying_speed View documentation}
+   */
+  readonly dying_speed: float | undefined
+}
+
 interface CharacterEntityPrototype extends BaseEntityPrototype {
   /**
    * Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
@@ -10369,7 +10504,7 @@ interface LuaEquipmentPrototype {
  *
  * Examples:
  * - The item production GUI shows "consumption" on the right, thus `output` describes the item consumption numbers. The same goes for fluid consumption.
- * - The kills gui shows "losses" on the right, so `output` describes how many of the force's entities were killed by enemies.
+ * - The kills GUI shows "losses" on the right, so `output` describes how many of the force's entities were killed by enemies.
  * - The electric network GUI shows "power consumption" on the left side, so in this case `input` describes the power consumption numbers.
  *
  * {@link https://lua-api.factorio.com/latest/LuaFlowStatistics.html View documentation}
@@ -10407,7 +10542,11 @@ interface LuaFlowStatistics {
    */
   set_output_count(name: string, count: uint64 | double): void
   /**
-   * Gets the flow count value for the given time frame.
+   * Gets the flow count value for the given time frame. If `sample_index` is not provided, then the value returned is the average across the provided precision time period. These are the values shown in the bottom section of the statistics GUIs.
+   *
+   * Use `sample_index` to access the data used to generate the statistics graphs. Each precision level contains 300 samples of data so at a precision of 1 minute, each sample contains data averaged across 60s / 300 = 0.2s = 12 ticks.
+   *
+   * All return values are normalized to be per-tick for electric networks and per-minute for all other types.
    *
    * {@link https://lua-api.factorio.com/latest/LuaFlowStatistics.html#LuaFlowStatistics.get_flow_count View documentation}
    */
@@ -10421,11 +10560,15 @@ interface LuaFlowStatistics {
      */
     readonly input: boolean
     /**
-     * The precision to read.
+     * The precision range to read.
      */
     readonly precision_index: defines.flow_precision_index
     /**
-     * If true, the count is returned instead of the per-time-frame value.
+     * The sample index to read from within the precision range. If not provided, the entire precision range is read. Must be between 1 and 300 where 1 is the most recent sample and 300 is the oldest.
+     */
+    readonly sample_index?: uint16
+    /**
+     * If true, the count of items/fluids/entities is returned instead of the per-time-frame value.
      */
     readonly count?: boolean
   }): double
@@ -10506,7 +10649,7 @@ interface LuaFluidBox extends Array<Fluid | undefined> {
    */
   get_capacity(index: uint): double
   /**
-   * The fluidbox connections for the given fluidbox index.
+   * The fluidboxes to which the fluidbox at the given index is connected.
    *
    * {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_connections View documentation}
    */
@@ -11689,7 +11832,7 @@ interface LuaGameScript {
    */
   regenerate_entity(entities: string | readonly string[]): void
   /**
-   * Take a screenshot of the game and save it to the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. The name of the image file can be specified via the `path` parameter.
+   * Take a screenshot of the game and save it to the `script-output` folder, located in the game's {@linkplain https://wiki.factorio.com/User_data_directory user data directory}. The name of the image file can be specified via the `path` parameter.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.take_screenshot View documentation}
    * @remarks If Factorio is running headless, this function will do nothing.
@@ -11767,7 +11910,7 @@ interface LuaGameScript {
    */
   set_wait_for_screenshots_to_finish(): void
   /**
-   * Take a screenshot of the technology screen and save it to the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. The name of the image file can be specified via the `path` parameter.
+   * Take a screenshot of the technology screen and save it to the `script-output` folder, located in the game's {@linkplain https://wiki.factorio.com/User_data_directory user data directory}. The name of the image file can be specified via the `path` parameter.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.take_technology_screenshot View documentation}
    */
@@ -11812,7 +11955,7 @@ interface LuaGameScript {
    */
   json_to_table(json: string): AnyBasic | undefined
   /**
-   * Write a file to the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. The name and file extension of the file can be specified via the `filename` parameter.
+   * Write a file to the `script-output` folder, located in the game's {@linkplain https://wiki.factorio.com/User_data_directory user data directory}. The name and file extension of the file can be specified via the `filename` parameter.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.write_file View documentation}
    * @param filename The name of the file. Providing a directory path (ex. `"save/here/example.txt"`) will create the necessary folder structure in `script-output`.
@@ -11822,7 +11965,7 @@ interface LuaGameScript {
    */
   write_file(filename: string, data: LocalisedString, append?: boolean, for_player?: uint): void
   /**
-   * Remove a file or directory in the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. Can be used to remove files created by {@link LuaGameScript#write_file LuaGameScript::write_file}.
+   * Remove a file or directory in the `script-output` folder, located in the game's {@linkplain https://wiki.factorio.com/User_data_directory user data directory}. Can be used to remove files created by {@link LuaGameScript#write_file LuaGameScript::write_file}.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.remove_path View documentation}
    * @param path The path to the file or directory to remove, relative to `script-output`.
@@ -11984,11 +12127,10 @@ interface LuaGameScript {
    */
   is_valid_sound_path(sound_path: SoundPath): boolean
   /**
-   * Checks if the given SpritePath is valid and contains a loaded sprite.
+   * Checks if the given SpritePath is valid and contains a loaded sprite. The existence of the image is not checked for paths of type `file`.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.is_valid_sprite_path View documentation}
    * @param sprite_path Path to the image.
-   * @remarks The existence of the image is not checked for paths of type `file`.
    */
   is_valid_sprite_path(sprite_path: SpritePath): boolean
   /**
@@ -12131,7 +12273,7 @@ interface LuaGameScript {
    */
   create_profiler(stopped?: boolean): LuaProfiler
   /**
-   * Evaluate an expression, substituting variables as provided. For details on the formula, see the relevant page on the {@link https://wiki.factorio.com/Prototype/Technology#unit Factorio wiki}.
+   * Evaluate an expression, substituting variables as provided. For details on the formula, see the relevant page on the {@linkplain https://wiki.factorio.com/Prototype/Technology#unit Factorio wiki}.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.evaluate_expression View documentation}
    * @param expression The expression to evaluate.
@@ -12304,7 +12446,7 @@ interface LuaGameScript {
    */
   decode_string(string: string): string | undefined
   /**
-   * This property is only populated inside {@link LuaCommandProcessor custom command} handlers and when writing {@link https://wiki.factorio.com/Console#Scripting_and_cheat_commands Lua console commands}. Returns the player that is typing the command, `nil` in all other instances.
+   * This property is only populated inside {@link LuaCommandProcessor custom command} handlers and when writing {@linkplain https://wiki.factorio.com/Console#Scripting_and_cheat_commands Lua console commands}. Returns the player that is typing the command, `nil` in all other instances.
    *
    * See {@link LuaGameScript#players LuaGameScript::players} for accessing all players.
    *
@@ -12785,6 +12927,8 @@ interface LuaGui {
   /**
    * Returns `true` if sprite_path is valid and contains loaded sprite, otherwise `false`. Sprite path of type `file` doesn't validate if file exists.
    *
+   * If you want to avoid needing a LuaGui object, {@link LuaGameScript#is_valid_sprite_path LuaGameScript::is_valid_sprite_path} can be used instead.
+   *
    * {@link https://lua-api.factorio.com/latest/LuaGui.html#LuaGui.is_valid_sprite_path View documentation}
    * @param sprite_path Path to a image.
    */
@@ -12884,7 +13028,7 @@ interface BaseGuiSpec {
    */
   readonly type: GuiElementType
   /**
-   * Name of the child element.
+   * Name of the child element. It must be unique within the parent element.
    */
   readonly name?: string
   /**
@@ -13403,7 +13547,7 @@ interface BaseGuiElement {
    * Other attributes may be specified depending on `type`:
    *
    * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.add View documentation}
-   * @returns The added GUI element.
+   * @returns The GUI element that was added.
    */
   add<Type extends GuiElementType>(
     element: GuiSpec & {
@@ -13492,7 +13636,7 @@ interface BaseGuiElement {
    */
   readonly parent: LuaGuiElement | undefined
   /**
-   * The name of this element.
+   * The name of this element. `""` if no name was set.
    *
    * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.name View documentation}
    * @example
@@ -19142,6 +19286,10 @@ interface LuaPlayer extends LuaControl {
   /**
    * Invokes the "clear cursor" action on the player as if the user pressed it.
    *
+   * **Raised events:**
+   * - {@link OnPlayerCursorStackChangedEvent on_player_cursor_stack_changed}? _current_tick_ Raised when the cursor was successfully cleared.
+   *
+   *
    * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.clear_cursor View documentation}
    * @returns Whether the cursor is now empty.
    */
@@ -20036,7 +20184,7 @@ interface LuaRailSignalControlBehavior extends LuaControlBehavior {
 }
 
 /**
- * A deterministic random generator independent from the core games random generator that can be seeded and re-seeded at will. This random generator can be saved and loaded and will maintain its state. Note this is entirely different from calling {@link https://lua-api.factorio.com/latest/Libraries.html#math.random math.random}() and you should be sure you actually want to use this over calling `math.random()`. If you aren't sure if you need to use this over calling `math.random()` then you probably don't need to use this.
+ * A deterministic random generator independent from the core games random generator that can be seeded and re-seeded at will. This random generator can be saved and loaded and will maintain its state. Note this is entirely different from calling {@linkplain https://lua-api.factorio.com/latest/Libraries.html#math.random math.random}() and you should be sure you actually want to use this over calling `math.random()`. If you aren't sure if you need to use this over calling `math.random()` then you probably don't need to use this.
  *
  * {@link https://lua-api.factorio.com/latest/LuaRandomGenerator.html View documentation}
  * @noSelf
@@ -20521,11 +20669,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20570,11 +20718,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20637,11 +20785,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20689,11 +20837,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20744,11 +20892,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20799,11 +20947,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20877,11 +21025,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20940,11 +21088,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -20964,7 +21112,7 @@ interface LuaRendering {
    */
   draw_animation(params: {
     /**
-     * Name of an {@link https://wiki.factorio.com/Prototype/Animation animation prototype}.
+     * Name of an {@linkplain https://wiki.factorio.com/Prototype/Animation animation prototype}.
      */
     readonly animation: string
     /**
@@ -21015,11 +21163,11 @@ interface LuaRendering {
      */
     readonly time_to_live?: uint
     /**
-     * The forces that this object is rendered to.
+     * The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
      */
     readonly forces?: readonly ForceIdentification[]
     /**
-     * The players that this object is rendered to.
+     * The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
      */
     readonly players?: readonly PlayerIdentification[]
     /**
@@ -23118,7 +23266,7 @@ interface CharacterCorpseSurfaceCreateEntity extends BaseSurfaceCreateEntity {
 
 interface HighlightBoxSurfaceCreateEntity extends BaseSurfaceCreateEntity {
   /**
-   * The bounding box defining the highlight box using absolute map coordinates. If specified, the `position` parameter is ignored, but needs to be present anyways. If not specified, the game falls back to the `source` parameter first, then the `target` parameter second. One of these three parameters need to be specified.
+   * The bounding box defining the highlight box using absolute map coordinates. If specified, the general `position` parameter still needs to be present, but will be ignored. If not specified, the game falls back to the `source` parameter first, then the `target` parameter second. One of these three parameters need to be specified.
    */
   readonly bounding_box?: BoundingBox
   /**
@@ -23347,9 +23495,22 @@ interface LuaSurface {
      */
     readonly radius?: double
     readonly name?: string | readonly string[]
+    readonly force?: ForceIdentification | readonly ForceIdentification[]
     readonly limit?: uint
     readonly has_hidden_tile?: boolean
+    /**
+     * Can be further filtered by supplying a `force` filter.
+     */
+    readonly has_tile_ghost?: boolean
+    /**
+     * Can be further filtered by supplying a `force` filter.
+     */
+    readonly to_be_deconstructed?: boolean
     readonly collision_mask?: CollisionMaskLayer | readonly CollisionMaskLayer[]
+    /**
+     * Whether the filters should be inverted.
+     */
+    readonly invert?: boolean
   }): LuaTile[]
   /**
    * Count entities of given type or name in a given area. Works just like {@link LuaSurface#find_entities_filtered LuaSurface::find_entities_filtered}, except this only returns the count. As it doesn't construct all the wrapper objects, this is more efficient if one is only interested in the number of entities.
@@ -23377,7 +23538,7 @@ interface LuaSurface {
     readonly limit?: uint
     readonly is_military_target?: boolean
     /**
-     * If the filters should be inverted.
+     * Whether the filters should be inverted.
      */
     readonly invert?: boolean
   }): uint
@@ -23399,9 +23560,22 @@ interface LuaSurface {
      */
     readonly radius?: double
     readonly name?: string | readonly string[]
+    readonly force?: ForceIdentification | readonly ForceIdentification[]
     readonly limit?: uint
     readonly has_hidden_tile?: boolean
+    /**
+     * Can be further filtered by supplying a `force` filter.
+     */
+    readonly has_tile_ghost?: boolean
+    /**
+     * Can be further filtered by supplying a `force` filter.
+     */
+    readonly to_be_deconstructed?: boolean
     readonly collision_mask?: CollisionMaskLayer | readonly CollisionMaskLayer[]
+    /**
+     * If the filters should be inverted.
+     */
+    readonly invert?: boolean
   }): uint
   /**
    * Find a non-colliding position within a given radius.
@@ -23502,7 +23676,7 @@ interface LuaSurface {
     readonly condition: ForceCondition
   }): LuaEntity[]
   /**
-   * Find the enemy military target ({@link https://wiki.factorio.com/Military_units_and_structures military entity}) closest to the given position.
+   * Find the enemy military target ({@linkplain https://wiki.factorio.com/Military_units_and_structures military entity}) closest to the given position.
    *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_nearest_enemy View documentation}
    * @returns The nearest enemy military target or `nil` if no enemy could be found within the given area.
@@ -23950,6 +24124,13 @@ interface LuaSurface {
     readonly area?: BoundingBox
     readonly position?: TilePosition
     readonly name?: string | readonly string[] | LuaDecorativePrototype | readonly LuaDecorativePrototype[]
+    readonly collision_mask?: CollisionMaskLayer | readonly CollisionMaskLayer[]
+    readonly from_layer?: string
+    readonly to_layer?: string
+    /**
+     * Soft decoratives can be drawn over rails.
+     */
+    readonly exclude_soft?: boolean
     readonly limit?: uint
     /**
      * If the filters should be inverted.
@@ -23986,6 +24167,13 @@ interface LuaSurface {
     readonly area?: BoundingBox
     readonly position?: TilePosition
     readonly name?: string | readonly string[] | LuaDecorativePrototype | readonly LuaDecorativePrototype[]
+    readonly collision_mask?: CollisionMaskLayer | readonly CollisionMaskLayer[]
+    readonly from_layer?: string
+    readonly to_layer?: string
+    /**
+     * Soft decoratives can be drawn over rails.
+     */
+    readonly exclude_soft?: boolean
     readonly limit?: uint
     /**
      * If the filters should be inverted.
@@ -24789,8 +24977,9 @@ interface LuaTile {
    * Is this tile marked for deconstruction?
    *
    * {@link https://lua-api.factorio.com/latest/LuaTile.html#LuaTile.to_be_deconstructed View documentation}
+   * @param force The force who did the deconstruction order.
    */
-  to_be_deconstructed(): boolean
+  to_be_deconstructed(force?: ForceIdentification): boolean
   /**
    * Orders deconstruction of this tile by the given force.
    *
@@ -24816,6 +25005,20 @@ interface LuaTile {
    * @param player The player to set the last_user to if any.
    */
   cancel_deconstruction(force: ForceIdentification, player?: PlayerIdentification): void
+  /**
+   * Does this tile have any tile ghosts on it.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaTile.html#LuaTile.has_tile_ghost View documentation}
+   * @param force Check for tile ghosts of this force.
+   */
+  has_tile_ghost(force?: ForceIdentification): boolean
+  /**
+   * Gets all tile ghosts on this tile.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaTile.html#LuaTile.get_tile_ghosts View documentation}
+   * @param force Get tile ghosts of this force.
+   */
+  get_tile_ghosts(force?: ForceIdentification): LuaTile[]
   /**
    * Prototype name of this tile. E.g. `"sand-3"` or `"grass-2"`.
    *
@@ -24915,11 +25118,11 @@ interface LuaTilePrototype {
     /**
      * Energy required to mine a tile.
      */
-    readonly miningtime: double
+    readonly mining_time: double
     /**
      * Prototype name of the particle produced when mining this tile. Will only be present if this tile produces any particle during mining.
      */
-    readonly miningparticle?: string
+    readonly mining_particle?: string
     /**
      * Products obtained by mining this tile.
      */
@@ -24932,11 +25135,11 @@ interface LuaTilePrototype {
    */
   readonly next_direction: LuaTilePrototype | undefined
   /**
-   * Items that when placed will produce this tile. It is a dictionary indexed by the item prototype name.
+   * Items that when placed will produce this tile. It is a dictionary indexed by the item prototype name. `nil` (instead of an empty table) if no items can place this tile.
    *
    * {@link https://lua-api.factorio.com/latest/LuaTilePrototype.html#LuaTilePrototype.items_to_place_this View documentation}
    */
-  readonly items_to_place_this: SimpleItemStack[]
+  readonly items_to_place_this: SimpleItemStack[] | undefined
   /**
    * False if this tile is not allowed in blueprints regardless of the ability to build it.
    *

package/generated/concepts.d.ts

@@ -385,6 +385,10 @@ interface CraftingQueueItem {
    * The amount of items being crafted.
    */
   readonly count: uint
+  /**
+   * The item is a prerequisite for another item in the queue.
+   */
+  readonly prerequisite: boolean
 }
 
 interface Alert {
@@ -651,7 +655,7 @@ interface EnemyEvolutionMapSettings {
 }
 
 /**
- * Candidate chunks are given scores to determine which one of them should be expanded into. This score takes into account various settings noted below. The iteration is over a square region centered around the chunk for which the calculation is done, and includes the central chunk as well. Distances are calculated as {@link https://en.wikipedia.org/wiki/Taxicab_geometry Manhattan distance}.
+ * Candidate chunks are given scores to determine which one of them should be expanded into. This score takes into account various settings noted below. The iteration is over a square region centered around the chunk for which the calculation is done, and includes the central chunk as well. Distances are calculated as {@linkplain https://en.wikipedia.org/wiki/Taxicab_geometry Manhattan distance}.
  *
  * The pseudocode algorithm to determine a chunk's score is as follows:
  *
@@ -1503,7 +1507,7 @@ interface AutoplaceSpecification {
 }
 
 /**
- * A fragment of a functional program used to generate coherent noise, probably for purposes related to terrain generation. These can only be meaningfully written/modified during the data load phase. More detailed information is found on the {@link https://wiki.factorio.com/Types/NoiseExpression wiki}.
+ * A fragment of a functional program used to generate coherent noise, probably for purposes related to terrain generation. These can only be meaningfully written/modified during the data load phase. More detailed information is found on the {@linkplain https://wiki.factorio.com/Types/NoiseExpression wiki}.
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#NoiseExpression View documentation}
  */
@@ -2719,7 +2723,9 @@ type SpriteType =
   | "utility"
 
 /**
- * It is specified by {@link string}. It can be either the name of a {@link https://wiki.factorio.com/Prototype/Sprite sprite prototype} defined in the data stage or a path in form "type/name".
+ * It is specified by {@link string}. It can be either the name of a {@linkplain https://wiki.factorio.com/Prototype/Sprite sprite prototype} defined in the data stage or a path in form "type/name".
+ *
+ * The validity of a SpritePath can be verified at runtime using {@link LuaGameScript#is_valid_sprite_path LuaGameScript::is_valid_sprite_path}.
  *
  * The supported types are:
  * - `"item"` - for example "item/iron-plate" is the icon sprite of iron plate
@@ -2740,31 +2746,33 @@ type SpriteType =
 type SpritePath = string | `${SpriteType}/${string}`
 
 /**
- * A sound defined by a {@link string}. It can be either the name of a {@link https://wiki.factorio.com/Prototype/Sound sound prototype} defined in the data stage or a path in the form `"type/name"`. The latter option can be sorted into three categories.
+ * A sound defined by a {@link string}. It can be either the name of a {@linkplain https://wiki.factorio.com/Prototype/Sound sound prototype} defined in the data stage or a path in the form `"type/name"`. The latter option can be sorted into three categories.
+ *
+ * The validity of a SoundPath can be verified at runtime using {@link LuaGameScript#is_valid_sound_path LuaGameScript::is_valid_sound_path}.
  *
  * The utility and ambient types each contain general use sound prototypes defined by the game itself.
- * - `"utility"` - Uses the {@link https://wiki.factorio.com/Prototype/UtilitySounds UtilitySounds} prototype. Example: `"utility/wire_connect_pole"`
- * - `"ambient"` - Uses {@link https://wiki.factorio.com/Prototype/AmbientSound AmbientSound} prototypes. Example: `"ambient/resource-deficiency"`
+ * - `"utility"` - Uses the {@linkplain https://wiki.factorio.com/Prototype/UtilitySounds UtilitySounds} prototype. Example: `"utility/wire_connect_pole"`
+ * - `"ambient"` - Uses {@linkplain https://wiki.factorio.com/Prototype/AmbientSound AmbientSound} prototypes. Example: `"ambient/resource-deficiency"`
  *
  * The following types can be combined with any tile name as long as its prototype defines the
  *
  *     corresponding sound.
- * - `"tile-walking"` - Uses {@link https://wiki.factorio.com/Prototype/Tile#walking_sound Tile::walking_sound}. Example: `"tile-walking/concrete"`
- * - `"tile-mined"` - Uses {@link https://wiki.factorio.com/Prototype/Tile#mined_sound Tile::mined_sound}
- * - `"tile-build-small"` - Uses {@link https://wiki.factorio.com/Prototype/Tile#build_sound Tile::build_sound}. Example: `"tile-build-small/concrete"`
- * - `"tile-build-medium"` - Uses {@link https://wiki.factorio.com/Prototype/Tile#build_sound Tile::build_sound}
- * - `"tile-build-large"` - Uses {@link https://wiki.factorio.com/Prototype/Tile#build_sound Tile::build_sound}
+ * - `"tile-walking"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Tile#walking_sound Tile::walking_sound}. Example: `"tile-walking/concrete"`
+ * - `"tile-mined"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Tile#mined_sound Tile::mined_sound}
+ * - `"tile-build-small"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Tile#build_sound Tile::build_sound}. Example: `"tile-build-small/concrete"`
+ * - `"tile-build-medium"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Tile#build_sound Tile::build_sound}
+ * - `"tile-build-large"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Tile#build_sound Tile::build_sound}
  *
  * The following types can be combined with any entity name as long as its prototype defines the
  *
  *     corresponding sound.
- * - `"entity-build"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#build_sound Entity::build_sound}. Example: `"entity-build/wooden-chest"`
- * - `"entity-mined"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#mined_sound Entity::mined_sound}
- * - `"entity-mining"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#mining_sound Entity::mining_sound}
- * - `"entity-vehicle_impact"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#vehicle_impact_sound Entity::vehicle_impact_sound}
- * - `"entity-rotated"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#rotated_sound Entity::rotated_sound}
- * - `"entity-open"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#open_sound Entity::open_sound}
- * - `"entity-close"` - Uses {@link https://wiki.factorio.com/Prototype/Entity#close_sound Entity::close_sound}
+ * - `"entity-build"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#build_sound Entity::build_sound}. Example: `"entity-build/wooden-chest"`
+ * - `"entity-mined"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#mined_sound Entity::mined_sound}
+ * - `"entity-mining"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#mining_sound Entity::mining_sound}
+ * - `"entity-vehicle_impact"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#vehicle_impact_sound Entity::vehicle_impact_sound}
+ * - `"entity-rotated"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#rotated_sound Entity::rotated_sound}
+ * - `"entity-open"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#open_sound Entity::open_sound}
+ * - `"entity-close"` - Uses {@linkplain https://wiki.factorio.com/Prototype/Entity#close_sound Entity::close_sound}
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#SoundPath View documentation}
  */
@@ -3379,7 +3387,7 @@ type Alignment =
   | "bottom-right"
 
 /**
- * Information about the event that has been raised. The table can also contain other fields depending on the type of event. See {@link https://lua-api.factorio.com/latest/events.html the list of Factorio events} for more information on these.
+ * Information about the event that has been raised. The table can also contain other fields depending on the type of event. See {@linkplain https://lua-api.factorio.com/latest/events.html the list of Factorio events} for more information on these.
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#EventData View documentation}
  */
@@ -4165,9 +4173,9 @@ interface CollisionMaskDecorativePrototypeFilter extends BaseDecorativePrototype
   readonly filter: "collision-mask"
   readonly mask: CollisionMask | CollisionMaskWithFlags
   /**
-   * How to filter: `"collides"` or `"layers-equals"`
+   * How to filter: `"collides"`, `"layers-equals"`, `"contains-any"` or `"contains-all"`
    */
-  readonly mask_mode: "collides" | "layers-equals"
+  readonly mask_mode: "collides" | "layers-equals" | "contains-any" | "contains-all"
 }
 
 interface DecalDecorativePrototypeFilter extends BaseDecorativePrototypeFilter {
@@ -4401,9 +4409,9 @@ interface CollisionMaskTilePrototypeFilter extends BaseTilePrototypeFilter {
   readonly filter: "collision-mask"
   readonly mask: CollisionMask | CollisionMaskWithFlags
   /**
-   * How to filter: `"collides"` or `"layers-equals"`
+   * How to filter: `"collides"`, `"layers-equals"`, `"contains-any"` or `"contains-all"`
    */
-  readonly mask_mode: "collides" | "layers-equals"
+  readonly mask_mode: "collides" | "layers-equals" | "contains-any" | "contains-all"
 }
 
 interface WalkingSpeedModifierTilePrototypeFilter extends BaseTilePrototypeFilter {
@@ -4777,9 +4785,9 @@ interface CollisionMaskEntityPrototypeFilter extends BaseEntityPrototypeFilter {
   readonly filter: "collision-mask"
   readonly mask: CollisionMask | CollisionMaskWithFlags
   /**
-   * How to filter: `"collides"` or `"layers-equals"`
+   * How to filter: `"collides"`, `"layers-equals"`, `"contains-any"` or `"contains-all"`
    */
-  readonly mask_mode: "collides" | "layers-equals"
+  readonly mask_mode: "collides" | "layers-equals" | "contains-any" | "contains-all"
 }
 
 /**

package/generated/defines.d.ts

@@ -643,7 +643,7 @@ declare namespace defines {
     cant_divide_segments,
   }
   /**
-   * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
+   * See the {@linkplain https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
    *
    * {@link https://lua-api.factorio.com/latest/defines.html#defines.events View documentation}
    */
@@ -1396,7 +1396,7 @@ declare namespace defines {
     const on_player_reverse_selected_area: EventId<OnPlayerReverseSelectedAreaEvent>
   }
   /**
-   * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
+   * See the {@linkplain https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
    *
    * {@link https://lua-api.factorio.com/latest/defines.html#defines.events View documentation}
    */

package/generated/events.d.ts

@@ -3,7 +3,7 @@
 /** @noSelfInFile */
 
 /**
- * Called when a {@link https://wiki.factorio.com/Prototype/CustomInput CustomInput} is activated.
+ * Called when a {@linkplain https://wiki.factorio.com/Prototype/CustomInput CustomInput} is activated.
  *
  * {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent View documentation}
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "1.1.0",
+  "version": "1.3.1",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -22,7 +22,8 @@
     "lint": "eslint .",
     "check": "yarn run lint && yarn run test",
     "prepublishOnly": "yarn run check",
-    "download-latest-runtime-api": "ts-node ./scripts/downloadLatest.ts"
+    "download-latest-runtime-api": "ts-node ./scripts/downloadLatest.ts",
+    "next-version": "yarn run download-latest-runtime-api && yarn run clean && yarn test && yarn version --minor"
   },
   "peerDependencies": {
     "lua-types": "^2.11.0",