typed-factorio 1.12.0 → 1.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -29,33 +29,34 @@
     "next-factorio-version": "yarn run download-latest-runtime-api && yarn run clean && yarn run check && yarn run new-version-changelog && npm version minor"
   },
   "peerDependencies": {
-    "lua-types": "^2.13.0",
+    "lua-types": "^2.13.1",
     "typescript-to-lua": "^1.6.1"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.2",
-    "@types/node": "^18.11.9",
-    "@types/prettier": "^2.7.1",
-    "@typescript-eslint/eslint-plugin": "^5.42.0",
-    "@typescript-eslint/parser": "^5.42.0",
-    "chalk": "^5.1.2",
-    "eslint": "~8.26.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@types/jest": "^29.2.5",
+    "@types/node": "^18.11.18",
+    "@types/prettier": "^2.7.2",
+    "@typescript-eslint/eslint-plugin": "^5.48.1",
+    "@typescript-eslint/parser": "^5.48.1",
+    "array.prototype.flatmap": "^1.3.1",
+    "chalk": "^5.2.0",
+    "eslint": "~8.31.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-config-standard": "^17.0.0",
-    "eslint-import-resolver-typescript": "^3.5.2",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-n": "^15.4.0",
+    "eslint-import-resolver-typescript": "^3.5.3",
+    "eslint-plugin-import": "^2.27.0",
+    "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.1.1",
-    "jest": "^29.2.2",
-    "lua-types": "^2.13.0",
-    "prettier": "^2.7.1",
+    "jest": "^29.3.1",
+    "lua-types": "^2.13.1",
+    "prettier": "^2.8.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.0.4",
     "ts-node": "^10.9.1",
-    "typescript": "~4.8.4",
-    "typescript-to-lua": "^1.10.1"
+    "typescript": "~4.9.4",
+    "typescript-to-lua": "^1.11.1"
   },
   "packageManager": "yarn@3.2.3"
 }

package/runtime/generated/classes.d.ts

@@ -239,7 +239,7 @@ interface LuaBootstrap {
    */
   register_metatable(name: string, metatable: table): 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 {@linkplain 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 game version or any mod version changed, when any mod was added or removed, when a startup setting has changed, when any prototypes have been added or removed, or when a migration was applied. 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}.
    * @param handler The handler for this event. Passing `nil` will unregister it.
    * @remarks For more context, refer to the {@linkplain https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
    * @see {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_configuration_changed Online documentation}
@@ -335,6 +335,11 @@ interface LuaBootstrap {
    * @see {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.get_event_filter Online documentation}
    */
   get_event_filter<E extends EventId<any, table>>(event: E): E["_filter"][] | nil
+  /**
+   * Gets the prototype history for the given type and name.
+   * @see {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.get_prototype_history Online documentation}
+   */
+  get_prototype_history(type: string, name: string): PrototypeHistory
   /**
    * Raise an event. Only events generated with {@link LuaBootstrap#generate_event_name LuaBootstrap::generate_event_name} and the following can be raised:
    *
@@ -413,6 +418,10 @@ interface LuaBootstrap {
      * Whether the transfer was from player to entity. If `false`, the transfer was from entity to player.
      */
     readonly from_player: boolean
+    /**
+     * Whether the transfer was a split action (half stack).
+     */
+    readonly is_split: boolean
   }): void
   /**
    * **Raised events:**
@@ -1238,6 +1247,11 @@ interface LuaControl {
    * @see {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.surface Online documentation}
    */
   readonly surface: LuaSurface
+  /**
+   * Unique ID associated with the surface this entity is currently on.
+   * @see {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.surface_index Online documentation}
+   */
+  readonly surface_index: SurfaceIndex
   /**
    * The current position of the entity.
    * @see {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.position Online documentation}
@@ -1254,6 +1268,11 @@ interface LuaControl {
    */
   get force(): LuaForce
   set force(value: ForceIdentification)
+  /**
+   * Unique ID associated with the force of this entity.
+   * @see {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.force_index Online documentation}
+   */
+  readonly force_index: uint
   /**
    * The currently selected entity. Assigning an entity will select it if is selectable, otherwise the selection is cleared.
    *
@@ -2146,7 +2165,7 @@ interface LuaEntity extends LuaControl {
    * Sets the entity to be deconstructed by construction robots.
    *
    * **Raised events:**
-   * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the entity way successfully marked for deconstruction.
+   * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the entity was successfully marked for deconstruction.
    * @param force The force whose robots are supposed to do the deconstruction.
    * @param player The player to set the `last_user` to if any.
    * @returns if the entity was marked for deconstruction.
@@ -2172,7 +2191,7 @@ interface LuaEntity extends LuaControl {
    * Sets the entity to be upgraded by construction robots.
    *
    * **Raised events:**
-   * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised if the entity way successfully marked for upgrade.
+   * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised if the entity was successfully marked for upgrade.
    * @returns Whether the entity was marked for upgrade.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.order_upgrade Online documentation}
    */
@@ -3645,6 +3664,12 @@ interface LuaEntity extends LuaControl {
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.electric_network_statistics Online documentation}
    */
   readonly electric_network_statistics: LuaFlowStatistics
+  /**
+   * Returns the current target pickup count of the inserter.
+   * @remarks This considers the circuit network, manual override and the inserter stack size limit based on technology.
+   * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.inserter_target_pickup_count Online documentation}
+   */
+  readonly inserter_target_pickup_count: uint
   /**
    * Sets the stack size limit on this inserter. If the stack size is > than the force stack size limit the value is ignored.
    * @remarks Set to 0 to reset.
@@ -4184,7 +4209,7 @@ interface BaseEntity extends LuaControl {
    * Sets the entity to be deconstructed by construction robots.
    *
    * **Raised events:**
-   * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the entity way successfully marked for deconstruction.
+   * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the entity was successfully marked for deconstruction.
    * @param force The force whose robots are supposed to do the deconstruction.
    * @param player The player to set the `last_user` to if any.
    * @returns if the entity was marked for deconstruction.
@@ -4210,7 +4235,7 @@ interface BaseEntity extends LuaControl {
    * Sets the entity to be upgraded by construction robots.
    *
    * **Raised events:**
-   * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised if the entity way successfully marked for upgrade.
+   * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised if the entity was successfully marked for upgrade.
    * @returns Whether the entity was marked for upgrade.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.order_upgrade Online documentation}
    */
@@ -4979,6 +5004,12 @@ interface BaseEntity extends LuaControl {
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.sticked_to Online documentation}
    */
   readonly sticked_to: LuaEntity
+  /**
+   * Returns the current target pickup count of the inserter.
+   * @remarks This considers the circuit network, manual override and the inserter stack size limit based on technology.
+   * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.inserter_target_pickup_count Online documentation}
+   */
+  readonly inserter_target_pickup_count: uint
   /**
    * Sets the stack size limit on this inserter. If the stack size is > than the force stack size limit the value is ignored.
    * @remarks Set to 0 to reset.
@@ -7686,6 +7717,11 @@ interface LuaEntityPrototype {
    * @see {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.alert_icon_shift Online documentation}
    */
   readonly alert_icon_shift: Vector
+  /**
+   * The alert icon scale of this entity prototype.
+   * @see {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.alert_icon_scale Online documentation}
+   */
+  readonly alert_icon_scale: float
   /**
    * The item prototype names that are the inputs of this lab prototype.
    *
@@ -8458,6 +8494,11 @@ interface BaseEntityPrototype {
    * @see {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.alert_icon_shift Online documentation}
    */
   readonly alert_icon_shift: Vector
+  /**
+   * The alert icon scale of this entity prototype.
+   * @see {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.alert_icon_scale Online documentation}
+   */
+  readonly alert_icon_scale: float
   /**
    * Whether this entity prototype could possibly ever be rotated.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.supports_direction Online documentation}
@@ -12458,6 +12499,11 @@ interface LuaGameScript {
    * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.map_gen_presets Online documentation}
    */
   readonly map_gen_presets: LuaCustomTable<string, MapGenPreset>
+  /**
+   * Whether a console command has been used.
+   * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.console_command_used Online documentation}
+   */
+  readonly console_command_used: boolean
   /**
    * The styles that {@link LuaGuiElement} can use, indexed by `name`.
    * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.styles Online documentation}
@@ -18835,10 +18881,6 @@ interface LuaPlayer extends LuaControl {
   }): boolean
   /**
    * Checks if this player can build what ever is in the cursor on the surface the player is on.
-   *
-   * **Raised events:**
-   * - {@link OnPreBuildEvent on_pre_build}? _instantly_ Raised if the cursor was successfully built.
-   * - {@link OnBuiltEntityEvent on_built_entity}? _instantly_ Raised if the cursor was successfully built.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.can_build_from_cursor Online documentation}
    */
   can_build_from_cursor(params: {
@@ -18864,8 +18906,11 @@ interface LuaPlayer extends LuaControl {
     readonly skip_fog_of_war?: boolean
   }): boolean
   /**
-   * Builds what ever is in the cursor on the surface the player is on.
-   * @remarks Anything built will fire normal player-built events.<br>The cursor stack will automatically be reduced as if the player built normally.
+   * Builds what ever is in the cursor on the surface the player is on. The cursor stack will automatically be reduced as if the player built normally.
+   *
+   * **Raised events:**
+   * - {@link OnPreBuildEvent on_pre_build}? _instantly_ Raised if the cursor was successfully built.
+   * - {@link OnBuiltEntityEvent on_built_entity}? _instantly_ Raised if the cursor was successfully built.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.build_from_cursor Online documentation}
    */
   build_from_cursor(params: {
@@ -19006,15 +19051,17 @@ interface LuaPlayer extends LuaControl {
    */
   exit_cutscene(): void
   /**
-   * Queues a request to open the map at the specified position. If the map is already opened, the request will simply set the position (and scale). Render mode change requests are processed before rendering of the next frame.
+   * Queues a request to open the map at the specified position. If the map is already opened, the request will simply set the position, scale, and entity to follow. Render mode change requests are processed before rendering of the next frame.
+   * @param entity The entity to follow. If not given the current entity being followed will be cleared.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.open_map Online documentation}
    */
-  open_map(position: MapPosition | MapPositionArray, scale?: double): void
+  open_map(position: MapPosition | MapPositionArray, scale?: double, entity?: LuaEntity): void
   /**
-   * Queues a request to zoom to world at the specified position. If the player is already zooming to world, the request will simply set the position (and scale). Render mode change requests are processed before rendering of the next frame.
+   * Queues a request to zoom to world at the specified position. If the player is already zooming to world, the request will simply set the position, scale, and entity to follow. Render mode change requests are processed before rendering of the next frame.
+   * @param entity The entity to follow. If not given the current entity being followed will be cleared.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.zoom_to_world Online documentation}
    */
-  zoom_to_world(position: MapPosition | MapPositionArray, scale?: double): void
+  zoom_to_world(position: MapPosition | MapPositionArray, scale?: double, entity?: LuaEntity): void
   /**
    * Queues request to switch to the normal game view from the map or zoom to world view. Render mode change requests are processed before rendering of the next frame.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.close_map Online documentation}
@@ -19307,6 +19354,11 @@ interface LuaPlayer extends LuaControl {
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.cursor_stack_temporary Online documentation}
    */
   cursor_stack_temporary: boolean
+  /**
+   * The wire drag target for this player, if any.
+   * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.drag_target Online documentation}
+   */
+  readonly drag_target?: DragTarget
   /**
    * The player's zoom-level.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.zoom Online documentation}
@@ -19476,6 +19528,11 @@ interface LuaRailPath {
    * @see {@link https://lua-api.factorio.com/latest/LuaRailPath.html#LuaRailPath.rails Online documentation}
    */
   readonly rails: LuaCustomTable<uint, LuaEntity>
+  /**
+   * If the path goes from the front of the train
+   * @see {@link https://lua-api.factorio.com/latest/LuaRailPath.html#LuaRailPath.is_front Online documentation}
+   */
+  readonly is_front: boolean
   /**
    * 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.
    */
@@ -21269,7 +21326,7 @@ interface LuaShortcutPrototype {
    */
   readonly item_to_spawn?: LuaItemPrototype
   /**
-   * The technology to unlock when this shortcut is used, if any.
+   * The technology that needs to be researched once (in any save) for this shortcut to be unlocked (in all saves).
    * @see {@link https://lua-api.factorio.com/latest/LuaShortcutPrototype.html#LuaShortcutPrototype.technology_to_unlock Online documentation}
    */
   readonly technology_to_unlock?: LuaTechnologyPrototype
@@ -23642,6 +23699,7 @@ interface LuaSurface {
    */
   get_total_pollution(): double
   /**
+   * Whether the given entity prototype collides at the given position and direction.
    * @param prototype The entity prototype to check
    * @param position The position to check
    * @param use_map_generation_bounding_box If the map generation bounding box should be used instead of the collision bounding box
@@ -23652,13 +23710,14 @@ interface LuaSurface {
     position: MapPosition | MapPositionArray,
     use_map_generation_bounding_box: boolean,
     direction?: defines.direction
-  ): void
+  ): boolean
   /**
+   * Whether the given decorative prototype collides at the given position and direction.
    * @param prototype The decorative prototype to check
    * @param position The position to check
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.decorative_prototype_collides Online documentation}
    */
-  decorative_prototype_collides(prototype: string, position: MapPosition | MapPositionArray): void
+  decorative_prototype_collides(prototype: string, position: MapPosition | MapPositionArray): boolean
   /**
    * @param property_names Names of properties (e.g. "elevation") to calculate
    * @param positions Positions for which to calculate property values
@@ -23684,6 +23743,9 @@ interface LuaSurface {
   build_checkerboard(area: BoundingBoxWrite | BoundingBoxArray): void
   /**
    * The name of this surface. Names are unique among surfaces.
+   *
+   * **Raised events:**
+   * - {@link OnSurfaceRenamedEvent on_surface_renamed} _instantly_
    * @remarks the default surface can't be renamed.
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.name Online documentation}
    */
@@ -23776,7 +23838,7 @@ interface LuaSurface {
    */
   solar_power_multiplier: double
   /**
-   * The minimal brightness during the night. Default is `0.15`. The value has an effect on the game simalution only, it doesn't have any effect on rendering.
+   * The minimal brightness during the night. Defaults to `0.15`. This has an effect on both rendering and game mechanics such as biter spawns and solar power.
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.min_brightness Online documentation}
    */
   min_brightness: double

package/runtime/generated/concepts.d.ts

@@ -242,6 +242,8 @@ interface OldTileAndPosition {
 
 /**
  * A dictionary of string to the four basic Lua types: `string`, `boolean`, `number`, `table`.
+ *
+ * Note that the API returns tags as a simple table, meaning any modifications to it will not propagate back to the game. Thus, to modify a set of tags, the whole table needs to be written back to the respective property.
  * @example
  *
  * ```
@@ -546,6 +548,17 @@ interface DecorativeResult {
   readonly amount: uint
 }
 
+interface PrototypeHistory {
+  /**
+   * The mod that created this prototype.
+   */
+  readonly created: string
+  /**
+   * The mods that changed this prototype in the order they changed it.
+   */
+  readonly changed: string[]
+}
+
 /**
  * @remarks Either `icon`, `text`, or both must be provided.
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#ChartTagSpec Online documentation}
@@ -2636,11 +2649,23 @@ interface WireConnectionDefinition {
   /**
    * Mandatory if the source entity has more than one wire connection using copper wire.
    */
-  readonly source_wire_id?: defines.circuit_connector_id
+  readonly source_wire_id?: defines.wire_connection_id
   /**
    * Mandatory if the target entity has more than one wire connection using copper wire.
    */
-  readonly target_wire_id?: defines.circuit_connector_id
+  readonly target_wire_id?: defines.wire_connection_id
+}
+
+interface DragTarget {
+  readonly target_entity: LuaEntity
+  /**
+   * If the wire being dragged is a circuit wire this is the connector id.
+   */
+  readonly target_circuit_id?: defines.circuit_connector_id
+  /**
+   * If the wire being dragged is copper wire this is the wire id.
+   */
+  readonly target_wire_id?: defines.wire_connection_id
 }
 
 interface InventoryFilter {

package/runtime/generated/defines.d.ts

@@ -1332,7 +1332,7 @@ declare namespace defines {
    * 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.
    * @see {@link https://lua-api.factorio.com/latest/defines.html#defines.events Online documentation}
    */
-  type events = typeof events[keyof typeof events]
+  type events = (typeof events)[keyof typeof events]
   enum flow_precision_index {
     five_seconds,
     one_minute,

package/runtime/generated/events.d.ts

@@ -2152,6 +2152,10 @@ interface OnPlayerFastTransferredEvent extends EventData {
    * Whether the transfer was from player to entity. If `false`, the transfer was from entity to player.
    */
   readonly from_player: boolean
+  /**
+   * Whether the transfer was a split action (half stack).
+   */
+  readonly is_split: boolean
   /**
    * Identifier of the event
    */
@@ -2920,15 +2924,15 @@ interface OnPreBuildEvent extends EventData {
    */
   readonly direction: defines.direction
   /**
-   * If building this blueprint was flipped horizontally.
+   * Whether the blueprint was flipped horizontally. `nil` if not built by a blueprint.
    */
-  readonly flip_horizontal: boolean
+  readonly flip_horizontal: boolean | nil
   /**
-   * If building this blueprint was flipped vertically.
+   * Whether the blueprint was flipped vertically. `nil` if not built by a blueprint.
    */
-  readonly flip_vertical: boolean
+  readonly flip_vertical: boolean | nil
   /**
-   * Item was placed while moving.
+   * Whether the item was placed while moving.
    */
   readonly created_by_moving: boolean
   /**