factorio-types 1.2.29 → 1.2.31

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.42
+// Factorio version 2.0.44
 // API version 6
 
 declare namespace runtime {
@@ -181,6 +181,7 @@ interface LuaAgriculturalTowerControlBehavior extends LuaGenericOnOffControlBeha
 interface LuaAirbornePollutantPrototype extends LuaPrototypeBase {
     readonly affects_evolution: boolean;
     readonly chart_color: Color;
+    readonly damages_trees: boolean;
     readonly localised_name_with_amount_key: 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.
@@ -4869,12 +4870,20 @@ interface LuaControl {
      * Unselect any selected entity.
      */
     clear_selected_entity(this: void): void;
+    /**
+     * Closes the Factoriopedia GUI if it's open.
+     */
+    close_factoriopedia_gui(this: void): void;
     /**
      * Disable the flashlight.
+     *
+     * Applied per controller. Only supported by {@link defines.controllers.character | runtime:defines.controllers.character} and {@link defines.controllers.remote | runtime:defines.controllers.remote}.
      */
     disable_flashlight(this: void): void;
     /**
      * Enable the flashlight.
+     *
+     * Applied per controller. Only supported by {@link defines.controllers.character | runtime:defines.controllers.character} and {@link defines.controllers.remote | runtime:defines.controllers.remote}.
      */
     enable_flashlight(this: void): void;
     /**
@@ -4932,7 +4941,7 @@ interface LuaControl {
      */
     is_cursor_empty(this: void): boolean;
     /**
-     * Is the flashlight enabled.
+     * Is the flashlight enabled for the current controller. Only supported by {@link defines.controllers.character | runtime:defines.controllers.character} and {@link defines.controllers.remote | runtime:defines.controllers.remote}.
      */
     is_flashlight_enabled(this: void): boolean;
     /**
@@ -4952,6 +4961,10 @@ interface LuaControl {
      * @returns Whether the mining succeeded.
      */
     mine_tile(this: void, tile: LuaTile): boolean;
+    /**
+     * Open the Factoriopedia GUI and select a given entry.
+     */
+    open_factoriopedia_gui(this: void, prototype?: LuaPrototypeBase): void;
     /**
      * Open the technology GUI and select a given technology.
      * @param technology The technology to select after opening the GUI.
@@ -5173,9 +5186,9 @@ interface LuaControl {
      *
      * This is the GUI that will asked to close (by firing the {@link on_gui_closed | runtime:on_gui_closed} event) when the `Esc` or `E` keys are pressed. If this attribute is non-nil, then writing `nil` or a new GUI to it will ask the existing GUI to close.
      *
-     * Write supports any of the types. Read will return the `entity`, `equipment`, `equipment-grid`, `player`, `element`, `inventory` or `nil`.
+     * Write supports any of the types. Read will return the `entity`, `equipment`, `equipment-grid`, `player`, `element`, `inventory`, `item` or `nil`.
      */
-    opened?: LuaEntity | LuaItemStack | LuaEquipment | LuaEquipmentGrid | LuaPlayer | LuaGuiElement | LuaInventory | LuaLogisticNetwork | defines.gui_type;
+    opened?: LuaEntity | LuaItemStack | LuaEquipment | LuaEquipmentGrid | LuaPlayer | LuaGuiElement | LuaInventory | LuaLogisticNetwork | LuaItemStack | defines.gui_type;
     readonly opened_gui_type?: defines.gui_type;
     /**
      * Current item-picking state.
@@ -6228,7 +6241,7 @@ interface LuaEntity extends LuaControl {
     /**
      * @returns `true` if the rocket was successfully launched. Return value of `false` means the silo is not ready for launch.
      */
-    launch_rocket(this: void): boolean;
+    launch_rocket(this: void, destination?: CargoDestination): boolean;
     /**
      * Mines this entity.
      *
@@ -8364,9 +8377,9 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      */
     readonly tank_driving?: boolean;
     /**
-     * The target temperature of this boiler prototype.
+     * The target temperature of this boiler or fusion reactor prototype. If `nil` on a fusion reactor, the target temperature is the default temperature of the output fluid.
      */
-    readonly target_temperature?: double;
+    readonly target_temperature?: float;
     /**
      * The terrain friction modifier for this vehicle.
      */
@@ -13546,6 +13559,9 @@ interface LuaPlayer extends LuaControl {
      * @param table.position Where to create the pin. Required when surface is defined.
      */
     add_pin(this: void, table: {
+        label?: string;
+        preview_distance?: uint16;
+        always_visible?: boolean;
         entity?: LuaEntity;
         player?: PlayerIdentification;
         surface?: SurfaceIdentification;
@@ -13903,7 +13919,7 @@ interface LuaPlayer extends LuaControl {
     set_controller(this: void, table: {
         type: defines.controllers;
         character?: LuaEntity;
-        waypoints?: CutsceneWaypoint;
+        waypoints?: CutsceneWaypoint[];
         start_position?: MapPosition;
         start_zoom?: double;
         final_transition_time?: uint;

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.42
+// Factorio version 2.0.44
 // API version 6
 
 declare namespace runtime {
@@ -1851,7 +1851,7 @@ interface EventData {
  *
  * Filters are always used as an array of filters of a specific type. Every filter can only be used with its corresponding event, and different types of event filters can not be mixed.
  */
-type EventFilter = (LuaPrePlatformMinedEntityEventFilter | LuaRobotMinedEntityEventFilter | LuaEntityMarkedForUpgradeEventFilter | LuaPreGhostUpgradedEventFilter | LuaPlatformMinedEntityEventFilter | LuaScriptRaisedDestroyEventFilter | LuaPlayerBuiltEntityEventFilter | LuaPlatformBuiltEntityEventFilter | LuaPreGhostDeconstructedEventFilter | LuaEntityClonedEventFilter | LuaScriptRaisedTeleportedEventFilter | LuaEntityDeconstructionCancelledEventFilter | LuaRobotBuiltEntityEventFilter | LuaScriptRaisedBuiltEventFilter | LuaPrePlayerMinedEntityEventFilter | LuaPlayerRepairedEntityEventFilter | LuaUpgradeCancelledEventFilter | LuaSectorScannedEventFilter | LuaPostEntityDiedEventFilter | LuaEntityMarkedForDeconstructionEventFilter | LuaPlayerMinedEntityEventFilter | LuaEntityDamagedEventFilter | LuaScriptRaisedReviveEventFilter | LuaEntityDiedEventFilter | LuaPreRobotMinedEntityEventFilter)[];
+type EventFilter = (LuaScriptRaisedTeleportedEventFilter | LuaPreRobotMinedEntityEventFilter | LuaScriptRaisedBuiltEventFilter | LuaPlatformMinedEntityEventFilter | LuaRobotBuiltEntityEventFilter | LuaPrePlayerMinedEntityEventFilter | LuaEntityDeconstructionCancelledEventFilter | LuaPreGhostUpgradedEventFilter | LuaPlatformBuiltEntityEventFilter | LuaPrePlatformMinedEntityEventFilter | LuaEntityClonedEventFilter | LuaPlayerRepairedEntityEventFilter | LuaPostEntityDiedEventFilter | LuaPreGhostDeconstructedEventFilter | LuaPlayerMinedEntityEventFilter | LuaSectorScannedEventFilter | LuaRobotMinedEntityEventFilter | LuaEntityMarkedForDeconstructionEventFilter | LuaScriptRaisedReviveEventFilter | LuaPlayerBuiltEntityEventFilter | LuaUpgradeCancelledEventFilter | LuaEntityDamagedEventFilter | LuaEntityDiedEventFilter | LuaEntityMarkedForUpgradeEventFilter | LuaScriptRaisedDestroyEventFilter)[];
 /**
  * Identifies a statistics prototype, depending on the statistics type.
  */
@@ -5869,7 +5869,7 @@ type PropertyExpressionNames = Record<string, string>;
  *
  * Filters are always used as an array of filters of a specific type. Every filter can only be used with its corresponding event, and different types of event filters can not be mixed.
  */
-type PrototypeFilter = (ModSettingPrototypeFilter | TilePrototypeFilter | DecorativePrototypeFilter | RecipePrototypeFilter | AchievementPrototypeFilter | TechnologyPrototypeFilter | AsteroidChunkPrototypeFilter | ItemPrototypeFilter | EquipmentPrototypeFilter | EntityPrototypeFilter | SpaceLocationPrototypeFilter | FluidPrototypeFilter)[];
+type PrototypeFilter = (ModSettingPrototypeFilter | SpaceLocationPrototypeFilter | DecorativePrototypeFilter | TilePrototypeFilter | AsteroidChunkPrototypeFilter | ItemPrototypeFilter | TechnologyPrototypeFilter | RecipePrototypeFilter | AchievementPrototypeFilter | EquipmentPrototypeFilter | FluidPrototypeFilter | EntityPrototypeFilter)[];
 type PrototypeFilterMode = 'none' | 'whitelist' | 'blacklist';
 interface PrototypeHistory {
     /**

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.42
+// Factorio version 2.0.44
 // 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.42
+// Factorio version 2.0.44
 // API version 6
 
 declare namespace defines {
@@ -65,7 +65,7 @@ enum cargo_destination {
      */
     station = 2,
     /**
-     * Cargo pods will switch destination type from surface to station before starting descent if there is a station available and {@link CargoDestination::position | runtime:CargoDestination::position} has not been specified.
+     * Cargo pods will switch destination type from surface to station before starting descent if there is a station available and {@link CargoDestination::position | runtime:CargoDestination::position} has not been specified. Note, setting the destination to "surface" when the surface is the same as the one the pod is on forces it to find and set a landing position.
      */
     surface = 3
 }
@@ -1292,13 +1292,24 @@ enum inventory {
     turret_ammo = 42
 }
 enum logistic_member_index {
-    character_provider = 4,
-    character_requester = 2,
-    character_storage = 3,
-    generic_on_off_behavior = 5,
+    car_provider = 10,
+    car_requester = 9,
+    character_provider = 5,
+    character_requester = 3,
+    character_storage = 4,
+    generic_on_off_behavior = 6,
     logistic_container = 0,
-    spidertron_requester = 6,
-    vehicle_storage = 1
+    logistic_container_trash_provider = 1,
+    roboport_provider = 11,
+    roboport_requester = 12,
+    rocket_silo_provider = 13,
+    rocket_silo_requester = 14,
+    rocket_silo_trash_provider = 15,
+    space_platform_hub_provider = 17,
+    space_platform_hub_requester = 16,
+    spidertron_provider = 8,
+    spidertron_requester = 7,
+    vehicle_storage = 2
 }
 enum logistic_mode {
     active_provider = 1,

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.42
+// Factorio version 2.0.44
 // 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.42
+// Factorio version 2.0.44
 // 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.42
+// Factorio version 2.0.44
 // API version 6
 
 declare namespace prototype {
@@ -196,6 +196,10 @@ interface AirbornePollutantPrototype extends Prototype {
      */
     affects_water_tint: boolean;
     chart_color: Color;
+    /**
+     * If true, trees will occasionally take damage from this pollutant type. When they do, some amount of pollution is removed from the chunk equal to the map's `pollution_restored_per_tree_damage` setting.
+     */
+    damages_trees?: boolean;
     icon: Sprite;
     /**
      * The translated plural string key to use when displaying this pollution's name with an amount. See {@link Tutorial:Localisation | https://wiki.factorio.com/Tutorial:Localisation}.
@@ -2470,6 +2474,10 @@ interface DecorativePrototype extends Prototype {
     decal_overdraw_priority?: uint16;
     grows_through_rail_path?: boolean;
     minimal_separation?: double;
+    /**
+     * Loaded only if `render_layer` = "decals". Value lower than 1 enables masking by water for decals with `tile_layer` greater or equal to {@link UtilityConstants::capture_water_mask_at_layer | prototype:UtilityConstants::capture_water_mask_at_layer}. Water tiles must use water `tile-effect` with {@link WaterTileEffectParameters::lightmap_alpha | prototype:WaterTileEffectParameters::lightmap_alpha} set to 0 or value less than 1. Graphics option `Occlude light sprites` must be enabled, as water mask is captured into terrain lightmap alpha channel. Tiles rendered in layer between {@link UtilityConstants::capture_water_mask_at_layer | prototype:UtilityConstants::capture_water_mask_at_layer} and decal's `tile_layer` will likely also mask decals in some way, as water mask will likely be 0 at their position, but this is considered undefined behavior.
+     */
+    opacity_over_water?: float;
     /**
      * Must contain at least 1 picture.
      */
@@ -2489,7 +2497,7 @@ interface DecorativePrototype extends Prototype {
     stateless_visualisation_variations?: StatelessVisualisations[];
     target_count?: uint16;
     /**
-     * Mandatory if `render_layer` = "decals". This int16 is converted to a {@link RenderLayer | prototype:RenderLayer} internally.
+     * Mandatory if `render_layer` = "decals". This int16 is converted to a {@link TileRenderLayer | prototype:TileRenderLayer} internally. It is offset from `ground-natural`.
      */
     tile_layer?: int16;
     /**
@@ -4069,6 +4077,10 @@ interface FusionReactorPrototype extends EntityWithOwnerPrototype {
      * Cannot be negative.
      */
     power_input: Energy;
+    /**
+     * The temperature of the fluid to output. If not defined, the default temperature of the output fluid will be used.
+     */
+    target_temperature?: float;
     /**
      * If set to true, only North and East direction will be buildable.
      */
@@ -7256,6 +7268,7 @@ interface RocketSiloPrototype extends AssemblingMachinePrototype {
      * Drawn instead of `base_day_sprite` during the night, that is when {@link LuaSurface::darkness | runtime:LuaSurface::darkness} is larger than 0.3.
      */
     base_night_sprite?: Sprite;
+    can_launch_without_landing_pads?: boolean;
     /**
      * Must have exactly one entry in {@link CargoStationParameters::hatch_definitions | prototype:CargoStationParameters::hatch_definitions}.
      */
@@ -9677,6 +9690,10 @@ interface UtilityConstants extends PrototypeBase {
     building_no_tint: Color;
     building_not_buildable_tint: Color;
     capsule_range_visualization_color: Color;
+    /**
+     * Layer within `ground-natural` {@link tile render layer | prototype:TileRenderLayer} group, before which terrain lightmap alpha channel is copiend into water mask. Decals, which need to be masked by water should have their {@link DecorativePrototype::tile_layer | prototype:DecorativePrototype::tile_layer} set to only slightly larger value than `capture_water_mask_at_layer`, to avoid risk of undefined behavior caused by rendering tiles into layers between `capture_water_mask_at_layer` and decal's `tile_layer`.
+     */
+    capture_water_mask_at_layer: uint8;
     /**
      * Chart means map and minimap.
      */
@@ -9875,9 +9892,13 @@ interface UtilityConstants extends PrototypeBase {
      */
     space_platform_acceleration_expression: MathExpression;
     /**
-     * Determines how fast space platforms will send items in trash slots to the surface. Each item type has its own cooldown.
+     * Determines how fast space platforms will send items in drop slots to the surface. Each item type has its own cooldown.
      */
     space_platform_dump_cooldown: uint32;
+    /**
+     * Delay after manual transfer until space platform sends items in drop slots to the surface. Overrides remaining space_platform_dump_cooldown in this instance.
+     */
+    space_platform_manual_dump_cooldown: uint32;
     space_platform_max_size: SimpleBoundingBox;
     space_platform_relative_speed_factor: double;
     space_platform_starfield_movement_vector: Vector;
@@ -10307,6 +10328,7 @@ interface UtilitySprites extends PrototypeBase {
     entity_info_dark_background: Sprite;
     equipment_collision: Sprite;
     equipment_grid: Sprite;
+    equipment_grid_small: Sprite;
     equipment_slot: Sprite;
     expand: Sprite;
     expand_dots: 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.42
+// Factorio version 2.0.44
 // API version 6
 
 declare namespace prototype {
@@ -5955,19 +5955,26 @@ interface MainSound {
      * Can't be used when `match_progress_to_activity` is `true`.
      */
     fade_out_ticks?: uint32;
-    match_progress_to_activity?: boolean;
-    match_speed_to_activity?: boolean;
-    match_volume_to_activity?: boolean;
+    /**
+     * Unused when {@link WorkingSound::persistent | prototype:WorkingSound::persistent} is `true`.
+     */
+    match_progress_to_activity?: bool;
+    match_speed_to_activity?: bool;
+    match_volume_to_activity?: bool;
     /**
      * Array of {@link WorkingVisualisation::name | prototype:WorkingVisualisation::name}s, individual names cannot be empty.
      *
      * The `sound` is played when at least one of the specified working visualisations is drawn.
+     *
+     * Unused when {@link WorkingSound::persistent | prototype:WorkingSound::persistent} is `true`.
      */
     play_for_working_visualisations?: string[];
     /**
      * Modifies how often the sound is played.
      *
      * Silently clamped to the [0.0, 1.0] range.
+     *
+     * Unused when {@link WorkingSound::persistent | prototype:WorkingSound::persistent} is `true`.
      * @example ```
     probability = 1 / (3 * 60) -- average pause between the sound is 3 seconds
     ```
@@ -9787,6 +9794,10 @@ interface SpriteParameters extends SpriteSource {
      * Only loaded if this is an icon, that is it has the flag `"group=icon"` or `"group=gui"`. Will be clamped to range `[0, 5]`.
      */
     mipmap_count?: uint8;
+    /**
+     * Loaded only if `draw_as_shadow`, `draw_as_glow` and `draw_as_light` are `false`, and only by sprites used by tile renderer (decals and underwater patches). Purspose of setting this to `false` is to preserve water mask from sprites that are supposed to be drawn under the water.
+     */
+    occludes_light?: bool;
     priority?: SpritePriority;
     /**
      * Whether to rotate the `shift` alongside the sprite's rotation. This only applies to sprites which are procedurally rotated by the game engine (like projectiles, wires, inserter hands, etc).
@@ -10966,6 +10977,10 @@ interface TileTransitions {
     auxiliary_effect_mask_spritesheet?: FileName;
     background_enabled?: boolean;
     background_layer_group?: TileRenderLayer;
+    /**
+     * If drawing under water which is supposed to yield water mask, set this to `false` to not mess up the water mask.
+     */
+    background_layer_occludes_light?: boolean;
     background_layer_offset?: int8;
     /**
      * Overrides the `background` definition inside `layout`.
@@ -12499,6 +12514,10 @@ interface WaterTileEffectParameters {
     far_zoom?: float;
     foam_color: Color;
     foam_color_multiplier: float;
+    /**
+     * Value 0 makes water appear as water in water mask, but does not occlude lights, and doesn't overwrite lightmap alpha drawn to pixel previously (by background layer of tile transition, or underwater sprite). Light emitted by water-like-tile (for example lava) will blend additively with previously rendered light. Value 1 makes water occlude lights, but won't be recognized as water in water mask used for masking decals by water.
+     */
+    lightmap_alpha?: float;
     near_zoom?: float;
     reflection_threshold: float | [
         float,
@@ -12595,18 +12614,26 @@ working_sound =
 type WorkingSound = {
     /**
      * Might not work with all entities that use working_sound.
+     *
+     * Unused when `persistent` is `true`.
      */
     activate_sound?: Sound;
     /**
      * Might not work with all entities that use working_sound.
+     *
+     * Unused when `persistent` is `true`.
      */
     deactivate_sound?: Sound;
     /**
-     * If `true`, `max_sounds_per_prototype` is ignored. 'extra sound' refers to `idle_sound`, `activate_sound` or `deactivate_sound`.
+     * If `true`, entities playing their extra sound don't count towards `max_sounds_per_prototype` limit. 'extra sound' refers to `idle_sound`, `activate_sound` or `deactivate_sound`.
+     *
+     * Unused when `persistent` is `true`.
      */
-    extra_sounds_ignore_limit?: boolean;
+    extra_sounds_ignore_limit?: bool;
     /**
      * The sound to be played when the entity is idle. Might not work with all entities that use working_sound.
+     *
+     * Unused when `persistent` is `true`.
      */
     idle_sound?: Sound;
     /**
@@ -12619,14 +12646,19 @@ type WorkingSound = {
      * Inactive entities without an `idle_sound` don't count towards this limit.
      *
      * Entities with their working sound fading out don't count towards this limit.
+     *
+     * Unused when `persistent` is `true`.
      */
     max_sounds_per_prototype?: uint8;
     /**
-     * When `true`, working sounds for all entities of the same prototype are combined into one and some (most) properties of this are ignored or unused.
+     * When `true`, working sounds for all entities of the same prototype are combined into one.
+     */
+    persistent?: bool;
+    /**
+     * Unused when `persistent` is `true`.
      */
-    persistent?: boolean;
     sound_accents?: SoundAccent | SoundAccent[];
-    use_doppler_shift?: boolean;
+    use_doppler_shift?: bool;
 } | Sound;
 /**
  * Used by crafting machines to display different graphics when the machine is running.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.29",
+  "version": "1.2.31",
   "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.42",
+  "factorioVersion": "2.0.44",
   "dependencies": {
     "lua-types": "^2.13.1"
   },