typed-factorio 3.10.0 → 3.12.0

package/runtime/generated/global-functions.d.ts

@@ -7,12 +7,12 @@ import type { LocalisedString, table, uint } from "factorio:runtime"
 declare global {
   /**
    * `localised_print()` allows printing {@link LocalisedString} to stdout without polluting the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This is primarily useful when communicating with external tools that launch Factorio as a child process.
-   * @see {@link https://lua-api.factorio.com/2.0.28/auxiliary/libraries.html#new-functions Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/auxiliary/libraries.html#new-functions Online documentation}
    */
   function localised_print(string: LocalisedString): void
   /**
    * `log()` can print {@link LocalisedString LocalisedStrings} to the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This, in combination with the serpent library, makes debugging in the data stage easier because it allows the inspection of entire prototype tables. For example, printing all properties of the sulfur item prototype can be done like so: `log(serpent.block(data.raw["item"]["sulfur"]))`
-   * @see {@link https://lua-api.factorio.com/2.0.28/auxiliary/libraries.html#new-functions Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/auxiliary/libraries.html#new-functions Online documentation}
    */
   function log(string: LocalisedString): void
   /**
@@ -29,7 +29,7 @@ declare global {
    * ```
    *
    * Note that `table_size()` does not work correctly for {@link LuaCustomTable}, their size has to be determined with {@link LuaCustomTable#length LuaCustomTable::length_operator} instead.
-   * @see {@link https://lua-api.factorio.com/2.0.28/auxiliary/libraries.html#new-functions Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/auxiliary/libraries.html#new-functions Online documentation}
    */
   function table_size(table: table): uint
 }

package/runtime/generated/global-objects.d.ts

@@ -16,42 +16,42 @@ import type {
 declare global {
   /**
    * Allows registration of custom commands for the in-game console.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const commands: LuaCommandProcessor
   /**
    * The main scripting interface through which most of the API is accessed.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const game: LuaGameScript
   /**
    * Provides access to various helper and utility functions.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const helpers: LuaHelpers
   /**
    * Allows read-only access to prototypes.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const prototypes: LuaPrototypes
   /**
    * Allows printing messages to the calling RCON instance, if any.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const rcon: LuaRCON
   /**
    * Allows registration and use of functions to communicate between mods.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const remote: LuaRemote
   /**
    * Allows rendering of geometric shapes, text and sprites in the game world.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const rendering: LuaRendering
   /**
    * Provides an interface for registering game event handlers.
-   * @see {@link https://lua-api.factorio.com/2.0.28/index-runtime.html Online documentation}
+   * @see {@link https://lua-api.factorio.com/2.0.31/index-runtime.html Online documentation}
    */
   const script: LuaBootstrap
   //The "settings" global is declared in common/settings-global.d.ts; its runtime type is handled below.

package/runtime/index.d.ts

@@ -1,11 +1,11 @@
-// This file declares globals for the factorio runtime stage.
-
-/// <reference path="../index.d.ts" />
-/// <reference path="./generated/global-objects.d.ts" />
-/// <reference path="../common/settings-global.d.ts" />
-
-/** @noResolution */
-declare module "factorio:common" {
-  import { LuaSettings } from "factorio:runtime"
-  export interface SettingsGlobal extends LuaSettings {}
-}
+// This file declares globals for the factorio runtime stage.
+
+/// <reference path="../index.d.ts" />
+/// <reference path="./generated/global-objects.d.ts" />
+/// <reference path="../common/settings-global.d.ts" />
+
+/** @noResolution */
+declare module "factorio:common" {
+  import { LuaSettings } from "factorio:runtime"
+  export interface SettingsGlobal extends LuaSettings {}
+}

package/runtime/pairs.d.ts

@@ -1,12 +1,12 @@
-/** @noSelfInFile */
-import { LuaCustomTable } from "factorio:runtime"
-
-declare global {
-  /** **Note**: you can also iterate on a LuaCustomTable directly without using `pairs`, e.g. `for(const [k, v] of table)`. */
-  function pairs<T extends LuaCustomTable<any, any>>(
-    table: T,
-  ): LuaIterable<LuaMultiReturn<T extends Iterable<infer E> ? E : never>>
-
-  /** @deprecated {@link LuaCustomTable} cannot be iterated with `ipairs`; Use {@link pairs} instead. */
-  function ipairs(table: LuaCustomTable<any, any>): never
-}
+/** @noSelfInFile */
+import { LuaCustomTable } from "factorio:runtime"
+
+declare global {
+  /** **Note**: you can also iterate on a LuaCustomTable directly without using `pairs`, e.g. `for(const [k, v] of table)`. */
+  function pairs<T extends LuaCustomTable<any, any>>(
+    table: T,
+  ): LuaIterable<LuaMultiReturn<T extends Iterable<infer E> ? E : never>>
+
+  /** @deprecated {@link LuaCustomTable} cannot be iterated with `ipairs`; Use {@link pairs} instead. */
+  function ipairs(table: LuaCustomTable<any, any>): never
+}

package/settings/index.d.ts

@@ -1,10 +1,10 @@
-// This file declares globals for the factorio settings stage.
-
-/// <reference path="../index.d.ts" />
-/// <reference path="../common/data-global.d.ts" />
-
-/** @noResolution */
-declare module "factorio:common" {
-  import { PrototypeMap } from "factorio:settings"
-  export interface GlobalPrototypeMap extends PrototypeMap {}
-}
+// This file declares globals for the factorio settings stage.
+
+/// <reference path="../index.d.ts" />
+/// <reference path="../common/data-global.d.ts" />
+
+/** @noResolution */
+declare module "factorio:common" {
+  import { PrototypeMap } from "factorio:settings"
+  export interface GlobalPrototypeMap extends PrototypeMap {}
+}

package/settings/types.d.ts

@@ -1,118 +1,118 @@
-// Based off of https://wiki.factorio.com/Tutorial:Mod_settings
-
-/** @noResolution */
-declare module "factorio:settings" {
-  import { Color, LocalisedString } from "factorio:prototype"
-  export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting" | "color-setting"
-
-  export interface BaseSettingDefinition {
-    readonly type: SettingType
-    /**
-     * The name of the settings prototype should be unique to avoid mod conflicts since the mod settings are global across
-     * all mods. Because of that it is recommended to prefix mod settings with your mod name,
-     */
-    name: string
-    localised_name?: LocalisedString
-    localised_description?: LocalisedString
-    /**
-     * The order property can be used to change how the mod settings are ordered in the settings gui. Mod settings are sorted
-     *
-     * - First by mod
-     * - Then by the setting "order" string
-     * - Then finally by the setting name.
-     */
-    order?: string
-    /**
-     * The hidden property can be used to hide mod settings from GUIs, so that they cannot be seen or changed by players.
-     * However, other mods can still access hidden settings. {@link https://forums.factorio.com/83316}
-     */
-    hidden?: boolean
-    /**
-     * There are the overall kinds of settings:
-     *
-     * - **startup**: This kind of setting is available in the prototype stage, and can not be changed runtime. They have to
-     *   be set to the same values for all players on a server.
-     * - **runtime-global**: This kind of setting is global to an entire save game and can be changed runtime. On servers,
-     *   only admins can change these settings.
-     * - **runtime-per-user**: This kind of setting is only available runtime in the control.lua stage and each player has
-     *   their own instance of this setting. When a player joins a server their local setting of "keep mod settings per
-     *   save" determines if the local settings they have set are synced to the loaded save or if the save's settings are used.
-     *
-     * This "setting_type" also determines in which tab the setting is showed in the mod settings menu.
-     */
-    setting_type: "startup" | "runtime-global" | "runtime-per-user"
-  }
-  /** A true/false checkbox */
-  export interface BoolSettingDefinition extends BaseSettingDefinition {
-    readonly type: "bool-setting"
-    /** Defines the default value of the setting, in this case whether the checkbox is checked or not. */
-    default_value: boolean
-    /**
-     * Only loaded if `hidden = true`. This forces the setting to be of this value. This can be useful for mod
-     * compatibility. {@link https://forums.factorio.com/viewtopic.php?p=531322#p531322}
-     */
-    forced_value?: boolean
-  }
-  /** A signed 64 bit integer textfield (or selection dropdown) */
-  export interface IntSettingDefinition extends BaseSettingDefinition {
-    readonly type: "int-setting"
-    /** Defines the default value of the setting. */
-    default_value: number
-    /** Defines the lowest possible number. */
-    minimum_value?: number
-    /** Defines the highest possible number. */
-    maximum_value?: number
-    /**
-     * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
-     * textfield. If only one allowed value is given, the settings is forced to be of that value.
-     */
-    allowed_values?: number[]
-  }
-  /** A double precision floating point textfield (or selection dropdown) */
-  export interface DoubleSettingDefinition extends BaseSettingDefinition {
-    readonly type: "double-setting"
-    /** Defines the default value of the setting. */
-    default_value: number
-    /** Defines the lowest possible number. */
-    minimum_value?: number
-    /** Defines the highest possible number. */
-    maximum_value?: number
-    /**
-     * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
-     * textfield. If only one allowed value is given, the settings is forced to be of that value.
-     */
-    allowed_values?: number[]
-  }
-  /** A string textfield (or selection dropdown) */
-  export interface StringSettingDefinition extends BaseSettingDefinition {
-    readonly type: "string-setting"
-    /** Defines the default value of the setting. */
-    default_value: string
-    /** Defines whether it's possible for the user to set the textfield to empty and apply the setting. */
-    allow_blank?: boolean
-    /** Whether values that are input by the user should have whitespace removed from both ends of the string. */
-    auto_trim?: boolean
-    /**
-     * Makes it possible to force the player to choose between the defined strings, creates a dropdown instead of a
-     * textfield. The strings in the dropdown can be localized (translated) and can have a tooltip, see below. If only one
-     * allowed value is given, the settings is forced to be of that value.
-     */
-    allowed_values?: string[]
-  }
-  /** a color picker (sliders), with whole number textfields. Includes alpha. */
-  export interface ColorSettingDefinition extends BaseSettingDefinition {
-    readonly type: "color-setting"
-    /** Defines the default value of the setting. */
-    default_value: Color
-  }
-
-  export interface PrototypeMap {
-    "bool-setting": BoolSettingDefinition
-    "int-setting": IntSettingDefinition
-    "double-setting": DoubleSettingDefinition
-    "string-setting": StringSettingDefinition
-    "color-setting": ColorSettingDefinition
-  }
-
-  export type SettingsPrototypeMap = PrototypeMap
-}
+// Based off of https://wiki.factorio.com/Tutorial:Mod_settings
+
+/** @noResolution */
+declare module "factorio:settings" {
+  import { Color, LocalisedString } from "factorio:prototype"
+  export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting" | "color-setting"
+
+  export interface BaseSettingDefinition {
+    readonly type: SettingType
+    /**
+     * The name of the settings prototype should be unique to avoid mod conflicts since the mod settings are global across
+     * all mods. Because of that it is recommended to prefix mod settings with your mod name,
+     */
+    name: string
+    localised_name?: LocalisedString
+    localised_description?: LocalisedString
+    /**
+     * The order property can be used to change how the mod settings are ordered in the settings gui. Mod settings are sorted
+     *
+     * - First by mod
+     * - Then by the setting "order" string
+     * - Then finally by the setting name.
+     */
+    order?: string
+    /**
+     * The hidden property can be used to hide mod settings from GUIs, so that they cannot be seen or changed by players.
+     * However, other mods can still access hidden settings. {@link https://forums.factorio.com/83316}
+     */
+    hidden?: boolean
+    /**
+     * There are the overall kinds of settings:
+     *
+     * - **startup**: This kind of setting is available in the prototype stage, and can not be changed runtime. They have to
+     *   be set to the same values for all players on a server.
+     * - **runtime-global**: This kind of setting is global to an entire save game and can be changed runtime. On servers,
+     *   only admins can change these settings.
+     * - **runtime-per-user**: This kind of setting is only available runtime in the control.lua stage and each player has
+     *   their own instance of this setting. When a player joins a server their local setting of "keep mod settings per
+     *   save" determines if the local settings they have set are synced to the loaded save or if the save's settings are used.
+     *
+     * This "setting_type" also determines in which tab the setting is showed in the mod settings menu.
+     */
+    setting_type: "startup" | "runtime-global" | "runtime-per-user"
+  }
+  /** A true/false checkbox */
+  export interface BoolSettingDefinition extends BaseSettingDefinition {
+    readonly type: "bool-setting"
+    /** Defines the default value of the setting, in this case whether the checkbox is checked or not. */
+    default_value: boolean
+    /**
+     * Only loaded if `hidden = true`. This forces the setting to be of this value. This can be useful for mod
+     * compatibility. {@link https://forums.factorio.com/viewtopic.php?p=531322#p531322}
+     */
+    forced_value?: boolean
+  }
+  /** A signed 64 bit integer textfield (or selection dropdown) */
+  export interface IntSettingDefinition extends BaseSettingDefinition {
+    readonly type: "int-setting"
+    /** Defines the default value of the setting. */
+    default_value: number
+    /** Defines the lowest possible number. */
+    minimum_value?: number
+    /** Defines the highest possible number. */
+    maximum_value?: number
+    /**
+     * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
+     * textfield. If only one allowed value is given, the settings is forced to be of that value.
+     */
+    allowed_values?: number[]
+  }
+  /** A double precision floating point textfield (or selection dropdown) */
+  export interface DoubleSettingDefinition extends BaseSettingDefinition {
+    readonly type: "double-setting"
+    /** Defines the default value of the setting. */
+    default_value: number
+    /** Defines the lowest possible number. */
+    minimum_value?: number
+    /** Defines the highest possible number. */
+    maximum_value?: number
+    /**
+     * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
+     * textfield. If only one allowed value is given, the settings is forced to be of that value.
+     */
+    allowed_values?: number[]
+  }
+  /** A string textfield (or selection dropdown) */
+  export interface StringSettingDefinition extends BaseSettingDefinition {
+    readonly type: "string-setting"
+    /** Defines the default value of the setting. */
+    default_value: string
+    /** Defines whether it's possible for the user to set the textfield to empty and apply the setting. */
+    allow_blank?: boolean
+    /** Whether values that are input by the user should have whitespace removed from both ends of the string. */
+    auto_trim?: boolean
+    /**
+     * Makes it possible to force the player to choose between the defined strings, creates a dropdown instead of a
+     * textfield. The strings in the dropdown can be localized (translated) and can have a tooltip, see below. If only one
+     * allowed value is given, the settings is forced to be of that value.
+     */
+    allowed_values?: string[]
+  }
+  /** a color picker (sliders), with whole number textfields. Includes alpha. */
+  export interface ColorSettingDefinition extends BaseSettingDefinition {
+    readonly type: "color-setting"
+    /** Defines the default value of the setting. */
+    default_value: Color
+  }
+
+  export interface PrototypeMap {
+    "bool-setting": BoolSettingDefinition
+    "int-setting": IntSettingDefinition
+    "double-setting": DoubleSettingDefinition
+    "string-setting": StringSettingDefinition
+    "color-setting": ColorSettingDefinition
+  }
+
+  export type SettingsPrototypeMap = PrototypeMap
+}