factorio-types 1.2.40 → 1.2.41

package/dist/classes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace runtime {
@@ -8155,7 +8155,7 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
     /**
      * Properties of custom inventory. Only provided if inventory_type is `"with_custom_stack_size"`.
      */
-    readonly inventory_properties?: InventoryWithCustomStackSizePrototype;
+    readonly inventory_properties?: InventoryWithCustomStackSizeSpecification;
     readonly inventory_size_quality_increase?: uint;
     /**
      * The inventory type this container or linked container uses.
@@ -8170,17 +8170,24 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * These are the objects that are considered buildings:
      *
      * - AccumulatorPrototype
+     * - AgriculturalTowerPrototype
      * - ArtilleryTurretPrototype
+     * - AsteroidCollectorPrototype
      * - BeaconPrototype
      * - BoilerPrototype
      * - BurnerGeneratorPrototype
-     * - CombinatorPrototype → ArithmeticCombinator, DeciderCombinator
+     * - CargoBayPrototype
+     * - CargoLandingPadPrototype
+     * - CombinatorPrototype → ArithmeticCombinator, DeciderCombinator, SelectorCombinator
      * - ConstantCombinatorPrototype
-     * - ContainerPrototype → LogisticContainer, InfinityContainer
+     * - ContainerPrototype → LogisticContainer, InfinityContainer, TemporaryContainer
      * - CraftingMachinePrototype → AssemblingMachine, RocketSilo, Furnace
+     * - DisplayPanelPrototype
      * - ElectricEnergyInterfacePrototype
      * - ElectricPolePrototype
      * - EnemySpawnerPrototype
+     * - FusionGeneratorPrototype
+     * - FusionReactorPrototype
      * - GatePrototype
      * - GeneratorPrototype
      * - HeatInterfacePrototype
@@ -8188,6 +8195,7 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * - InserterPrototype
      * - LabPrototype
      * - LampPrototype
+     * - LightningAttractorPrototype
      * - LinkedContainerPrototype
      * - MarketPrototype
      * - MiningDrillPrototype
@@ -8196,19 +8204,24 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * - PipeToGroundPrototype
      * - PowerSwitchPrototype
      * - ProgrammableSpeakerPrototype
+     * - ProxyContainerPrototype
      * - PumpPrototype
      * - RadarPrototype
-     * - RailPrototype → CurvedRail, StraightRail
+     * - RailPrototype → CurvedRailA, ElevatedCurvedRailA, CurvedRailB, ElevatedCurvedRailB, HalfDiagonalRail, ElevatedHalfDiagonalRail, LegacyCurvedRail, LegacyStraightRail, RailRamp, StraightRail, ElevatedStraightRail
      * - RailSignalBasePrototype → RailChainSignal, RailSignal
+     * - RailSupportPrototype
      * - ReactorPrototype
      * - RoboportPrototype
      * - SimpleEntityPrototype
      * - SimpleEntityWithOwnerPrototype → SimpleEntityWithForce
      * - SolarPanelPrototype
+     * - SpacePlatformHubPrototype
      * - StorageTankPrototype
+     * - ThrusterPrototype
      * - TrainStopPrototype
-     * - TransportBeltConnectablePrototype → LinkedBelt, Loader1x1, Loader1x2, Splitter, TransportBelt, UndergroundBelt
+     * - TransportBeltConnectablePrototype → LaneSplitter, LinkedBelt, Loader1x1, Loader1x2, Splitter, TransportBelt, UndergroundBelt
      * - TurretPrototype → AmmoTurret, ElectricTurret, FluidTurret
+     * - ValvePrototype
      * - WallPrototype
      */
     readonly is_building: boolean;
@@ -8398,6 +8411,7 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      */
     readonly move_while_shooting?: boolean;
     readonly neighbour_bonus?: double;
+    readonly neighbour_connectable?: NeighbourConnectable;
     /**
      * The next upgrade for this entity, if any.
      */
@@ -13587,6 +13601,28 @@ interface LuaMiningDrillControlBehavior extends LuaGenericOnOffControlBehavior {
      */
     readonly valid: boolean;
 }
+/**
+ * Arbitrary data provided by mods.
+ */
+interface LuaModData extends LuaPrototypeBase {
+    /**
+     * Provides partial access to the data.
+     */
+    get(this: void, key: string): AnyBasic | null;
+    /**
+     * Provides full data of this prototype.
+     */
+    readonly data: Record<string, AnyBasic>;
+    readonly data_type: string;
+    /**
+     * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
+     */
+    readonly object_name: string;
+    /**
+     * Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
+     */
+    readonly valid: boolean;
+}
 /**
  * Prototype of a mod setting.
  */
@@ -14848,6 +14884,10 @@ interface LuaPrototypes {
     readonly max_inserter_reach_distance: double;
     readonly max_pipe_to_ground_distance: uint8;
     readonly max_underground_belt_distance: uint8;
+    /**
+     * A dictionary containing every LuaModData indexed by `name`.
+     */
+    readonly mod_data: Record<string, LuaModData>;
     /**
      * A dictionary containing every LuaModSettingPrototype indexed by `name`.
      */

package/dist/concepts.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace runtime {
@@ -2668,7 +2668,7 @@ interface InventoryPosition {
      */
     count?: ItemCountType;
 }
-interface InventoryWithCustomStackSizePrototype {
+interface InventoryWithCustomStackSizeSpecification {
     stack_size_multiplier: double;
     stack_size_min: ItemCountType;
     stack_size_max: ItemCountType;
@@ -5330,6 +5330,10 @@ float | /**
  * equivalent to `2`.
  */
 'very-good';
+interface MapLocation {
+    position: MapLocation;
+    direction: defines.direction;
+}
 /**
  * Coordinates on a surface, for example of an entity. MapPositions may be specified either as a dictionary with `x`, `y` as keys, or simply as an array with two elements.
  *
@@ -5574,6 +5578,16 @@ interface ModuleEffects {
  * To write to this, use an array{@link [string | runtime:string}] of the mouse buttons that should be possible to use with on button. The flag `"left-and-right"` can also be set, which will set `"left"` and `"right"` to `true`.
  */
 type MouseButtonFlags = Record<'left' | 'right' | 'middle' | 'button-4' | 'button-5' | 'button-6' | 'button-7' | 'button-8' | 'button-9', true>;
+interface NeighbourConnectable {
+    affected_by_direction: boolean;
+    neighbour_search_distance: float;
+    connections: NeighbourConnectableConnectionDefinition[];
+}
+interface NeighbourConnectableConnectionDefinition {
+    location: MapLocation;
+    category: string;
+    neighbour_category: string[];
+}
 /**
  * The string representation of a noise expression. More detailed information is found on the {@link prototype docs | prototype:NamedNoiseExpression}.
  */

package/dist/datacollection.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace prototype {
@@ -457,6 +457,9 @@ interface dataCollection {
     'mining-drill': {
         [key: string]: MiningDrillPrototype;
     };
+    'mod-data': {
+        [key: string]: ModData;
+    };
     'module-category': {
         [key: string]: ModuleCategory;
     };

package/dist/defines.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace defines {
@@ -1777,6 +1777,12 @@ namespace prototypes {
     enum map_settings {
         'map-settings' = 0
     }
+    /**
+     * @customName mod-data
+     */
+    enum mod_data {
+        'mod-data' = 0
+    }
     /**
      * @customName module-category
      */

package/dist/events.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace runtime {

package/dist/global.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 /**

package/dist/prototypes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace prototype {
@@ -1840,7 +1840,7 @@ interface ContainerPrototype extends EntityWithOwnerPrototype {
     /**
      * Only used when `inventory_type` is `"with_custom_stack_size"`.
      */
-    inventory_properties?: InventoryWithCustomStackSizePrototype;
+    inventory_properties?: InventoryWithCustomStackSizeSpecification;
     /**
      * The number of slots in this container.
      */
@@ -1974,6 +1974,12 @@ interface CraftingMachinePrototype extends EntityWithOwnerPrototype {
      * Crafting speed has to be positive.
      */
     crafting_speed: double;
+    /**
+     * Each value must be >= 0.01.
+     *
+     * If value is not provided for a quality, then {@link QualityPrototype::crafting_machine_speed_multiplier | prototype:QualityPrototype::crafting_machine_speed_multiplier} will be used as a speed multiplier instead.
+     */
+    crafting_speed_quality_multiplier?: LuaTable<QualityID, double>;
     /**
      * Whether the "alt-mode icon" should have a black background.
      */
@@ -1992,6 +1998,14 @@ interface CraftingMachinePrototype extends EntityWithOwnerPrototype {
     ```
      */
     energy_usage: Energy;
+    /**
+     * Each value must be >= 0.01.
+     *
+     * If value is not provided for a quality, then {@link QualityPrototype::crafting_machine_energy_usage_multiplier | prototype:QualityPrototype::crafting_machine_energy_usage_multiplier} will be used as an energy usage multiplier instead.
+     *
+     * Does nothing if {@link CraftingMachinePrototype::quality_affects_energy_usage | prototype:CraftingMachinePrototype::quality_affects_energy_usage} is not set.
+     */
+    energy_usage_quality_multiplier?: LuaTable<QualityID, double>;
     fast_transfer_modules_into_module_slots_only?: boolean;
     /**
      * The crafting machine's fluid boxes. If an assembling machine has fluid boxes *and* {@link AssemblingMachinePrototype::fluid_boxes_off_when_no_fluid_recipe | prototype:AssemblingMachinePrototype::fluid_boxes_off_when_no_fluid_recipe} is true, the assembling machine can only be rotated when a recipe consuming or producing fluid is set, or if it has one of the other properties listed at the top of this page.
@@ -2030,6 +2044,12 @@ interface CraftingMachinePrototype extends EntityWithOwnerPrototype {
      * The number of module slots in this machine.
      */
     module_slots?: ItemStackIndex;
+    /**
+     * If value is not provided for a quality, then {@link QualityPrototype::crafting_machine_module_slots_bonus | prototype:QualityPrototype::crafting_machine_module_slots_bonus} will be used as a module slots bonus instead.
+     *
+     * Does nothing if {@link CraftingMachinePrototype::quality_affects_module_slots | prototype:CraftingMachinePrototype::quality_affects_module_slots} is not set.
+     */
+    module_slots_quality_bonus?: LuaTable<QualityID, ItemStackIndex>;
     /**
      * Affects animation speed.
      */
@@ -3154,6 +3174,9 @@ interface EntityPrototype extends Prototype {
     fast_replaceable_group?: string;
     flags?: EntityPrototypeFlags;
     friendly_map_color?: Color;
+    /**
+     * This entity can freeze if heating_energy is larger than zero.
+     */
     heating_energy?: Energy;
     /**
      * Where beams should hit the entity. Useful if the bounding box only covers part of the entity (e.g. feet of the character) and beams only hitting there would look weird.
@@ -5262,7 +5285,7 @@ interface LinkedContainerPrototype extends EntityWithOwnerPrototype {
     /**
      * Only used when `inventory_type` is `"with_custom_stack_size"`.
      */
-    inventory_properties?: InventoryWithCustomStackSizePrototype;
+    inventory_properties?: InventoryWithCustomStackSizeSpecification;
     /**
      * Must be > 0.
      */
@@ -5632,6 +5655,19 @@ interface MiningDrillPrototype extends EntityWithOwnerPrototype {
     vector_to_place_result: Vector;
     wet_mining_graphics_set?: MiningDrillGraphicsSet;
 }
+/**
+ * Block of arbitrary data set by mods in data stage.
+ */
+interface ModData extends Prototype {
+    data: Record<string, AnyBasic>;
+    /**
+     * Arbitrary string that mods can use to declare type of data. Can be used for mod compatibility when one mod declares block of data that is expected to be discovered by another mod.
+     * @example ```
+    data_type = "my-mod.my_structure"
+    ```
+     */
+    data_type?: string;
+}
 /**
  * A module category. The built-in categories can be found {@link here | https://wiki.factorio.com/Data.raw#module-category}. See {@link ModulePrototype::category | prototype:ModulePrototype::category}.
  */
@@ -6341,6 +6377,9 @@ interface PumpPrototype extends EntityWithOwnerPrototype {
      */
     pumping_speed: FluidAmount;
 }
+/**
+ * One quality step. Its effects are specified by the level and the various multiplier and bonus properties. Properties ending in `_multiplier` are applied multiplicatively to their base property, properties ending in `_bonus` are applied additively.
+ */
 interface QualityPrototype extends Prototype {
     /**
      * Must be >= 0.01.
@@ -6368,17 +6407,23 @@ interface QualityPrototype extends Prototype {
     beacon_supply_area_distance_bonus?: float;
     color: Color;
     /**
+     * Must be >= 0.01.
+     *
      * Only affects crafting machines with {@link CraftingMachinePrototype::quality_affects_energy_usage | prototype:CraftingMachinePrototype::quality_affects_energy_usage} set.
      *
-     * Must be >= 0.01.
+     * Will be ignored by crafting machines with {@link CraftingMachinePrototype::energy_usage_quality_multiplier | prototype:CraftingMachinePrototype::energy_usage_quality_multiplier} set.
      */
     crafting_machine_energy_usage_multiplier?: double;
     /**
      * Only affects crafting machines with {@link CraftingMachinePrototype::quality_affects_module_slots | prototype:CraftingMachinePrototype::quality_affects_module_slots} set.
+     *
+     * Will be ignored by crafting machines with {@link CraftingMachinePrototype::module_slots_quality_bonus | prototype:CraftingMachinePrototype::module_slots_quality_bonus} set.
      */
     crafting_machine_module_slots_bonus?: ItemStackIndex;
     /**
      * Must be >= 0.01.
+     *
+     * Will be ignored by crafting machines with {@link CraftingMachinePrototype::crafting_speed_quality_multiplier | prototype:CraftingMachinePrototype::crafting_speed_quality_multiplier} set.
      */
     crafting_machine_speed_multiplier?: double;
     /**
@@ -6397,9 +6442,9 @@ interface QualityPrototype extends Prototype {
     equipment_grid_height_bonus?: int16;
     equipment_grid_width_bonus?: int16;
     /**
-     * Only affects fluid wagons with {@link FluidWagonPrototype::quality_affects_capacity | prototype:FluidWagonPrototype::quality_affects_capacity} set.
-     *
      * Must be >= 0.01.
+     *
+     * Only affects fluid wagons with {@link FluidWagonPrototype::quality_affects_capacity | prototype:FluidWagonPrototype::quality_affects_capacity} set.
      */
     fluid_wagon_capacity_multiplier?: double;
     /**
@@ -6473,7 +6518,9 @@ interface QualityPrototype extends Prototype {
      */
     next_probability?: double;
     /**
-     * Must be within [1, 3].
+     * Must be within `[1, 3]`.
+     *
+     * Affects the range of {@link attack parameters | prototype:AttackParameters}, e.g. those used by combat robots, units, guns and turrets.
      */
     range_multiplier?: double;
     /**
@@ -8313,7 +8360,7 @@ interface SpaceConnectionPrototype extends Prototype {
     to: SpaceLocationID;
 }
 /**
- * A space location, such as a planet.
+ * A space location, such as a planet or the solar system edge.
  */
 interface SpaceLocationPrototype extends Prototype {
     asteroid_spawn_definitions?: SpaceLocationAsteroidSpawnDefinition[];
@@ -11308,6 +11355,8 @@ type dataExtendType = ({
 } & MarketPrototype) | ({
     type: 'mining-drill';
 } & MiningDrillPrototype) | ({
+    type: 'mod-data';
+} & ModData) | ({
     type: 'module-category';
 } & ModuleCategory) | ({
     type: 'module';

package/dist/types.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.57
+// Factorio version 2.0.58
 // API version 6
 
 declare namespace prototype {
@@ -579,6 +579,10 @@ type AnimationVariations = {
      */
     sheets?: AnimationSheet[];
 } | Animation | Animation[];
+/**
+ * Any basic type (string, number, boolean) or table.
+ */
+type AnyBasic = string | boolean | number | table;
 /**
  * A union of all prototypes. A specific prototype is loaded based on the value of the `type` key.
  *
@@ -1035,6 +1039,9 @@ MarketPrototype | /**
  * `'mining-drill'`
  */
 MiningDrillPrototype | /**
+ * `'mod-data'`
+ */
+ModData | /**
  * `'module-category'`
  */
 ModuleCategory | /**
@@ -4582,7 +4589,7 @@ interface FluidBox {
      */
     pipe_connections: PipeConnectionDefinition[];
     /**
-     * The pictures to show when another fluid box connects to this one.
+     * The pictures to show when no fluid box is connected to this one.
      */
     pipe_covers?: Sprite4Way;
     pipe_covers_frozen?: Sprite4Way;
@@ -5424,7 +5431,7 @@ interface InterruptibleSound {
      */
     stopped_sound?: Sound;
 }
-interface InventoryWithCustomStackSizePrototype {
+interface InventoryWithCustomStackSizeSpecification {
     /**
      * Must be >= stack_size_min.
      */
@@ -12943,6 +12950,12 @@ type int32 = number;
  * Decimal numbers are automatically truncated when used in place of `int8`.
  */
 type int8 = number;
+/**
+ * A simple {@link Lua table | http://www.lua.org/pil/2.5.html}. An array is a table that uses continuous integer keys starting at `1`, while a dictionary can use numeric or string keys in any order or combination.
+ *
+ * Tables used by prototypes may be parsed via an internal class called "property tree". Errors that reference this class treat tables as 0-indexed. For example `Value must be a number in property tree at ROOT.technology.steel-plate-productivity.effects[0].change` refers to element 0 of the property tree array which in Lua is at index 1.
+ */
+type table = Table;
 /**
  * 16 bit unsigned integer. Ranges from `0` to `65 535`, or `[0, 2^16-1]`.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.40",
+  "version": "1.2.41",
   "description": "Typescript declarations for the Factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,7 +23,7 @@
     "src/**/*.d.ts",
     "dist/**/*.d.ts"
   ],
-  "factorioVersion": "2.0.57",
+  "factorioVersion": "2.0.58",
   "dependencies": {
     "lua-types": "^2.13.1"
   },