typed-factorio 0.13.2 → 0.14.0

package/runtime/util.d.ts

@@ -1,120 +1,120 @@
-// "util" is declared only as a module, even though it also modifies global variables
-// This is both because of limitations in `declare module`, and that modules are much friendlier to tooling.
-
-/** @noSelfInFile */
-
-/** @noResolution */
-declare module "util" {
-  namespace table {
-    function deepcopy<T>(table: T): T
-
-    function compare<T>(tb1: T, tb2: T): boolean
-  }
-
-  function copy<T>(table: T): T
-
-  function distance(position1: Position, position2: Position): number
-
-  function positiontostr(position: Position): string
-
-  function formattime(ticks: number): string
-
-  /** Supports 'rrggbb', 'rgb', 'rrggbbaa', 'rgba', 'ww', 'w' */
-  function color(hex: string): ColorTable
-
-  function premul_color(color: Color): ColorTable
-
-  function mix_color(c1: Color, c2: Color): ColorArray
-
-  function multiply_color(c1: Color, n: number): ColorArray
-
-  function moveposition(
-    position: Position,
-    direction: defines.direction.north | defines.direction.east | defines.direction.south | defines.direction.west,
-    distance: number
-  ): Position
-  function moveposition(
-    position: Position,
-    direction: defines.direction, //todo: cardinal only
-    distance: number
-  ): Position | undefined
-
-  function oppositedirection(direction: defines.direction): defines.direction
-
-  /** Creates a new array where each element in `stripes` is duplicated `count` times */
-  function multiplystripes<T>(count: number, stripes: T[]): T[]
-
-  /** Gets tile position by pixel */
-  function by_pixel(x: number, y: number): Position
-
-  /** Gets tile position by pixel, hr */
-  function by_pixel_hr(x: number, y: number): Position
-
-  // omitted: foreach_sprite_definition
-
-  function add_shift(a: PositionArray | undefined, b: PositionArray): PositionArray
-  function add_shift(a: PositionArray, b: PositionArray | undefined): PositionArray
-  function add_shift(a: PositionArray | undefined, b: PositionArray | undefined): PositionArray | undefined
-
-  // omitted: add_shift_offset
-
-  function mul_shift(shift: PositionArray, scale: number | undefined): PositionArray
-  function mul_shift(shift: PositionArray | undefined, scale: number | undefined): PositionArray | undefined
-
-  function format_number(amount: number, append_suffix?: boolean): string
-
-  function increment(t: number[], index: number, v?: number): void
-
-  // omitted: conditional_return
-
-  /**
-   * Recursively merges and/or deep-copies tables. Entries in later tables override entries in earlier ones, unless both
-   * entries are themselves tables, in which case they are recursively merged. Non-merged tables are deep-copied, so
-   * that the result is brand new.
-   */
-  function merge<T extends object>(tables: T[]): T
-
-  function insert_safe(entity: LuaEntity | undefined, item_dict: Record<string, number> | undefined): void
-
-  function remove_safe(entity: LuaEntity | undefined, item_dict: Record<string, number> | undefined): void
-
-  function split_whitespace(string: string): string[]
-
-  // omitted: split, string_starts_with. already TS functions for that
-
-  // omitted: online_players. use game.connected_players
-
-  function clamp(x: number, lower: number, upper: number): number
-
-  // omitted: get_walkable_tile
-
-  // omitted: combine_icons
-  // omitted: technology_icons. Create an issue if you really want to see these
-
-  function parse_energy(energy: string): number
-
-  function product_amount(
-    product: {
-      probability: number
-    } & (
-      | {
-          amount: number
-        }
-      | {
-          amount_min: number
-          amount_max: number
-        }
-    )
-  ): number
-
-  function empty_sprite(): object
-
-  // omitted: draw_as_glow
-  // omitted: remove_tile_references
-
-  function remove_from_list<T>(list: T[], value: T): boolean
-
-  function list_to_map<T extends keyof any>(list: T[]): Record<T, true>
-  function list_to_map<T>(list: T[]): LuaTable<T, true>
-  function list_to_map<T>(list: T): LuaTable<T[keyof T], true>
-}
+// "util" is declared only as a module, even though it also modifies global variables
+// This is both because of limitations in `declare module`, and that modules are much friendlier to tooling.
+
+/** @noSelfInFile */
+
+/** @noResolution */
+declare module "util" {
+  namespace table {
+    function deepcopy<T>(table: T): T
+
+    function compare<T>(tb1: T, tb2: T): boolean
+  }
+
+  function copy<T>(table: T): T
+
+  function distance(position1: Position, position2: Position): number
+
+  function positiontostr(position: Position): string
+
+  function formattime(ticks: number): string
+
+  /** Supports 'rrggbb', 'rgb', 'rrggbbaa', 'rgba', 'ww', 'w' */
+  function color(hex: string): ColorTable
+
+  function premul_color(color: Color): ColorTable
+
+  function mix_color(c1: Color, c2: Color): ColorArray
+
+  function multiply_color(c1: Color, n: number): ColorArray
+
+  function moveposition(
+    position: Position,
+    direction: defines.direction.north | defines.direction.east | defines.direction.south | defines.direction.west,
+    distance: number
+  ): Position
+  function moveposition(
+    position: Position,
+    direction: defines.direction, //todo: cardinal only
+    distance: number
+  ): Position | undefined
+
+  function oppositedirection(direction: defines.direction): defines.direction
+
+  /** Creates a new array where each element in `stripes` is duplicated `count` times */
+  function multiplystripes<T>(count: number, stripes: T[]): T[]
+
+  /** Gets tile position by pixel */
+  function by_pixel(x: number, y: number): Position
+
+  /** Gets tile position by pixel, hr */
+  function by_pixel_hr(x: number, y: number): Position
+
+  // omitted: foreach_sprite_definition
+
+  function add_shift(a: PositionArray | undefined, b: PositionArray): PositionArray
+  function add_shift(a: PositionArray, b: PositionArray | undefined): PositionArray
+  function add_shift(a: PositionArray | undefined, b: PositionArray | undefined): PositionArray | undefined
+
+  // omitted: add_shift_offset
+
+  function mul_shift(shift: PositionArray, scale: number | undefined): PositionArray
+  function mul_shift(shift: PositionArray | undefined, scale: number | undefined): PositionArray | undefined
+
+  function format_number(amount: number, append_suffix?: boolean): string
+
+  function increment(t: number[], index: number, v?: number): void
+
+  // omitted: conditional_return
+
+  /**
+   * Recursively merges and/or deep-copies tables. Entries in later tables override entries in earlier ones, unless both
+   * entries are themselves tables, in which case they are recursively merged. Non-merged tables are deep-copied, so
+   * that the result is brand new.
+   */
+  function merge<T extends object>(tables: T[]): T
+
+  function insert_safe(entity: LuaEntity | undefined, item_dict: Record<string, number> | undefined): void
+
+  function remove_safe(entity: LuaEntity | undefined, item_dict: Record<string, number> | undefined): void
+
+  function split_whitespace(string: string): string[]
+
+  // omitted: split, string_starts_with. already TS functions for that
+
+  // omitted: online_players. use game.connected_players
+
+  function clamp(x: number, lower: number, upper: number): number
+
+  // omitted: get_walkable_tile
+
+  // omitted: combine_icons
+  // omitted: technology_icons. Create an issue if you really want to see these
+
+  function parse_energy(energy: string): number
+
+  function product_amount(
+    product: {
+      probability: number
+    } & (
+      | {
+          amount: number
+        }
+      | {
+          amount_min: number
+          amount_max: number
+        }
+    )
+  ): number
+
+  function empty_sprite(): object
+
+  // omitted: draw_as_glow
+  // omitted: remove_tile_references
+
+  function remove_from_list<T>(list: T[], value: T): boolean
+
+  function list_to_map<T extends keyof any>(list: T[]): Record<T, true>
+  function list_to_map<T>(list: T[]): LuaTable<T, true>
+  function list_to_map<T>(list: T): LuaTable<T[keyof T], true>
+}

package/settings/types.d.ts

@@ -1,120 +1,120 @@
-// Based off of https://wiki.factorio.com/Tutorial:Mod_settings
-
-export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting"
-
-export interface BaseSettingDefinition {
-  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
-  localized_name?: LocalisedString
-  localized_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 {
-  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 {
-  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 {
-  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 {
-  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[]
-}
-/** Setting definitions. See {@link https://wiki.factorio.com/Tutorial:Mod_settings} for more info. */
-export type SettingDefinition =
-  | BoolSettingDefinition
-  | IntSettingDefinition
-  | DoubleSettingDefinition
-  | StringSettingDefinition
-
-export interface Data {
-  readonly raw: {
-    [T in SettingDefinition["type"]]: Record<string, Extract<SettingDefinition, { type: T }>>
-  }
-  /**
-   * The `data` table expects a specific format for each item in the table. Missing properties will either fall back to
-   * default values or give an error indicating what's missing. Extra properties that the game isn't looking for are
-   * simply ignored.
-   */
-  extend(prototypes: SettingDefinition[]): void
-}
-/** A mapping of mod names to mod version for all enabled mods. */
-export type Mods = Record<string, string>
+// Based off of https://wiki.factorio.com/Tutorial:Mod_settings
+
+export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting"
+
+export interface BaseSettingDefinition {
+  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
+  localized_name?: LocalisedString
+  localized_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 {
+  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 {
+  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 {
+  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 {
+  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[]
+}
+/** Setting definitions. See {@link https://wiki.factorio.com/Tutorial:Mod_settings} for more info. */
+export type SettingDefinition =
+  | BoolSettingDefinition
+  | IntSettingDefinition
+  | DoubleSettingDefinition
+  | StringSettingDefinition
+
+export interface Data {
+  readonly raw: {
+    [T in SettingDefinition["type"]]: Record<string, Extract<SettingDefinition, { type: T }>>
+  }
+  /**
+   * The `data` table expects a specific format for each item in the table. Missing properties will either fall back to
+   * default values or give an error indicating what's missing. Extra properties that the game isn't looking for are
+   * simply ignored.
+   */
+  extend(prototypes: SettingDefinition[]): void
+}
+/** A mapping of mod names to mod version for all enabled mods. */
+export type Mods = Record<string, string>