typed-factorio 2.13.0 → 2.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "description": "Featureful typescript definitions for the Factorio modding api.",
   "keywords": [
     "factorio",

package/prototype/generated/prototypes.d.ts

@@ -493,7 +493,7 @@ declare module "factorio:prototype" {
      *
      * Only loaded if `layers` is not defined.
      *
-     * Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error ({@linkplain https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example}). Modders can ignore this property.
+     * Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error. Modders can ignore this property.
      * @see {@link https://lua-api.factorio.com/1.1.110/prototypes/AnimationPrototype.html#load_in_minimal_mode Online documentation}
      */
     load_in_minimal_mode?: bool
@@ -4830,7 +4830,7 @@ declare module "factorio:prototype" {
     /**
      * **Default:** `max double`
      *
-     * The maximum flying speed of the robot, in tiles/tick. Useful to limit the impact of {@linkplain https://wiki.factorio.com/Worker_robot_speed_(research worker robot speed (research)}).
+     * The maximum flying speed of the robot, including bonuses, in tiles/tick. Useful to limit the impact of {@link WorkerRobotSpeedModifier worker robot speed research}.
      * @see {@link https://lua-api.factorio.com/1.1.110/prototypes/FlyingRobotPrototype.html#max_speed Online documentation}
      */
     max_speed?: double
@@ -7749,7 +7749,7 @@ declare module "factorio:prototype" {
     /**
      * Specifies the kind of prototype this is.
      *
-     * For a list of all types used in vanilla, see {@linkplain https://wiki.factorio.com/Data.raw data.raw}.
+     * For a list of all possible types, see the {@linkplain https://lua-api.factorio.com/1.1.110/prototypes.html prototype overview}.
      * @see {@link https://lua-api.factorio.com/1.1.110/prototypes/PrototypeBase.html#type Online documentation}
      */
     type: keyof PrototypeMap
@@ -9132,6 +9132,10 @@ declare module "factorio:prototype" {
    */
   export interface RobotWithLogisticInterfacePrototype extends FlyingRobotPrototype {
     type: "construction-robot" | "logistic-robot"
+    /**
+     * The robot's cargo carrying capacity. Can be increased by {@link WorkerRobotStorageModifier worker robot cargo size research}.
+     * @see {@link https://lua-api.factorio.com/1.1.110/prototypes/RobotWithLogisticInterfacePrototype.html#max_payload_size Online documentation}
+     */
     max_payload_size: ItemCountType
     cargo_centered: Vector
     /**
@@ -10560,7 +10564,7 @@ declare module "factorio:prototype" {
      *
      * Only loaded if `layers` is not defined.
      *
-     * Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error ({@linkplain https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example}). Modders can ignore this property.
+     * Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error. Modders can ignore this property.
      * @see {@link https://lua-api.factorio.com/1.1.110/prototypes/SpritePrototype.html#load_in_minimal_mode Online documentation}
      */
     load_in_minimal_mode?: bool
@@ -11066,7 +11070,7 @@ declare module "factorio:prototype" {
      */
     icons?: readonly IconData[]
     /**
-     * Path to the icon file. If this and `icon` is not set, the `material_background` in `variants` is used as the icon.
+     * Path to the icon file. If this and `icons` is not set, the `material_background` in `variants` is used as the icon.
      *
      * Only loaded if `icons` is not defined.
      * @see {@link https://lua-api.factorio.com/1.1.110/prototypes/TilePrototype.html#icon Online documentation}

package/prototype/generated/types.d.ts

@@ -5549,15 +5549,17 @@ declare module "factorio:prototype" {
     readonly type: "horizontal_scrollbar_style"
   }
   /**
-   * Icon layering follows the following rules:
+   * One layer of an icon. Icon layering follows the following rules:
    *
-   * - The rendering order of the individual icons follows the array order: Later added icons (higher index) are drawn on top of previously added icons (lower index).
+   * - The rendering order of the individual icon layers follows the array order: Later added icon layers (higher index) are drawn on top of previously added icon layers (lower index).
    *
    * - Only the first icon layer will display a shadow.
    *
    * - When the final icon is displayed with transparency (e.g. a faded out alert), the icon layer overlap may look {@linkplain https://forums.factorio.com/viewtopic.php?p=575844#p575844 undesirable}.
    *
-   * - The final combination of icons will always be resized in GUI based on the first icon layer's size, but won't be resized when displayed on machines in alt-mode. For example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings.
+   * - When the final icon is displayed with a shadow (e.g. an item on the ground or on a belt when item shadows are turned on), each icon layer will {@linkplain https://forums.factorio.com/84888 cast a shadow} and the shadow is cast on the layer below it.
+   *
+   * - The final icon will always be resized in GUI based on the first icon layer's size, but won't be resized when displayed on machines in alt-mode. For example: recipe first icon layer is size 128, scale 1, the icon group will be displayed at resolution /4 to fit the 32px GUI boxes, but will be displayed 4 times as large on buildings.
    *
    * - Shift values are based on final size (`icon_size * scale`) of the first icon layer.
    * @example
@@ -5647,13 +5649,17 @@ declare module "factorio:prototype" {
     /**
      * **Default:** `0`
      *
-     * Icons of reduced size will be used at decreased scale.
+     * Icons of reduced size will be used at decreased scale. If an icon doesn't specify custom mipmaps, the game will automatically generate them.
      * @see {@link https://lua-api.factorio.com/1.1.110/types/IconData.html#icon_mipmaps Online documentation}
      */
     icon_mipmaps?: IconMipMapType
   }
   /**
-   * Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image. The file must contain half-size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner, with no extra padding. Example sequence: `128x128@(0,0)`, `64x64@(128,0)`, `32x32@(192,0)` is three mipmaps.
+   * Icons of reduced size will be used at decreased scale. 0 or 1 mipmaps is a single image.
+   *
+   * If an icon doesn't specify custom mipmaps, the game will automatically generate {@linkplain https://factorio.com/blog/post/fff-291 icon mipmaps} for it.
+   *
+   * For custom mipmaps, the file must contain half-size images with a geometric-ratio, for each mipmap level. Each next level is aligned to the upper-left corner, with no extra padding. Example sequence: `128x128@(0,0)`, `64x64@(128,0)`, `32x32@(192,0)` is three mipmaps.
    *
    * See {@linkplain https://factorio.com/blog/post/fff-291 here} for more about the visual effects of icon mipmaps.
    * @see {@link https://lua-api.factorio.com/1.1.110/types/IconMipMapType.html Online documentation}
@@ -10946,7 +10952,7 @@ declare module "factorio:prototype" {
     /**
      * **Default:** `false`
      *
-     * Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error ({@linkplain https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example}). Modders can ignore this property.
+     * Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error. Modders can ignore this property.
      * @see {@link https://lua-api.factorio.com/1.1.110/types/SpriteParameters.html#load_in_minimal_mode Online documentation}
      */
     load_in_minimal_mode?: bool

package/runtime/generated/classes.d.ts

@@ -3391,7 +3391,7 @@ declare module "factorio:runtime" {
      */
     selected_gun_index?: uint
     /**
-     * Energy stored in the entity (heat in furnace, energy stored in electrical devices etc.). Always 0 for entities that don't have the concept of energy stored inside.
+     * Energy stored in the entity's energy buffer (energy stored in electrical devices etc.). Always 0 for entities that don't have the concept of energy stored inside.
      * @example
      * game.player.print("Machine energy: " .. game.player.selected.energy .. "J")
      * game.player.selected.energy = 3000
@@ -3435,7 +3435,7 @@ declare module "factorio:runtime" {
      * {@link https://lua-api.factorio.com/1.1.110/classes/LuaEntity.html#LuaEntity.neighbours > Differs depending on the type of entity:}
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaEntity.html#LuaEntity.neighbours Online documentation}
      */
-    readonly neighbours: Record<string, LuaEntity[]> | LuaEntity[][] | LuaEntity
+    readonly neighbours?: Record<string, LuaEntity[]> | LuaEntity[][] | LuaEntity
     /**
      * The belt connectable neighbours of this belt connectable entity. Only entities that input to or are outputs of this entity.
      *
@@ -5027,7 +5027,7 @@ declare module "factorio:runtime" {
      */
     drop_target?: LuaEntity
     /**
-     * Energy stored in the entity (heat in furnace, energy stored in electrical devices etc.). Always 0 for entities that don't have the concept of energy stored inside.
+     * Energy stored in the entity's energy buffer (energy stored in electrical devices etc.). Always 0 for entities that don't have the concept of energy stored inside.
      * @example
      * game.player.print("Machine energy: " .. game.player.selected.energy .. "J")
      * game.player.selected.energy = 3000
@@ -5050,7 +5050,7 @@ declare module "factorio:runtime" {
      * {@link https://lua-api.factorio.com/1.1.110/classes/LuaEntity.html#LuaEntity.neighbours > Differs depending on the type of entity:}
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaEntity.html#LuaEntity.neighbours Online documentation}
      */
-    readonly neighbours: Record<string, LuaEntity[]> | LuaEntity[][] | LuaEntity
+    readonly neighbours?: Record<string, LuaEntity[]> | LuaEntity[][] | LuaEntity
     /**
      * Fluidboxes of this entity.
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaEntity.html#LuaEntity.fluidbox Online documentation}
@@ -12999,7 +12999,7 @@ declare module "factorio:runtime" {
      */
     readonly player?: LuaPlayer
     /**
-     * Get a table of all the players that currently exist. This sparse table allows you to find players 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 players that currently exist. This sparse table allows you to find players by indexing it with either their `name` or `index`. Iterating this table with `pairs()` will provide the `index`es as the keys. Iterating with `ipairs()` will not work at all.
      *
      * If only a single player is required, {@link LuaGameScript#get_player LuaGameScript::get_player} should be used instead, as it avoids the unnecessary overhead of passing the whole table to Lua.
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaGameScript.html#LuaGameScript.players Online documentation}
@@ -19002,12 +19002,12 @@ declare module "factorio:runtime" {
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaModSettingPrototype.html#LuaModSettingPrototype.mod Online documentation}
      */
     readonly mod: string
-    readonly setting_type: string
+    readonly setting_type: "startup" | "runtime-global" | "runtime-per-user"
     /**
      * The default value of this setting.
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaModSettingPrototype.html#LuaModSettingPrototype.default_value Online documentation}
      */
-    readonly default_value: boolean | double | int | string
+    readonly default_value: boolean | double | int | string | Color
     /**
      * The minimum value for this setting. `nil` if this setting type doesn't support a minimum.
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaModSettingPrototype.html#LuaModSettingPrototype.minimum_value Online documentation}
@@ -20746,7 +20746,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -20795,7 +20795,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities. Rich text does not support this option.
+       * If this should be drawn below sprites and entities. Rich text does not support this option. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -20865,7 +20865,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -20919,7 +20919,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -20973,7 +20973,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -21031,7 +21031,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -22040,7 +22040,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -22089,7 +22089,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities. Rich text does not support this option.
+       * If this should be drawn below sprites and entities. Rich text does not support this option. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -22159,7 +22159,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -22213,7 +22213,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -22267,7 +22267,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -22325,7 +22325,7 @@ declare module "factorio:runtime" {
        */
       readonly visible?: boolean
       /**
-       * If this should be drawn below sprites and entities.
+       * If this should be drawn below sprites and entities. Defaults to false.
        */
       readonly draw_on_ground?: boolean
       /**
@@ -23954,7 +23954,7 @@ declare module "factorio:runtime" {
     /**
      * 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}. This table becomes invalid if its associated player does.
      *
-     * Even though this attribute is marked as read-only, individual settings can be changed by overwriting their {@link ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
+     * Even though this attribute is a getter, individual settings can be changed by overwriting their {@link ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
      * @example
      * -- Change the value of the "active_lifestyle" setting
      * settings.get_player_settings(player_index)["active_lifestyle"] = {value = true}
@@ -23981,9 +23981,9 @@ declare module "factorio:runtime" {
      */
     readonly global: LuaCustomTable<string, ModSetting>
     /**
-     * The default player mod settings for this map, indexed by prototype name.
+     * The **default** player mod settings for this map, indexed by prototype name. Changing these settings only affects the default settings for future players joining the game.
      *
-     * Even though this attribute is marked as read-only, individual settings can be changed by overwriting their {@link ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
+     * Individual settings can be changed by overwriting their {@link ModSetting} table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
      * @see {@link https://lua-api.factorio.com/1.1.110/classes/LuaSettings.html#LuaSettings.player Online documentation}
      */
     readonly player: LuaCustomTable<string, ModSetting>