factorio-types 1.2.22 → 1.2.24

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.31
+// Factorio version 2.0.33
 // API version 6
 
 declare namespace runtime {
@@ -7336,6 +7336,10 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * The maximum wire distance for this entity. 0 if the entity doesn't support wires.
      */
     get_max_wire_distance(this: void, quality?: QualityID): double;
+    /**
+     * The pumping speed of this offshore or normal pump.
+     */
+    get_pumping_speed(this: void, quality?: QualityID): double;
     /**
      * The base researching speed of this lab prototype.
      */
@@ -8041,7 +8045,7 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      */
     readonly protected_from_tile_building: boolean;
     /**
-     * The pumping speed of this offshore or normal pump.
+     * The pumping speed of this offshore or normal pump. This property is deprecated in favor of {@link LuaEntityPrototype::get_pumping_speed | runtime:LuaEntityPrototype::get_pumping_speed} and should not be used.
      */
     readonly pumping_speed?: double;
     /**
@@ -10078,7 +10082,7 @@ interface LuaGameScript {
     /**
      * Current map tick.
      */
-    readonly tick: uint;
+    readonly tick: MapTick;
     /**
      * If the tick has been paused. This means that entity update has been paused.
      */
@@ -10088,7 +10092,7 @@ interface LuaGameScript {
      *
      * This differs from {@link LuaGameScript::tick | runtime:LuaGameScript::tick} in that creating a game from a scenario always starts with this value at `0`, even if the scenario has its own level data where the `tick` has progressed past `0`.
      */
-    readonly ticks_played: uint;
+    readonly ticks_played: MapTick;
     /**
      * The number of ticks to be run while the tick is paused.
      *
@@ -10343,7 +10347,7 @@ interface LuaGuiElement {
     /**
      * Removes the given tab and its associated content from this tabbed pane.
      *
-     * Removing a tab does not destroy the tab or the tab contents. It just removes them from the view. When removing tabs, {@link LuaGuiElement::selected_tab_index | runtime:LuaGuiElement::selected_tab_index} needs to be manually updated.
+     * Removing a tab does not destroy the tab or the tab contents. It just removes them from the view.
      * @param tab The tab to remove or `nil` to remove all tabs.
      */
     remove_tab(this: void, tab?: LuaGuiElement): void;
@@ -12470,7 +12474,7 @@ interface LuaItemStack extends LuaItemCommon {
     /**
      * The tick this item spoils, or `0` if it does not spoil. When writing, setting to anything < the current game tick will spoil the item instantly.
      */
-    spoil_tick: uint;
+    spoil_tick: MapTick;
     /**
      * Type of the item prototype.
      */
@@ -13436,6 +13440,7 @@ interface LuaPlayer extends LuaControl {
      * Local flying text is not saved, which means it will disappear after a save/load-cycle.
      * @param table.text The flying text to show.
      * @param table.position The location on the map at which to show the flying text.
+     * @param table.surface The surface which this text will be shown on. Defaults to player surface.
      * @param table.create_at_cursor If `true`, the flying text is created at the player's cursor. Defaults to `false`.
      * @param table.color The color of the flying text. Defaults to white text.
      * @param table.time_to_live The amount of ticks that the flying text will be shown for. Defaults to `80`.
@@ -13444,6 +13449,7 @@ interface LuaPlayer extends LuaControl {
     create_local_flying_text(this: void, table: {
         text: LocalisedString;
         position?: MapPosition;
+        surface?: SurfaceIdentification;
         create_at_cursor?: boolean;
         color?: Color;
         time_to_live?: uint;
@@ -13902,7 +13908,7 @@ interface LuaPlayer extends LuaControl {
      */
     remove_unfiltered_items: boolean;
     /**
-     * The render mode of the player, like map or zoom to world. The render mode can be set using {@link LuaPlayer::open_map | runtime:LuaPlayer::open_map}, {@link LuaPlayer::zoom_to_world | runtime:LuaPlayer::zoom_to_world} and {@link LuaPlayer::close_map | runtime:LuaPlayer::close_map}.
+     * The render mode of the player, like map or zoom to world.
      */
     readonly render_mode: defines.render_mode;
     /**

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.31
+// Factorio version 2.0.33
 // API version 6
 
 declare namespace runtime {
@@ -5587,6 +5587,7 @@ interface PipeConnectionDefinition {
     max_underground_distance?: uint;
     flow_direction: 'input-output' | 'input' | 'output';
     direction: defines.direction;
+    connection_category: string[];
     /**
      * Only supplied if `connection_type` is `"linked"`.
      */

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.31
+// Factorio version 2.0.33
 // 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.31
+// Factorio version 2.0.33
 // API version 6
 
 declare namespace defines {
@@ -1185,6 +1185,9 @@ enum input_method {
 enum inventory {
     artillery_turret_ammo = 43,
     artillery_wagon_ammo = 44,
+    /**
+     * Used when items are ejected or items held by inserters cannot be inserted due to changing the recipe with the circuit network.
+     */
     assembling_machine_dump = 25,
     assembling_machine_input = 22,
     assembling_machine_modules = 24,

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.31
+// Factorio version 2.0.33
 // 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.31
+// Factorio version 2.0.33
 // 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.31
+// Factorio version 2.0.33
 // API version 6
 
 declare namespace prototype {
@@ -57,7 +57,7 @@ declare namespace prototype {
       }
     },
     idle_sound = {filename = "__base__/sound/accumulator-idle.ogg", volume = 0.35},
-    max_sounds_per_type = 3,
+    max_sounds_per_prototype = 3,
     audible_distance_modifier = 0.5
   },
 
@@ -3765,6 +3765,7 @@ interface FluidStreamPrototype extends EntityPrototype {
     special_neutral_target_damage?: DamageParameters;
     spine_animation?: Animation;
     stream_light?: LightDefinition;
+    target_initial_position_only?: bool;
     target_position_deviation?: double;
     width?: float;
 }
@@ -4170,6 +4171,10 @@ interface GroupAttackAchievementPrototype extends AchievementPrototype {
     ```
      */
     amount?: uint32;
+    /**
+     * The type of attack that triggers this achievement. "autonomous" attacks are triggered in response to pollution or a territory disturbance. "distraction" attacks are in response to taking damage or seeing a nearby enemy. "scripted" attacks are triggered from mods.
+     */
+    attack_type?: 'autonomous' | 'distraction' | 'scripted';
     /**
      * The achievement is only triggered if the attacking group of enemies contains at least one of the entities listed here.
      */

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.31
+// Factorio version 2.0.33
 // API version 6
 
 declare namespace prototype {
@@ -3341,6 +3341,7 @@ interface CreateTrivialSmokeEffectItem extends TriggerEffectItem {
     max_radius?: float;
     offset_deviation?: BoundingBox;
     offsets?: Vector[];
+    only_when_visible?: float;
     smoke_name: TrivialSmokeID;
     speed?: Vector;
     speed_from_center?: float;
@@ -5925,10 +5926,6 @@ interface LowPowerTipTrigger extends CountBasedTipTrigger {
 interface MainSound {
     activity_to_speed_modifiers?: ActivityMatchingModifiers;
     activity_to_volume_modifiers?: ActivityMatchingModifiers;
-    /**
-     * Modifies how far a sound can be heard. Can only be 1 or lower, has to be a positive number.
-     */
-    audible_distance_modifier?: double;
     /**
      * Can't be used when `match_progress_to_activity` is `true`.
      */
@@ -5940,6 +5937,11 @@ interface MainSound {
     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.
+     */
     play_for_working_visualisations?: string[];
     /**
      * Modifies how often the sound is played.
@@ -7207,10 +7209,6 @@ type PlayFor = /**
  */
 'everything';
 interface PlaySoundTriggerEffectItem extends TriggerEffectItem {
-    /**
-     * Negative values are silently clamped to 0.
-     */
-    audible_distance_modifier?: float;
     /**
      * Negative values are silently clamped to 0.
      */
@@ -7222,10 +7220,6 @@ interface PlaySoundTriggerEffectItem extends TriggerEffectItem {
     play_on_target_position?: bool;
     sound: Sound;
     type: 'play-sound';
-    /**
-     * Negative values are silently clamped to 0.
-     */
-    volume_modifier?: float;
 }
 interface PlayerColorData {
     chat_color: Color;
@@ -9076,7 +9070,7 @@ type Sound = {
     aggregation?: AggregationSpecification;
     allow_random_repeat?: bool;
     /**
-     * Modifies how far a sound can be heard. Must be between `0` and `1` inclusive.
+     * Modifies how far a sound can be heard. Cannot be less than zero.
      */
     audible_distance_modifier?: double;
     category?: SoundType;
@@ -9145,9 +9139,13 @@ type Sound = {
     volume?: float;
 } | SoundDefinition[];
 interface SoundAccent {
-    audible_distance_modifier?: float;
     frame?: uint16;
-    play_for_working_visualisations?: string[];
+    /**
+     * Play the `sound` for a working visualisation of a given {@link WorkingVisualisation::name | prototype:WorkingVisualisation::name}.
+     *
+     * The name cannot be empty.
+     */
+    play_for_working_visualisation?: string;
     sound?: Sound;
 }
 type SoundDefinition = {
@@ -12532,18 +12530,16 @@ interface WorkerRobotStorageModifier extends SimpleModifier {
 -- refinery
 working_sound =
 {
-  sound = { filename = "__base__/sound/oil-refinery.ogg" },
-  idle_sound = { filename = "__base__/sound/idle1.ogg", volume = 0.6 },
-  apparent_volume = 2.5,
+  sound = {filename = "__base__/sound/oil-refinery.ogg"},
+  idle_sound = {filename = "__base__/sound/idle1.ogg", volume = 0.6},
 }
 ```
  * @example ```
 -- roboport
 working_sound =
 {
-  sound = { filename = "__base__/sound/roboport-working.ogg", volume = 0.6 },
-  max_sounds_per_type = 3,
-  audible_distance_modifier = 0.5,
+  sound = {filename = "__base__/sound/roboport-working.ogg", volume = 0.6, audible_distance_modifier = 0.5},
+  max_sounds_per_prototype = 3,
   probability = 1 / (5 * 60) -- average pause between the sound is 5 seconds
 }
 ```
@@ -12553,15 +12549,13 @@ type WorkingSound = {
      * Might not work with all entities that use working_sound.
      */
     activate_sound?: Sound;
-    apparent_volume?: float;
-    /**
-     * Modifies how far a sound can be heard. Can only be 1 or lower, has to be a positive number.
-     */
-    audible_distance_modifier?: double;
     /**
      * Might not work with all entities that use working_sound.
      */
     deactivate_sound?: Sound;
+    /**
+     * If `true`, `max_sounds_per_prototype` is ignored. 'extra sound' refers to `idle_sound`, `activate_sound` or `deactivate_sound`.
+     */
     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.
@@ -12571,7 +12565,17 @@ type WorkingSound = {
      * If this property is defined, all properties inherited from MainSound (and not overridden here) are ignored.
      */
     main_sounds?: MainSound | MainSound[];
-    max_sounds_per_type?: uint8;
+    /**
+     * Sets a maximum limit on how many entities of the same prototype will play their working sound.
+     *
+     * 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.
+     */
+    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.
+     */
     persistent?: bool;
     sound_accents?: SoundAccent | SoundAccent[];
     use_doppler_shift?: bool;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.22",
+  "version": "1.2.24",
   "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.31",
+  "factorioVersion": "2.0.33",
   "dependencies": {
     "lua-types": "^2.13.1"
   },