typed-factorio 2.9.0 → 2.11.0

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

@@ -7,12 +7,12 @@ import type { LocalisedString, table, uint } from "factorio:runtime"
 declare global {
   /**
    * `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/1.1.105/auxiliary/libraries.html#new-functions Online documentation}
+   * @see {@link https://lua-api.factorio.com/1.1.108/auxiliary/libraries.html#new-functions Online documentation}
    */
   function log(string: LocalisedString): void
   /**
    * `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/1.1.105/auxiliary/libraries.html#new-functions Online documentation}
+   * @see {@link https://lua-api.factorio.com/1.1.108/auxiliary/libraries.html#new-functions Online documentation}
    */
   function localised_print(string: LocalisedString): void
   /**
@@ -20,16 +20,16 @@ declare global {
    *
    * ```
    * local function size(t)
-   *     local count = 0
-   *     for k,v in pairs(t) do
-   *         count = count + 1
-   *     end
-   *     return count
+   *   local count = 0
+   *   for k,v in pairs(t) do
+   *     count = count + 1
+   *   end
+   *   return count
    * end
    * ```
    *
    * 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/1.1.105/auxiliary/libraries.html#new-functions Online documentation}
+   * @see {@link https://lua-api.factorio.com/1.1.108/auxiliary/libraries.html#new-functions Online documentation}
    */
   function table_size(table: table): uint
 }

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

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

package/settings/types.d.ts

@@ -2,8 +2,8 @@
 
 /** @noResolution */
 declare module "factorio:settings" {
-  import { LocalisedString } from "factorio:prototype"
-  export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting"
+  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
@@ -12,9 +12,8 @@ declare module "factorio:settings" {
      * all mods. Because of that it is recommended to prefix mod settings with your mod name,
      */
     name: string
-    localized_name?: LocalisedString
-    localized_description?: LocalisedString
-
+    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
      *
@@ -41,7 +40,6 @@ declare module "factorio:settings" {
      *
      * 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 */
@@ -101,12 +99,19 @@ declare module "factorio:settings" {
      */
     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

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

@@ -1,66 +0,0 @@
-// This is an auto-generated file. Do not edit directly!
-
-/** @noSelfInFile */
-
-/**
- * @noResolution
- */
-declare module "factorio:runtime" {
-  /**
-   * A floating-point number. This is a single-precision floating point number. Whilst Lua only uses double-precision numbers, when a function takes a float, the game engine will immediately convert the double-precision number to single-precision.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#float Online documentation}
-   */
-  export type float = number
-  /**
-   * A double-precision floating-point number. This is the same data type as all Lua numbers use.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#double Online documentation}
-   */
-  export type double = number
-  /**
-   * 32-bit signed integer. Possible values are -2 147 483 648 to 2 147 483 647.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#int Online documentation}
-   */
-  export type int = number
-  /**
-   * 8-bit signed integer. Possible values are -128 to 127.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#int8 Online documentation}
-   */
-  export type int8 = number
-  /**
-   * 32-bit unsigned integer. Possible values are 0 to 4 294 967 295.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#uint Online documentation}
-   */
-  export type uint = number
-  /**
-   * 8-bit unsigned integer. Possible values are 0 to 255.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#uint8 Online documentation}
-   */
-  export type uint8 = number
-  /**
-   * 16-bit unsigned integer. Possible values are 0 to 65 535.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#uint16 Online documentation}
-   */
-  export type uint16 = number
-  /**
-   * 64-bit unsigned integer. Possible values are 0 to 18 446 744 073 709 551 615.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#uint64 Online documentation}
-   */
-  export type uint64 = number
-  /**
-   * Nil is the type of the value `nil`, whose main property is to be different from any other value. It usually represents the absence of a useful value.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#nil Online documentation}
-   */
-  export type nil = undefined
-  /**
-   * Tables are enclosed in curly brackets, like this `{}`.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#table Online documentation}
-   */
-  export type table = object
-  /**
-   * Any LuaObject listed on the {@linkplain https://lua-api.factorio.com/1.1.105/classes.html Classes} page.
-   * @see {@link https://lua-api.factorio.com/1.1.105/builtin-types.html#LuaObject Online documentation}
-   */
-  export interface LuaObject {
-    readonly object_name: string
-  }
-}