factorio-types 1.2.9 → 1.2.11

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.15
+// Factorio version 2.0.17
 // API version 6
 
 declare namespace runtime {
@@ -4813,6 +4813,12 @@ interface LuaControl {
      * @returns The number of items that were actually removed.
      */
     remove_item(this: void, items: ItemStackIdentification): uint;
+    /**
+     * Sets if this characer or player is driving. Returns if the player or character is still driving.
+     * @param driving True for enter-vehicle, false for leave.
+     * @param force If true, the player will be ejected and left at the position of the car if normal "leave" is not possible.
+     */
+    set_driving(this: void, driving: bool, force?: bool): void;
     /**
      * Create an arrow which points at this entity. This is used in the tutorial. For examples, see `control.lua` in the campaign missions.
      */
@@ -5809,6 +5815,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.
      */
@@ -9529,10 +9539,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 +9758,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 +9778,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 +9811,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.
      */
@@ -9832,7 +9848,7 @@ interface LuaGameScript {
      */
     readonly difficulty: defines.difficulty;
     /**
-     * The currently active set of difficulty settings. Even though this property is marked as read-only, the members of the dictionary that is returned can be modified mid-game. This is however not recommended as different difficulties can have differing technology and recipe trees, which can cause problems for players.
+     * The currently active set of difficulty settings. Even though this property is marked as read-only, the members of the dictionary that is returned can be modified mid-game.
      * @example ```
     -- This will set the technology price multiplier to 12.
     game.difficulty_settings.technology_price_multiplier = 12
@@ -11615,7 +11631,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.
@@ -12032,6 +12048,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 +12841,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 +14724,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.

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.15
+// Factorio version 2.0.17
 // API version 6
 
 declare namespace runtime {
@@ -6236,7 +6236,7 @@ string | /**
 'item-in-inserter-hand' | /**
  * 130
  */
-'above-inserter' | /**
+'above-inserters' | /**
  * 131
  */
 'wires' | /**

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.15
+// Factorio version 2.0.17
 // 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.15
+// Factorio version 2.0.17
 // 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.15
+// Factorio version 2.0.17
 // 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.15
+// Factorio version 2.0.17
 // 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.15
+// Factorio version 2.0.17
 // API version 6
 
 declare namespace prototype {
@@ -6665,7 +6665,7 @@ interface ResearchWithSciencePackAchievementPrototype extends AchievementPrototy
 interface ResourceCategory extends Prototype {
 }
 /**
- * A mineable/gatherable entity. Its {@link collision_mask | prototype:EntityPrototype::collision_mask} must contain "resource-layer" if it should be minable with a {@link MiningDrillPrototype | prototype:MiningDrillPrototype}.
+ * A mineable/gatherable entity.
  * @example ```
 {
   type = "resource",

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.15
+// Factorio version 2.0.17
 // 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;
@@ -8126,7 +8127,7 @@ interface RecipeTints {
  *
  * Note: `decals` is used as special marker for {@link DecorativePrototype::render_layer | prototype:DecorativePrototype::render_layer}. When used elsewhere, the sprites will draw over the terrain.
  */
-type RenderLayer = 'zero' | 'background-transitions' | 'under-tiles' | 'decals' | 'above-tiles' | 'ground-layer-1' | 'ground-layer-2' | 'ground-layer-3' | 'ground-layer-4' | 'ground-layer-5' | 'lower-radius-visualization' | 'radius-visualization' | 'transport-belt-integration' | 'resource' | 'building-smoke' | 'rail-stone-path-lower' | 'rail-stone-path' | 'rail-tie' | 'decorative' | 'ground-patch' | 'ground-patch-higher' | 'ground-patch-higher2' | 'rail-chain-signal-metal' | 'rail-screw' | 'rail-metal' | 'remnants' | 'floor' | 'transport-belt' | 'transport-belt-endings' | 'floor-mechanics-under-corpse' | 'corpse' | 'floor-mechanics' | 'item' | 'transport-belt-reader' | 'lower-object' | 'transport-belt-circuit-connector' | 'lower-object-above-shadow' | 'lower-object-overlay' | 'object-under' | 'object' | 'cargo-hatch' | 'higher-object-under' | 'higher-object-above' | 'train-stop-top' | 'item-in-inserter-hand' | 'above-inserter' | 'wires' | 'under-elevated' | 'elevated-rail-stone-path-lower' | 'elevated-rail-stone-path' | 'elevated-rail-tie' | 'elevated-rail-screw' | 'elevated-rail-metal' | 'elevated-lower-object' | 'elevated-object' | 'elevated-higher-object' | 'fluid-visualization' | 'wires-above' | 'entity-info-icon' | 'entity-info-icon-above' | 'explosion' | 'projectile' | 'smoke' | 'air-object' | 'air-entity-info-icon' | 'light-effect' | 'selection-box' | 'higher-selection-box' | 'collision-selection-box' | 'arrow' | 'cursor';
+type RenderLayer = 'zero' | 'background-transitions' | 'under-tiles' | 'decals' | 'above-tiles' | 'ground-layer-1' | 'ground-layer-2' | 'ground-layer-3' | 'ground-layer-4' | 'ground-layer-5' | 'lower-radius-visualization' | 'radius-visualization' | 'transport-belt-integration' | 'resource' | 'building-smoke' | 'rail-stone-path-lower' | 'rail-stone-path' | 'rail-tie' | 'decorative' | 'ground-patch' | 'ground-patch-higher' | 'ground-patch-higher2' | 'rail-chain-signal-metal' | 'rail-screw' | 'rail-metal' | 'remnants' | 'floor' | 'transport-belt' | 'transport-belt-endings' | 'floor-mechanics-under-corpse' | 'corpse' | 'floor-mechanics' | 'item' | 'transport-belt-reader' | 'lower-object' | 'transport-belt-circuit-connector' | 'lower-object-above-shadow' | 'lower-object-overlay' | 'object-under' | 'object' | 'cargo-hatch' | 'higher-object-under' | 'higher-object-above' | 'train-stop-top' | 'item-in-inserter-hand' | 'above-inserters' | 'wires' | 'under-elevated' | 'elevated-rail-stone-path-lower' | 'elevated-rail-stone-path' | 'elevated-rail-tie' | 'elevated-rail-screw' | 'elevated-rail-metal' | 'elevated-lower-object' | 'elevated-object' | 'elevated-higher-object' | 'fluid-visualization' | 'wires-above' | 'entity-info-icon' | 'entity-info-icon-above' | 'explosion' | 'projectile' | 'smoke' | 'air-object' | 'air-entity-info-icon' | 'light-effect' | 'selection-box' | 'higher-selection-box' | 'collision-selection-box' | 'arrow' | 'cursor';
 /**
  * Defines the amount of an item required to research one unit of a {@link technology | prototype:TechnologyPrototype}. The first member of the tuple is the name of a {@link ToolPrototype | prototype:ToolPrototype} and the second is the amount. Amount must not be 0.
  * @example ```
@@ -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.9",
+  "version": "1.2.11",
   "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.15",
+  "factorioVersion": "2.0.17",
   "dependencies": {
     "lua-types": "^2.13.1"
   },