factorio-types 1.2.8 → 1.2.10

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.14
+// Factorio version 2.0.16
 // API version 6
 
 declare namespace runtime {
@@ -5809,6 +5809,10 @@ interface LuaEntity extends LuaControl {
      * @param index If provided, only returns the `LuaLogisticPoint` specified by this index.
      */
     get_logistic_point(this: void, index?: defines.logistic_member_index): (LuaLogisticPoint | Record<defines.logistic_member_index, LuaLogisticPoint>) | null;
+    /**
+     * Gives logistic sections of this entity if it uses logistic sections.
+     */
+    get_logistic_sections(this: void): LuaLogisticSections | null;
     /**
      * Get all offers in a market as an array.
      */
@@ -6753,7 +6757,7 @@ interface LuaEntity extends LuaControl {
      */
     logistic_network: LuaLogisticNetwork;
     /**
-     * Max health of this entity. Quality of entity is taken into account.
+     * Max health of this entity.
      */
     readonly max_health: float;
     /**
@@ -7898,7 +7902,7 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * 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;
-    readonly per_lane_filters?: bool;
+    readonly per_lane_filters?: boolean;
     /**
      * The beacon profile: extra multiplier applied to the effects received from beacon by the effect receiver based on amount of beacons that reach that effect receiver
      */
@@ -8947,7 +8951,7 @@ interface LuaForce {
     create_space_platform(this: void, table: {
         name?: string;
         planet: SpaceLocationID;
-        starter_pack: ItemID;
+        starter_pack: ItemWithQualityID;
     }): LuaSpacePlatform | null;
     /**
      * Disable all recipes and technologies. Only recipes and technologies enabled explicitly will be useable from this point.
@@ -9529,10 +9533,6 @@ interface LuaGameScript {
      * Disables replay saving for the current save file. Once done there's no way to re-enable replay saving for the save file without loading an old save.
      */
     disable_replay(this: void): void;
-    /**
-     * Enables tip triggers in custom scenarios, that unlock new tips and show notices about unlocked tips.
-     */
-    enable_tip_triggers_in_custom_scenarios(this: void): void;
     /**
      * Force a CRC check. Tells all peers to calculate their current CRC, which are then compared to each other. If a mismatch is detected, the game desyncs and some peers are forced to reconnect.
      */
@@ -9752,6 +9752,8 @@ interface LuaGameScript {
      * @param table.show_entity_info Whether to include entity info ("Alt mode") or not. Defaults to `false`.
      * @param table.show_cursor_building_preview When `true` and when `player` is specified, the building preview for the item in the player's cursor will also be rendered. Defaults to `false`.
      * @param table.anti_alias Whether to render in double resolution and downscale the result (including GUI). Defaults to `false`.
+     * @param table.hide_clouds If `true` cloud shadows on ground won't be rendered. Defaults to `false`.
+     * @param table.hide_fog If `true` fog effect and foreground space dust effect won't be rendered. Defaults to `false`.
      * @param table.quality The `.jpg` render quality as a percentage (from 0% to 100% inclusive), if used. A lower value means a more compressed image. Defaults to `80`.
      * @param table.allow_in_replay Whether to save the screenshot even during replay playback. Defaults to `false`.
      * @param table.daytime Overrides the current surface daytime for the duration of screenshot rendering.
@@ -9770,6 +9772,8 @@ interface LuaGameScript {
         show_entity_info?: boolean;
         show_cursor_building_preview?: boolean;
         anti_alias?: boolean;
+        hide_clouds?: boolean;
+        hide_fog?: boolean;
         quality?: int;
         allow_in_replay?: boolean;
         daytime?: double;
@@ -9801,6 +9805,12 @@ interface LuaGameScript {
      * @param player The player to unmute.
      */
     unmute_player(this: void, player: PlayerIdentification): void;
+    /**
+     * If the tips are allowed to be activated in this scenario, it is false by default.
+     *
+     * Can't be modified in a simulation (menu screen, tips and tricks simulation, factoriopedia simulation etc.)
+     */
+    allow_tip_activation: boolean;
     /**
      * True by default. Can be used to disable autosaving. Make sure to turn it back on soon after.
      */
@@ -11615,7 +11625,7 @@ interface LuaItemCommon {
      * @param table.surface Surface to create from
      * @param table.force Force to use for the creation
      * @param table.area The bounding box
-     * @param table.always_include_tiles When true, blueprintable tiles are always included in the blueprint. When false they're only included if no entities exist in the setup area.
+     * @param table.always_include_tiles When true, blueprintable tiles are always included in the blueprint. When false they're only included if no entities exist in the setup area. Defaults to false.
      * @param table.include_entities When true, entities are included in the blueprint. Defaults to true.
      * @param table.include_modules When true, modules are included in the blueprint. Defaults to true.
      * @param table.include_station_names When true, station names are included in the blueprint. Defaults to false.
@@ -11916,7 +11926,7 @@ interface LuaItemCommon {
     trees_and_rocks_only: boolean;
 }
 /**
- * Prototype of an item. For example, an item prototype can be obtained from {@link LuaGameScript::item_prototypes | runtime:LuaGameScript::item_prototypes} by its name: `prototypes.item["iron-plate"]`.
+ * Prototype of an item. For example, an item prototype can be obtained from {@link LuaPrototypes::item | runtime:LuaPrototypes::item} by its name: `prototypes.item["iron-plate"]`.
  */
 interface LuaItemPrototype extends LuaPrototypeBase {
     /**
@@ -12032,6 +12042,10 @@ interface LuaItemPrototype extends LuaPrototypeBase {
      * The prototype of this armor's equipment grid, if any.
      */
     readonly equipment_grid?: LuaEquipmentGridPrototype;
+    /**
+     * The durability message key used when displaying the durability of this tool in Factoriopedia.
+     */
+    readonly factoriopedia_durability_description_key?: string;
     /**
      * The filter mode used by this item with inventory.
      */
@@ -12821,6 +12835,44 @@ interface LuaLogisticSection {
      */
     readonly valid: boolean;
 }
+/**
+ * Logistic sections of an entity.
+ */
+interface LuaLogisticSections {
+    /**
+     * Adds a new logistic section if possible.
+     * @param group The group to assign this section to.
+     * @returns Logistic section if added.
+     */
+    add_section(this: void, group?: string): LuaLogisticSection | null;
+    /**
+     * Gets section on the selected index, if it exists.
+     * @param section_index Index of the section.
+     */
+    get_section(this: void, section_index: uint): LuaLogisticSection | null;
+    /**
+     * Removes the given logistic section if possible. Removal may fail if the section index is out of range or the section is not {@link manual | runtime:LuaLogisticSection::is_manual}.
+     * @param section_index Index of the section.
+     * @returns Whether section was removed.
+     */
+    remove_section(this: void, section_index: uint): boolean;
+    /**
+     * 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;
+    /**
+     * All logistic sections of this entity.
+     */
+    readonly sections: LuaLogisticSection[];
+    /**
+     * Amount of logistic sections this entity has.
+     */
+    readonly sections_count: uint;
+    /**
+     * 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;
+}
 /**
  * Control behavior for mining drills.
  */
@@ -14666,7 +14718,7 @@ interface LuaRecord {
      * @param table.surface Surface to create from
      * @param table.force Force to use for the creation
      * @param table.area The bounding box
-     * @param table.always_include_tiles When true, blueprintable tiles are always included in the blueprint. When false they're only included if no entities exist in the setup area.
+     * @param table.always_include_tiles When true, blueprintable tiles are always included in the blueprint. When false they're only included if no entities exist in the setup area. Defaults to false.
      * @param table.include_entities When true, entities are included in the blueprint. Defaults to true.
      * @param table.include_modules When true, modules are included in the blueprint. Defaults to true.
      * @param table.include_station_names When true, station names are included in the blueprint. Defaults to false.
@@ -15723,6 +15775,7 @@ interface LuaSimulation {
      * 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;
+    smart_belt_building?: boolean;
     /**
      * 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.
      */
@@ -15883,7 +15936,7 @@ interface LuaSpacePlatform {
     /**
      * The starter pack used to create this space platform.
      */
-    readonly starter_pack: LuaItemPrototype;
+    readonly starter_pack: ItemIDAndQualityIDPair;
     /**
      * The current state of this space platform.
      */
@@ -16794,8 +16847,9 @@ interface LuaSurface {
      * Spawn pollution at the given position.
      * @param source Where to spawn the pollution.
      * @param amount How much pollution to add.
+     * @param prototype The entity prototype to attribute the pollution change to in statistics. If not defined, the pollution change will not show up in statistics.
      */
-    pollute(this: void, source: MapPosition, amount: double): void;
+    pollute(this: void, source: MapPosition, amount: double, prototype?: EntityID): void;
     /**
      * Print text to the chat console of all players on this surface.
      *

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.14
+// Factorio version 2.0.16
 // API version 6
 
 declare namespace runtime {
@@ -1483,7 +1483,7 @@ interface EntityPrototypeFilterFlag extends BaseEntityPrototypeFilter {
 /**
  * For use within nested filters such as the `place-result` filter of array{@link [ItemPrototypeFilter | runtime:ItemPrototypeFilter}].
  *
- * To get a specific prototype by name, see {@link LuaGameScript::entity_prototypes | runtime:LuaGameScript::entity_prototypes}.
+ * To get a specific prototype by name, see {@link LuaPrototypes::entity | runtime:LuaPrototypes::entity}.
  * Applies to variant case `name`
  */
 interface EntityPrototypeFilterName extends BaseEntityPrototypeFilter {
@@ -1999,7 +1999,7 @@ interface FluidPrototypeFilterMaxTemperature extends BaseFluidPrototypeFilter {
 /**
  * For use within nested filters such as the `has-product-fluid` filter of array{@link [RecipePrototypeFilter | runtime:RecipePrototypeFilter}].
  *
- * To get a specific prototype by name, see {@link LuaGameScript::fluid_prototypes | runtime:LuaGameScript::fluid_prototypes}.
+ * To get a specific prototype by name, see {@link LuaPrototypes::fluid | runtime:LuaPrototypes::fluid}.
  * Applies to variant case `name`
  */
 interface FluidPrototypeFilterName extends BaseFluidPrototypeFilter {
@@ -2705,7 +2705,7 @@ interface ItemPrototypeFilterFuelValue extends BaseItemPrototypeFilter {
 /**
  * For use within nested filters such as the `has-product-item` filter of array{@link [RecipePrototypeFilter | runtime:RecipePrototypeFilter}].
  *
- * To get a specific prototype by name, see {@link LuaGameScript::item_prototypes | runtime:LuaGameScript::item_prototypes}.
+ * To get a specific prototype by name, see {@link LuaPrototypes::item | runtime:LuaPrototypes::item}.
  * Applies to variant case `name`
  */
 interface ItemPrototypeFilterName extends BaseItemPrototypeFilter {
@@ -5527,6 +5527,7 @@ interface PipeConnection {
     target_pipe_connection_index?: uint;
 }
 interface PipeConnectionDefinition {
+    connection_type: 'normal' | 'underground' | 'linked';
     /**
      * The 4 cardinal direction connection points for this pipe.
      */
@@ -5537,6 +5538,10 @@ interface PipeConnectionDefinition {
     max_underground_distance?: uint;
     flow_direction: 'input-output' | 'input' | 'output';
     direction: defines.direction;
+    /**
+     * Only supplied if `connection_type` is `"linked"`.
+     */
+    linked_connection_id?: uint32;
 }
 interface PlaceAsTileResult {
     /**

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.14
+// Factorio version 2.0.16
 // API version 6
 
 declare namespace prototype {

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.14
+// Factorio version 2.0.16
 // API version 6
 
 declare namespace defines {

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.14
+// Factorio version 2.0.16
 // 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.14
+// Factorio version 2.0.16
 // 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.14
+// Factorio version 2.0.16
 // API version 6
 
 declare namespace prototype {
@@ -10221,6 +10221,7 @@ interface UtilitySprites extends PrototypeBase {
     mod_downloads_count: Sprite;
     mod_last_updated: Sprite;
     mouse_cursor: Sprite;
+    mouse_cursor_macos: Sprite;
     move_tag: Sprite;
     multiplayer_waiting_icon: Sprite;
     nature_icon: Sprite;

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.14
+// Factorio version 2.0.16
 // API version 6
 
 declare namespace prototype {
@@ -2424,6 +2424,7 @@ interface ChartUtilityConstants {
     artillery_range_color: Color;
     blue_signal_color: Color;
     chart_construction_robot_color: Color;
+    chart_deconstruct_active_color: Color;
     chart_deconstruct_tint: Color;
     chart_delivery_to_me_logistic_robot_color: Color;
     chart_logistic_robot_color: Color;
@@ -12526,6 +12527,10 @@ interface WorkingVisualisation {
      */
     draw_when_state_filter_matches?: bool;
     east_animation?: Animation;
+    /**
+     * If defined, animation in this visualisation layer will be used only as mask for fog effect and will not render in world.
+     */
+    east_fog_mask?: FogMaskShapeDefinition;
     east_position?: Vector;
     east_secondary_draw_order?: int8;
     effect?: 'flicker' | 'uranium-glow' | 'none';
@@ -12533,11 +12538,21 @@ interface WorkingVisualisation {
     enabled_in_animated_shift_during_transition?: bool;
     enabled_in_animated_shift_during_waypoint_stop?: bool;
     fadeout?: bool;
+    /**
+     * Loaded only if at least one of north_fog_mask, east_fog_mask, south_fog_mask, west_fog_mask is not specified.
+     *
+     * If defined, animation in this visualisation layer will be used only as mask for fog effect and will not render in world.
+     */
+    fog_mask?: FogMaskShapeDefinition;
     frame_based_on_shift_animation_progress?: bool;
     light?: LightDefinition;
     mining_drill_scorch_mark?: bool;
     name?: string;
     north_animation?: Animation;
+    /**
+     * If defined, animation in this visualisation layer will be used only as mask for fog effect and will not render in world.
+     */
+    north_fog_mask?: FogMaskShapeDefinition;
     north_position?: Vector;
     north_secondary_draw_order?: int8;
     render_layer?: RenderLayer;
@@ -12558,10 +12573,18 @@ interface WorkingVisualisation {
      */
     secondary_draw_order?: int8;
     south_animation?: Animation;
+    /**
+     * If defined, animation in this visualisation layer will be used only as mask for fog effect and will not render in world.
+     */
+    south_fog_mask?: FogMaskShapeDefinition;
     south_position?: Vector;
     south_secondary_draw_order?: int8;
     synced_fadeout?: bool;
     west_animation?: Animation;
+    /**
+     * If defined, animation in this visualisation layer will be used only as mask for fog effect and will not render in world.
+     */
+    west_fog_mask?: FogMaskShapeDefinition;
     west_position?: Vector;
     west_secondary_draw_order?: int8;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.8",
+  "version": "1.2.10",
   "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.14",
+  "factorioVersion": "2.0.16",
   "dependencies": {
     "lua-types": "^2.13.1"
   },

package/src/core.d.ts

@@ -30,8 +30,9 @@ declare const serpent: Serpent;
 // can eventually fix these on a per-case basis
 type Table = any;
 
+// These ones seem to be strangely missing from concepts and therefore not available in the runtime namespace
 type uint = number;
-
+type uint32 = number;
 type bool = boolean;
 
 /*