typed-factorio 1.15.0 → 1.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -33,30 +33,28 @@
     "typescript-to-lua": "^1.6.1"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.1",
-    "@types/node": "^20.2.3",
-    "@types/prettier": "^2.7.2",
-    "@typescript-eslint/eslint-plugin": "^5.59.7",
-    "@typescript-eslint/parser": "^5.59.7",
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.3.1",
+    "@types/prettier": "^2.7.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.11",
+    "@typescript-eslint/parser": "^5.59.11",
     "array.prototype.flatmap": "^1.3.1",
     "chalk": "^5.2.0",
-    "eslint": "~8.41.0",
+    "eslint": "~8.42.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-config-standard": "^17.0.0",
     "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-eslint-comments": "latest",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.5.0",
     "lua-types": "^2.13.1",
     "prettier": "^2.8.8",
     "rimraf": "^5.0.1",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "~5.0.4",
-    "typescript-to-lua": "^1.15.1"
+    "typescript": "~5.1.3",
+    "typescript-to-lua": "^1.16.2"
   },
   "packageManager": "yarn@3.2.3"
 }

package/runtime/generated/builtin-types.d.ts

@@ -15,7 +15,7 @@ type float = number
 type double = number
 
 /**
- * 32-bit signed integer. Possible values are -2,147,483,648 to 2,147,483,647.
+ * 32-bit signed integer. Possible values are -2'147'483'648 to 2'147'483'647.
  * @see {@link https://lua-api.factorio.com/latest/Builtin-Types.html#int Online documentation}
  */
 type int = number
@@ -27,7 +27,7 @@ type int = number
 type int8 = number
 
 /**
- * 32-bit unsigned integer. Possible values are 0 to 4,294,967,295.
+ * 32-bit unsigned integer. Possible values are 0 to 4'294'967'295.
  * @see {@link https://lua-api.factorio.com/latest/Builtin-Types.html#uint Online documentation}
  */
 type uint = number
@@ -45,7 +45,7 @@ type uint8 = number
 type uint16 = number
 
 /**
- * 64-bit unsigned integer. Possible values are 0 to 18,446,744,073,709,551,615.
+ * 64-bit unsigned integer. Possible values are 0 to 18'446'744'073'709'551'615.
  * @see {@link https://lua-api.factorio.com/latest/Builtin-Types.html#uint64 Online documentation}
  */
 type uint64 = number

package/runtime/generated/classes.d.ts

@@ -1760,6 +1760,16 @@ interface LuaCustomInputPrototype {
    * @see {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.alternative_key_sequence Online documentation}
    */
   readonly alternative_key_sequence?: string
+  /**
+   * The default controller key sequence for this custom input, if any
+   * @see {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.controller_key_sequence Online documentation}
+   */
+  readonly controller_key_sequence?: string
+  /**
+   * The default controller alternative key sequence for this custom input, if any
+   * @see {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.controller_alternative_key_sequence Online documentation}
+   */
+  readonly controller_alternative_key_sequence?: string
   /**
    * The linked game control name, if any.
    * @see {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.linked_game_control Online documentation}
@@ -3350,6 +3360,9 @@ interface LuaEntity extends LuaControl {
   fluidbox: LuaFluidBox
   /**
    * The backer name assigned to this entity. Entities that support backer names are labs, locomotives, radars, roboports, and train stops. `nil` if this entity doesn't support backer names.
+   *
+   * **Raised events:**
+   * - {@link OnEntityRenamedEvent on_entity_renamed} _instantly_
    * @remarks While train stops get the name of a backer when placed down, players can rename them if they want to. In this case, `backer_name` returns the player-given name of the entity.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.backer_name Online documentation}
    */
@@ -3365,7 +3378,7 @@ interface LuaEntity extends LuaControl {
   /**
    * The ticks left before a ghost, combat robot, highlight box or smoke with trigger is destroyed.
    *
-   * - for ghosts set to uint32 max (4,294,967,295) to never expire.
+   * - for ghosts set to uint32 max (4'294'967'295) to never expire.
    * - for ghosts Cannot be set higher than {@link LuaForce#ghost_time_to_live LuaForce::ghost_time_to_live} of the entity's force.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.time_to_live Online documentation}
    */
@@ -4862,6 +4875,9 @@ interface BaseEntity extends LuaControl {
   fluidbox: LuaFluidBox
   /**
    * The backer name assigned to this entity. Entities that support backer names are labs, locomotives, radars, roboports, and train stops. `nil` if this entity doesn't support backer names.
+   *
+   * **Raised events:**
+   * - {@link OnEntityRenamedEvent on_entity_renamed} _instantly_
    * @remarks While train stops get the name of a backer when placed down, players can rename them if they want to. In this case, `backer_name` returns the player-given name of the entity.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.backer_name Online documentation}
    */
@@ -4877,7 +4893,7 @@ interface BaseEntity extends LuaControl {
   /**
    * The ticks left before a ghost, combat robot, highlight box or smoke with trigger is destroyed.
    *
-   * - for ghosts set to uint32 max (4,294,967,295) to never expire.
+   * - for ghosts set to uint32 max (4'294'967'295) to never expire.
    * - for ghosts Cannot be set higher than {@link LuaForce#ghost_time_to_live LuaForce::ghost_time_to_live} of the entity's force.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.time_to_live Online documentation}
    */
@@ -12035,7 +12051,7 @@ interface LuaGameScript {
    * @param name Name of the new surface.
    * @param settings Map generation settings.
    * @returns The surface that was just created.
-   * @remarks The game currently supports a maximum of 4,294,967,295 surfaces, including the default surface.<br>Surface names must be unique.
+   * @remarks The game currently supports a maximum of 4'294'967'295 surfaces, including the default surface.<br>Surface names must be unique.
    * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.create_surface Online documentation}
    */
   create_surface(name: string, settings?: MapGenSettingsWrite): LuaSurface
@@ -12454,7 +12470,7 @@ interface LuaGameScript {
    */
   readonly difficulty: defines.difficulty
   /**
-   * Get a table of all the forces that currently exist. This sparse table allows you to find forces by indexing it with either their `name` or `index`. Iterating this table with `pairs()` will only iterate the array part of the table. Iterating with `ipairs()` will not work at all.
+   * Get a table of all the forces that currently exist. This sparse table allows you to find forces by indexing it with either their `name` or `index`. Iterating this table with `pairs()` will only iterate the hash part of the table. Iterating with `ipairs()` will not work at all.
    * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.forces Online documentation}
    */
   readonly forces: LuaCustomTable<uint | string, LuaForce>
@@ -12625,8 +12641,9 @@ interface LuaGameScript {
    */
   readonly tick: uint
   /**
-   * The number of ticks since this game was 'created'. A game is 'created' either by using "new game" or "new game from scenario".
-   * @remarks This differs over {@link LuaGameScript#tick LuaGameScript::tick} in that making a game from a scenario always starts with ticks_played value at 0 even if the scenario has its own level data where the {@link LuaGameScript#tick LuaGameScript::tick} is > 0.<br>This value has no relation with {@link LuaGameScript#tick LuaGameScript::tick} and can be completely different values.
+   * The number of ticks since this game was created using either "new game" or "new game from scenario". Notably, this number progresses even when the game is {@link LuaGameScript#tick_paused tick_paused}.
+   *
+   * This differs from {@link LuaGameScript#tick LuaGameScript::tick} in that creating a game from a scenario always starts with this value at `0`, even if the scenario has its own level data where the `tick` has progressed past `0`.
    * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.ticks_played Online documentation}
    */
   readonly ticks_played: uint
@@ -12657,7 +12674,7 @@ interface LuaGameScript {
    */
   speed: float
   /**
-   * Get a table of all the surfaces that currently exist. This sparse table allows you to find surfaces by indexing it with either their `name` or `index`. Iterating this table with `pairs()` will only iterate the array part of the table. Iterating with `ipairs()` will not work at all.
+   * Get a table of all the surfaces that currently exist. This sparse table allows you to find surfaces by indexing it with either their `name` or `index`. Iterating this table with `pairs()` will only iterate the hash part of the table. Iterating with `ipairs()` will not work at all.
    * @see {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.surfaces Online documentation}
    */
   readonly surfaces: LuaCustomTable<SurfaceIndex | string, LuaSurface>
@@ -12974,6 +12991,14 @@ interface BaseGuiSpec {
    * Where to position the child element when in the `relative` element.
    */
   readonly anchor?: GuiAnchor
+  /**
+   * How the element should interact with game controllers. Defaults to {@link defines.game_controller_interaction.normal}.
+   */
+  readonly game_controller_interaction?: defines.game_controller_interaction
+  /**
+   * Whether this element will raise {@link OnGuiHoverEvent on_gui_hover} and {@link OnGuiLeaveEvent on_gui_leave}. Defaults to `false`.
+   */
+  readonly raise_hover_events?: boolean
 }
 
 /**
@@ -13674,6 +13699,11 @@ interface BaseGuiElement {
    */
   get location(): GuiLocation | nil
   set location(value: GuiLocation | GuiLocationArray | nil)
+  /**
+   * How this element should interact with game controllers.
+   * @see {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.game_controller_interaction Online documentation}
+   */
+  game_controller_interaction: defines.game_controller_interaction
   /**
    * Whether this GUI element is enabled. Disabled GUI elements don't trigger events when clicked.
    * @see {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.enabled Online documentation}
@@ -14074,7 +14104,7 @@ interface SpriteButtonGuiElementMembers extends BaseGuiElement {
    */
   auto_toggle: boolean
   /**
-   * Whether this button is currently toggled.
+   * Whether this button is currently toggled. When a button is toggled, it will use the `selected_graphical_set` and `selected_font_color` defined in its style.
    *
    * _Can only be used if this is button or sprite-button_
    * @see {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.toggled Online documentation}
@@ -14253,7 +14283,7 @@ interface ButtonGuiElementMembers extends BaseGuiElement {
    */
   auto_toggle: boolean
   /**
-   * Whether this button is currently toggled.
+   * Whether this button is currently toggled. When a button is toggled, it will use the `selected_graphical_set` and `selected_font_color` defined in its style.
    *
    * _Can only be used if this is button or sprite-button_
    * @see {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.toggled Online documentation}
@@ -18517,6 +18547,11 @@ interface LuaMiningDrillControlBehavior extends LuaGenericOnOffControlBehavior {
  * @noSelf
  */
 interface LuaModSettingPrototype {
+  /**
+   * Type of this prototype.
+   * @see {@link https://lua-api.factorio.com/latest/LuaModSettingPrototype.html#LuaModSettingPrototype.type Online documentation}
+   */
+  readonly type: string
   /**
    * Name of this prototype.
    * @see {@link https://lua-api.factorio.com/latest/LuaModSettingPrototype.html#LuaModSettingPrototype.name Online documentation}
@@ -19531,6 +19566,11 @@ interface LuaPlayer extends LuaControl {
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.render_mode Online documentation}
    */
   readonly render_mode: defines.render_mode
+  /**
+   * The input method of the player, mouse and keyboard or game controller
+   * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.input_method Online documentation}
+   */
+  readonly input_method: defines.input_method
   /**
    * If `true`, zoom-to-world noise effect will be disabled and environmental sounds will be based on zoom-to-world view instead of position of player's character.
    * @see {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.spectator Online documentation}
@@ -22904,7 +22944,7 @@ interface LuaSurface {
     readonly force?: ForceIdentification
   }): boolean
   /**
-   * Find a specific entity at a specific position.
+   * Find an entity of the given type at the given position. This checks both the exact position and the bounding box of the entity.
    * @param entity Entity to look for.
    * @param position Coordinates to look at.
    * @returns `nil` if no such entity is found.
@@ -23425,6 +23465,16 @@ interface LuaSurface {
     position: MapPosition | MapPositionArray,
     force: ForceIdentification
   ): LuaLogisticNetwork | nil
+  /**
+   * Find the logistic network with a cell closest to a given position.
+   * @param force Force the logistic network should belong to.
+   * @returns The found network or `nil` if no such network was found.
+   * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_closest_logistic_network_by_position Online documentation}
+   */
+  find_closest_logistic_network_by_position(
+    position: MapPosition | MapPositionArray,
+    force: ForceIdentification
+  ): LuaLogisticNetwork | nil
   /**
    * Finds all of the logistics networks whose construction area intersects with the given position.
    * @param force Force the logistic networks should belong to.
@@ -23568,11 +23618,18 @@ interface LuaSurface {
    * Gets all tiles of the given types that are connected horizontally or vertically to the given tile position including the given tile position.
    * @param position The tile position to start at.
    * @param tiles The tiles to search for.
+   * @param include_diagonal Include tiles that are connected diagonally.
+   * @param area The area to find connected tiles in. If provided the start position must be in this area.
    * @returns The resulting set of tiles.
    * @remarks This won't find tiles in non-generated chunks.
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_connected_tiles Online documentation}
    */
-  get_connected_tiles(position: TilePosition | TilePositionArray, tiles: readonly string[]): TilePosition[]
+  get_connected_tiles(
+    position: TilePosition | TilePositionArray,
+    tiles: readonly string[],
+    include_diagonal?: boolean,
+    area?: BoundingBoxWrite | BoundingBoxArray
+  ): TilePosition[]
   /**
    * **Raised events:**
    * - {@link OnPreChunkDeletedEvent on_pre_chunk_deleted} _future_tick_

package/runtime/generated/concepts.d.ts

@@ -800,26 +800,26 @@ interface EnemyExpansionMapSettings {
    */
   readonly settler_group_max_size: uint
   /**
-   * The minimum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `4*3,600=14,400` ticks.
+   * The minimum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `4*3'600=14'400` ticks.
    */
   readonly min_expansion_cooldown: uint
   /**
-   * The maximum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `60*3,600=216,000` ticks.
+   * The maximum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `60*3'600=216'000` ticks.
    */
   readonly max_expansion_cooldown: uint
 }
 
 interface UnitGroupMapSettings {
   /**
-   * The minimum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `3,600` ticks.
+   * The minimum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `3'600` ticks.
    */
   readonly min_group_gathering_time: uint
   /**
-   * The maximum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `10*3,600=36,000` ticks.
+   * The maximum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `10*3'600=36'000` ticks.
    */
   readonly max_group_gathering_time: uint
   /**
-   * After gathering has finished, the group is allowed to wait this long in ticks for delayed members. New members are not accepted anymore however. Defaults to `2*3,600=7,200` ticks.
+   * After gathering has finished, the group is allowed to wait this long in ticks for delayed members. New members are not accepted anymore however. Defaults to `2*3'600=7'200` ticks.
    */
   readonly max_wait_time_for_late_members: uint
   /**
@@ -889,11 +889,11 @@ interface PathFinderMapSettings {
    */
   readonly goal_pressure_ratio: double
   /**
-   * The maximum number of nodes that are expanded per tick. Defaults to `1,000`.
+   * The maximum number of nodes that are expanded per tick. Defaults to `1'000`.
    */
   readonly max_steps_worked_per_tick: double
   /**
-   * The maximum amount of work each pathfinding job is allowed to do per tick. Defaults to `8,000`.
+   * The maximum amount of work each pathfinding job is allowed to do per tick. Defaults to `8'000`.
    */
   readonly max_work_done_per_tick: uint
   /**

package/runtime/generated/defines.d.ts

@@ -1341,6 +1341,10 @@ declare namespace defines {
      * Event type: {@link OnGuiLeaveEvent}
      */
     const on_gui_leave: EventId<OnGuiLeaveEvent>
+    /**
+     * Event type: {@link OnEntityColorChangedEvent}
+     */
+    const on_entity_color_changed: EventId<OnEntityColorChangedEvent>
     /**
      * Event type: {@link OnCutsceneStartedEvent}
      */
@@ -1349,6 +1353,10 @@ declare namespace defines {
      * Event type: {@link OnCutsceneFinishedEvent}
      */
     const on_cutscene_finished: EventId<OnCutsceneFinishedEvent>
+    /**
+     * Event type: {@link OnPlayerInputMethodChangedEvent}
+     */
+    const on_player_input_method_changed: EventId<OnPlayerInputMethodChangedEvent>
   }
   /**
    * 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.
@@ -1365,6 +1373,23 @@ declare namespace defines {
     two_hundred_fifty_hours,
     one_thousand_hours,
   }
+  enum game_controller_interaction {
+    /**
+     * Game controller will always hover this element regardless of type or state.
+     * @see {@link https://lua-api.factorio.com/latest/defines.html#defines.game_controller_interaction.always Online documentation}
+     */
+    always,
+    /**
+     * Hover according to the element type and implementation.
+     * @see {@link https://lua-api.factorio.com/latest/defines.html#defines.game_controller_interaction.never Online documentation}
+     */
+    never,
+    /**
+     * Never hover this element with a game controller.
+     * @see {@link https://lua-api.factorio.com/latest/defines.html#defines.game_controller_interaction.normal Online documentation}
+     */
+    normal,
+  }
   enum group_state {
     gathering,
     moving,

package/runtime/generated/events.d.ts

@@ -19,6 +19,10 @@ interface CustomInputEvent extends EventData {
    * The mouse cursor position when the custom input was activated.
    */
   readonly cursor_position: MapPosition
+  /**
+   * The mouse cursor display location when the custom input was activated.
+   */
+  readonly cursor_display_location: GuiLocation
   /**
    * Information about the prototype that is selected when the custom input is used. Needs to be enabled on the custom input's prototype. `nil` if none is selected.
    */
@@ -548,6 +552,25 @@ interface OnEntityClonedEvent extends EventData {
   readonly tick: uint
 }
 
+/**
+ * Called after an entity has been recolored either by the player or through script.
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_color_changed Online documentation}
+ */
+interface OnEntityColorChangedEvent extends EventData {
+  /**
+   * The entity that was recolored.
+   */
+  readonly entity: LuaEntity
+  /**
+   * Identifier of the event
+   */
+  readonly name: typeof defines.events.on_entity_color_changed
+  /**
+   * Tick the event was generated.
+   */
+  readonly tick: uint
+}
+
 /**
  * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter}.
  * @remarks This is not called when an entities health is set directly by another mod.
@@ -983,6 +1006,10 @@ interface OnGuiClickEvent extends EventData {
    * The mouse button used if any.
    */
   readonly button: defines.mouse_button_type
+  /**
+   * The display location of the player's cursor.
+   */
+  readonly cursor_display_location: GuiLocation
   /**
    * If alt was pressed.
    */
@@ -2301,6 +2328,26 @@ interface OnPlayerGunInventoryChangedEvent extends EventData {
   readonly tick: uint
 }
 
+/**
+ * Called when a player's input method changes.
+ * @remarks See {@link LuaPlayer#input_method LuaPlayer::input_method}.
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_input_method_changed Online documentation}
+ */
+interface OnPlayerInputMethodChangedEvent extends EventData {
+  /**
+   * The player whose input method changed.
+   */
+  readonly player_index: PlayerIndex
+  /**
+   * Identifier of the event
+   */
+  readonly name: typeof defines.events.on_player_input_method_changed
+  /**
+   * Tick the event was generated.
+   */
+  readonly tick: uint
+}
+
 /**
  * Called after a player joins the game. This is not called when loading a save file in singleplayer, as the player doesn't actually leave the game, and the save is just on pause until they rejoin.
  * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_joined_game Online documentation}