typed-factorio 0.7.0 → 0.7.4

package/generated/classes.d.ts

@@ -336,7 +336,7 @@ interface LuaBootstrap {
     f: ((data: E["_eventData"]) => void) | undefined,
     filters?: E["_filter"][]
   ): void
-  on_event<E extends EventId<any, any>>(event: E | E[], f: ((data: E["_eventData"]) => void) | undefined): void
+  on_event<E extends EventId<any>>(event: E | E[], f: ((data: E["_eventData"]) => void) | undefined): void
   on_event(event: string, f: ((data: CustomInputEvent) => void) | undefined): void
   /**
    * Register a handler to run every nth-tick(s). When the game is on tick 0 it will trigger all registered handlers.
@@ -1388,9 +1388,15 @@ interface LuaControl {
    */
   selected: LuaEntity | undefined
   /**
-   * The GUI target the player currently has open; `nil` if none.
+   * The GUI the player currently has open, or `nil` if no GUI is open. Writing to it fires the
+   * {@link OnGuiOpenedEvent on_gui_opened} event.
    *
-   * **Note**: Write supports any of the types. Read will return the entity, equipment, equipment-grid, player, element or nil.
+   * This is the GUI that will asked to close (by firing the {@link OnGuiClosedEvent on_gui_closed} event) when the
+   * `Esc` or `E` keys are pressed. If this attribute is not `nil`, and a new GUI is written to it, the existing one
+   * will be asked to close.
+   *
+   * **Note**: Write supports any of the types. Read will return the `entity`, `equipment`, `equipment-grid`,
+   * `player`, `element` or `nil`.
    *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.opened View documentation}
    */
@@ -2608,7 +2614,7 @@ interface LuaEntity extends LuaControl {
   /**
    * Get the rails that this signal is connected to.
    *
-   * *Can only be used if this is RailSignal*
+   * *Can only be used if this is RailSignal or RailChainSignal*
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.get_connected_rails View documentation}
    */
@@ -2868,7 +2874,7 @@ interface LuaEntity extends LuaControl {
   /**
    * Sets the current recipe in this assembly machine.
    *
-   * *Can only be used if this is CraftingMachine*
+   * *Can only be used if this is AssemblingMachine*
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.set_recipe View documentation}
    *
@@ -3285,7 +3291,7 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.name View documentation}
    */
-  readonly name: "inserter" | "filter-inserter"
+  readonly name: string
   /**
    * Name of the entity or tile contained in this ghost
    *
@@ -3695,7 +3701,7 @@ interface LuaEntity extends LuaControl {
   /**
    * The state of this rail signal.
    *
-   * *Can only be used if this is RailSignal*
+   * *Can only be used if this is RailSignal or RailChainSignal*
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.signal_state View documentation}
    */
@@ -7890,53 +7896,59 @@ interface LuaGameScript {
    */
   regenerate_entity(entities: string | string[]): void
   /**
-   * Take a screenshot and save it to a file.
+   * Take a screenshot and save it to a file. The filename should include a file extension indicating the desired
+   * image format. Supports `.png`, `.jpg` / `.jpeg`, `.tga` and `.bmp`.
    *
    * **Note**: If Factorio is running headless, this function will do nothing.
    *
    * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.take_screenshot View documentation}
    */
   take_screenshot(params: {
+    /** The player to focus on. Defaults to the local player. */
     readonly player?: PlayerIdentification
     /** If defined, the screenshot will only be taken for this player. */
     readonly by_player?: PlayerIdentification
     /** If defined, the screenshot will be taken on this surface. */
     readonly surface?: SurfaceIdentification
-    /** If defined, the screenshot will be centered on this position. */
+    /** If defined, the screenshot will be centered on this position. Otherwise, the screenshot will center on `player`. */
     readonly position?: Position
     /**
-     * Maximum allowed resolution is 16384x16384 (resp. 8192x8192 when anti_alias is true), but maximum recommended
-     * resolution is 4096x4096 (resp. 2048x2048).
+     * The maximum allowed resolution is 16384x16384 (8192x8192 when `anti_alias` is `true`), but the maximum
+     * recommended resolution is 4096x4096 (resp. 2048x2048).
      */
     readonly resolution?: Position
+    /** The map zoom to take the screenshot at. Defaults to `1`. */
     readonly zoom?: double
-    /** Path to save the screenshot in */
+    /** The sub-path in `"script-output"` to save the screenshot to. Defaults to `"screenshot.png"`. */
     readonly path?: string
-    /** Include game GUI in the screenshot? */
+    /** Whether to include GUIs in the screenshot or not. Defaults to `false`. */
     readonly show_gui?: boolean
-    /** Include entity info (alt-mode)? */
+    /** Whether to include entity info ("Alt mode") or not. Defaults to `false`. */
     readonly show_entity_info?: boolean
-    /** When true, and player is specified, building preview for item in player's cursor will be rendered also. */
+    /**
+     * When `true` and when `player` is specified, the building preview for the item in the player's cursor will
+     * also be rendered. Defaults to `false`.
+     */
     readonly show_cursor_building_preview?: boolean
-    /** Render in double resolution and scale down (including GUI)? */
+    /** Whether to render in double resolution and downscale the result (including GUI). Defaults to `false`. */
     readonly anti_alias?: boolean
-    /** The render quality if using jpg format (0-100 inclusive). */
-    readonly quality?: int
     /**
-     * If true, the screenshot will be saved even during replay playback, otherwise this function call does nothing
-     * in replays.
+     * The `.jpg` render quality as a percentage (from 0% to 100% inclusive), if used. A lower value means a more
+     * compressed image. Defaults to `80`.
      */
+    readonly quality?: int
+    /** Whether to save the screenshot even during replay playback. Defaults to `false`. */
     readonly allow_in_replay?: boolean
-    /** Overrides current surface daytime for duration of screenshot rendering. */
+    /** Overrides the current surface daytime for the duration of screenshot rendering. */
     readonly daytime?: double
-    /** Overrides tick of water animation (if animated water is enabled). */
+    /** Overrides the tick of water animation, if animated water is enabled. */
     readonly water_tick?: uint
     /**
-     * Screenshot requests are processed in between update and render. The game may skip rendering (drop frames) if
-     * previous frame has not finished rendering or the game simulation starts to fall under 60 updates per second.
-     * If force_render is set to true, the game won't drop frames and process the screenshot request at the end of
-     * the update in which the request was created. This is not honored on multiplayer clients that are catching up
-     * to server.
+     * Screenshot requests are processed in between game update and render. The game may skip rendering (ie. drop
+     * frames) if the previous frame has not finished rendering or the game simulation starts to fall below 60
+     * updates per second. If `force_render` is set to `true`, the game won't drop frames and process the screenshot
+     * request at the end of the update in which the request was created. This is not honored on multiplayer clients
+     * that are catching up to server. Defaults to `false`.
      */
     readonly force_render?: boolean
   }): void
@@ -7946,12 +7958,18 @@ interface LuaGameScript {
    * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.set_wait_for_screenshots_to_finish View documentation}
    */
   set_wait_for_screenshots_to_finish(): void
+  /**
+   * Take a screenshot of the technology screen and save it to a file. The filename should include a file extension
+   * indicating the desired image format. Supports `.png`, `.jpg` / `.jpeg`, `.tga` and `.bmp`.
+   *
+   * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.take_technology_screenshot View documentation}
+   */
   take_technology_screenshot(params: {
-    /** The force to use. If not given the `"player`" force is used. */
+    /** The force whose technology to screenshot. If not given, the `"player`" force is used. */
     readonly force?: ForceIdentification
-    /** Path to save the screenshot in. */
+    /** The sub-path in `"script-output"` to save the screenshot to. Defaults to `"technology-screenshot.png"`. */
     readonly path?: string
-    /** If defined, the screenshot will only be taken for this player. */
+    /** If given, the screenshot will only be taken for this player. */
     readonly by_player?: PlayerIdentification
     /** The technology to highlight. */
     readonly selected_technology?: TechnologyIdentification
@@ -7960,7 +7978,10 @@ interface LuaGameScript {
      * technology's parents. Defaults to `false`.
      */
     readonly skip_disabled?: boolean
-    /** The render quality if using jpg format (0-100 inclusive). */
+    /**
+     * The `.jpg` render quality as a percentage (from 0% to 100% inclusive), if used. A lower value means a more
+     * compressed image. Defaults to `80`.
+     */
     readonly quality?: int
   }): void
   /**
@@ -9838,7 +9859,7 @@ interface BaseGuiElement {
    */
   show_percent_for_small_numbers: boolean
   /**
-   * The location of this widget when stored in {@link LuaGui.screen LuaGui::screen} or `nil` if not not set or not in
+   * The location of this widget when stored in {@link LuaGui.screen LuaGui::screen}, or `nil` if not set or not in
    * {@link LuaGui.screen LuaGui::screen}.
    *
    * {@link https://lua-api.factorio.com/next/LuaGuiElement.html#LuaGuiElement.location View documentation}
@@ -11311,7 +11332,7 @@ interface LuaItemPrototype {
    *
    * {@link https://lua-api.factorio.com/next/LuaItemPrototype.html#LuaItemPrototype.type View documentation}
    */
-  readonly type: "gun" | "mining-tool"
+  readonly type: string
   /**
    * Name of this prototype.
    *
@@ -14424,7 +14445,7 @@ interface LuaPlayer extends LuaControl {
    * Gets the current per-player settings for the this player, indexed by prototype name. Returns the same structure
    * as {@link LuaSettings.get_player_settings LuaSettings::get_player_settings}.
    *
-   * **Note**: This can become invalid if during operation this player becomes invalid.
+   * **Note**: This table will become invalid if its associated player does.
    *
    * {@link https://lua-api.factorio.com/next/LuaPlayer.html#LuaPlayer.mod_settings View documentation}
    */
@@ -16705,7 +16726,7 @@ interface LuaSettings {
    * Gets the current per-player settings for the given player, indexed by prototype name. Returns the same structure
    * as {@link LuaPlayer.mod_settings LuaPlayer::mod_settings}.
    *
-   * **Note**: This can become invalid if during operation if the given player becomes invalid.
+   * **Note**: This table will become invalid if its associated player does.
    *
    * {@link https://lua-api.factorio.com/next/LuaSettings.html#LuaSettings.get_player_settings View documentation}
    *
@@ -17542,15 +17563,15 @@ interface LuaSurface {
    */
   find_entities(area?: BoundingBox): LuaEntity[]
   /**
-   * Find entities of given type or name in a given area.
+   * Find all entities of the given type or name in the given area.
    *
-   * If no filters (`name`, `type`, `force`, etc.) are given, returns all entities in the search area. If multiple
-   * filters are specified, returns only entities matching all given filters.
+   * If no filters (`name`, `type`, `force`, etc.) are given, this returns all entities in the search area. If
+   * multiple filters are specified, only entities matching all given filters are returned.
    *
-   * If no area or position are given, then the entire surface is searched. If position is given, returns entities
-   * colliding with that position (i.e the given position is within the entity's collision box). If position and
-   * radius are given, returns entities in that radius of the position. If area is specified, returns entities
-   * colliding with that area.
+   * If no `area` or `position` are given, the entire surface is searched. If `position` is given, this returns the
+   * entities colliding with that position (i.e the given position is within the entity's collision box). If
+   * `position` and `radius` are given, this returns the entities within the radius of the position. If `area` is
+   * specified, this returns the entities colliding with that area.
    *
    * {@link https://lua-api.factorio.com/next/LuaSurface.html#LuaSurface.find_entities_filtered View documentation}
    *
@@ -17587,11 +17608,11 @@ interface LuaSurface {
     readonly invert?: boolean
   }): LuaEntity[]
   /**
-   * Find tiles of a given name in a given area.
+   * Find all tiles of the given name in the given area.
    *
-   * If no filters are given returns all tiles in the search area.
+   * If no filters are given, this returns all tiles in the search area.
    *
-   * If no area or position and radius is given, then the entire surface is searched. If position and radius are
+   * If no `area` or `position` and `radius` is given, the entire surface is searched. If `position` and `radius` are
    * given, only tiles within the radius of the position are included.
    *
    * {@link https://lua-api.factorio.com/next/LuaSurface.html#LuaSurface.find_tiles_filtered View documentation}
@@ -17613,10 +17634,10 @@ interface LuaSurface {
    * As it doesn't construct all the wrapper objects, this is more efficient if one is only interested in the number
    * of entities.
    *
-   * If no area or position are given, then the entire surface is searched. If position is given, returns entities
-   * colliding with that position (i.e the given position is within the entity's collision box). If position and
-   * radius are given, returns entities in that radius of the position. If area is specified, returns entities
-   * colliding with that area.
+   * If no `area` or `position` are given, the entire surface is searched. If `position` is given, this returns the
+   * entities colliding with that position (i.e the given position is within the entity's collision box). If
+   * `position` and `radius` are given, this returns entities in the radius of the position. If `area` is specified,
+   * this returns entities colliding with that area.
    *
    * {@link https://lua-api.factorio.com/next/LuaSurface.html#LuaSurface.count_entities_filtered View documentation}
    */
@@ -17646,7 +17667,7 @@ interface LuaSurface {
    * {@link LuaSurface.find_tiles_filtered LuaSurface::find_tiles_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 tiles.
    *
-   * If no area or position and radius is given, then the entire surface is searched. If position and radius are
+   * If no `area` or `position` and `radius` is given, the entire surface is searched. If `position` and `radius` are
    * given, only tiles within the radius of the position are included.
    *
    * {@link https://lua-api.factorio.com/next/LuaSurface.html#LuaSurface.count_tiles_filtered View documentation}

package/generated/defines.d.ts

@@ -1081,6 +1081,13 @@ declare namespace defines {
     /** Event type: {@link OnEquipmentRemovedEvent} */
     const on_equipment_removed: EventId<OnEquipmentRemovedEvent>
   }
+  /**
+   * See the {@link https://lua-api.factorio.com/next/events.html events page} for more info on what events contain and
+   * when they get raised.
+   *
+   * {@link https://lua-api.factorio.com/next/defines.html#defines.events View documentation}
+   */
+  type events = typeof events[keyof typeof events]
   enum flow_precision_index {
     five_seconds,
     one_minute,

package/generated/events.d.ts

@@ -2962,7 +2962,7 @@ interface ScriptRaisedSetTilesEvent {
 }
 
 /** An event id. */
-type EventId<T extends table, F extends table | void = void> = uint & {
+type EventId<T extends table, F = unknown> = uint & {
   readonly _eventData: T
   readonly _filter: F
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.7.0",
+  "version": "0.7.4",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -25,7 +25,6 @@
   },
   "dependencies": {
     "lua-types": "^2.10.1",
-    "typescript": "~4.3.5",
     "typescript-to-lua": "^1.0.0"
   },
   "devDependencies": {
@@ -34,6 +33,7 @@
     "jest": "^27.0.6",
     "prettier": "^2.3.2",
     "ts-jest": "^27.0.4",
-    "ts-node": "^10.1.0"
+    "ts-node": "^10.1.0",
+    "typescript": "~4.3.5"
   }
 }