factorio-types 1.2.21 → 1.2.22

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.30
+// Factorio version 2.0.31
 // API version 6
 
 declare namespace runtime {
@@ -4189,7 +4189,7 @@ interface LuaBootstrap {
      * Depending on when a given object is destroyed, {@link on_object_destroyed | runtime:on_object_destroyed} will either be fired at the end of the current tick or at the end of the next tick.
      * @param object The object to register.
      * @returns [0] - The registration number. It is used to identify the object in the {@link on_object_destroyed | runtime:on_object_destroyed} event.
-     * @returns [1] - Useful identifier of the object if it has one. This identifier is specific to the object type, for example for trains it is the value {@link LuaTrain::id | runtime:LuaTrain::id}.
+     * @returns [1] - The {@link useful identifier | runtime:RegistrationTarget} of the object if it has one. This identifier is specific to the object type, for example for trains it is the value {@link LuaTrain::id | runtime:LuaTrain::id}.
      * @returns [2] - Type of the target object.
      */
     register_on_object_destroyed(this: void, object: RegistrationTarget): LuaMultiReturn<[
@@ -10531,11 +10531,11 @@ interface LuaGuiElement {
      *
      * The `"signal"` type operates with {@link SignalID | runtime:SignalID}.
      *
-     * The `"with-quality"` types operate with `"name"` and optional `"quality"`
+     * The `"with-quality"` types operate with {@link PrototypeWithQuality | runtime:PrototypeWithQuality}.
      *
      * The remaining types use strings.
      */
-    elem_value?: string | SignalID | table;
+    elem_value?: string | SignalID | PrototypeWithQuality;
     /**
      * Whether this GUI element is enabled. Disabled GUI elements don't trigger events when clicked.
      */
@@ -10911,7 +10911,7 @@ interface LuaGuiElementAddParamsChooseElemButton extends BaseLuaGuiElementAddPar
     /**
      * If type is `"entity-with-quality"` - the default value for the button.
      */
-    'entity-with-quality'?: string;
+    'entity-with-quality'?: PrototypeWithQuality;
     /**
      * If type is `"equipment"` - the default value for the button.
      */
@@ -10919,7 +10919,7 @@ interface LuaGuiElementAddParamsChooseElemButton extends BaseLuaGuiElementAddPar
     /**
      * If type is `"equipment-with-quality"` - the default value for the button.
      */
-    'equipment-with-quality'?: string;
+    'equipment-with-quality'?: PrototypeWithQuality;
     /**
      * If type is `"fluid"` - the default value for the button.
      */
@@ -10935,7 +10935,7 @@ interface LuaGuiElementAddParamsChooseElemButton extends BaseLuaGuiElementAddPar
     /**
      * If type is `"item-with-quality"` - the default value for the button.
      */
-    'item-with-quality'?: string;
+    'item-with-quality'?: PrototypeWithQuality;
     /**
      * If type is `"recipe"` - the default value for the button.
      */
@@ -10943,7 +10943,7 @@ interface LuaGuiElementAddParamsChooseElemButton extends BaseLuaGuiElementAddPar
     /**
      * If type is `"recipe-with-quality"` - the default value for the button.
      */
-    'recipe-with-quality'?: string;
+    'recipe-with-quality'?: PrototypeWithQuality;
     /**
      * If type is `"signal"` - the default value for the button.
      */
@@ -13403,7 +13403,7 @@ interface LuaPlayer extends LuaControl {
      */
     clear_recipe_notifications(this: void): void;
     /**
-     * Clears the players selection tool selection position.
+     * Clears the player's selection tool selection position.
      */
     clear_selection(this: void): void;
     /**
@@ -13431,7 +13431,7 @@ interface LuaPlayer extends LuaControl {
     /**
      * Spawn flying text that is only visible to this player. Either `position` or `create_at_cursor` are required. When `create_at_cursor` is `true`, all parameters other than `text` are ignored.
      *
-     * If no custom `speed` is set and the text is longer than 25 characters, its `time_to_live` and `speed` are dynamically adjusted to give players more time to read it.
+     * If no custom `speed` is set and the text is longer than 25 characters, its `time_to_live` and `speed` are dynamically adjusted to give the player more time to read it.
      *
      * Local flying text is not saved, which means it will disappear after a save/load-cycle.
      * @param table.text The flying text to show.
@@ -13610,7 +13610,7 @@ interface LuaPlayer extends LuaControl {
      */
     print_lua_object_statistics(this: void): void;
     /**
-     * Print construction robot job counts to the players console.
+     * Print construction robot job counts to the player's console.
      */
     print_robot_jobs(this: void): void;
     /**
@@ -13653,7 +13653,7 @@ interface LuaPlayer extends LuaControl {
      * @param table.character Entity to control. Mandatory when `type` is {@link defines.controllers.character | runtime:defines.controllers.character}, ignored otherwise.
      * @param table.waypoints List of waypoints for the cutscene controller. This parameter is mandatory when `type` is {@link defines.controllers.cutscene | runtime:defines.controllers.cutscene}.
      * @param table.start_position If specified and `type` is {@link defines.controllers.cutscene | runtime:defines.controllers.cutscene}, the cutscene will start at this position. If not given the start position will be the player position.
-     * @param table.start_zoom If specified and `type` is {@link defines.controllers.cutscene | runtime:defines.controllers.cutscene}, the cutscene will start at this zoom level. If not given the start zoom will be the players zoom.
+     * @param table.start_zoom If specified and `type` is {@link defines.controllers.cutscene | runtime:defines.controllers.cutscene}, the cutscene will start at this zoom level. If not given the start zoom will be the player's zoom.
      * @param table.final_transition_time If specified and `type` is {@link defines.controllers.cutscene | runtime:defines.controllers.cutscene}, it is the time in ticks it will take for the camera to pan from the final waypoint back to the starting position. If not given the camera will not pan back to the start position/zoom.
      * @param table.chart_mode_cutoff If specified and `type` is {@link defines.controllers.cutscene | runtime:defines.controllers.cutscene}, the game will switch to chart-mode (map zoomed out) rendering when the zoom level is less than this value.
      * @param table.position If specified and `type` is {@link defines.controllers.remote | runtime:defines.controllers.remote}, the position the remote controller will be centered on.
@@ -13705,7 +13705,7 @@ interface LuaPlayer extends LuaControl {
      */
     set_shortcut_toggled(this: void, prototype_name: string, toggled: boolean): void;
     /**
-     * Starts selection with selection tool from the specified position. Does nothing if the players cursor is not a selection tool.
+     * Starts selection with selection tool from the specified position. Does nothing if the player's cursor is not a selection tool.
      * @param position The position to start selection from.
      * @param selection_mode The type of selection to start.
      */
@@ -13882,21 +13882,21 @@ interface LuaPlayer extends LuaControl {
      */
     readonly physical_controller_type: defines.controllers;
     /**
-     * The current position of this players physical controller.
+     * The current position of this player's physical controller.
      */
     readonly physical_position: MapPosition;
     /**
-     * The surface this players physical controller is on.
+     * The surface this player's physical controller is on.
      */
     readonly physical_surface: LuaSurface;
     /**
-     * Unique ID associated with the surface this players physical controller is currently on.
+     * Unique ID associated with the surface this player's physical controller is currently on.
      */
     readonly physical_surface_index: uint;
     /**
-     * The current vehicle of this players physical controller.
+     * The current vehicle of this player's physical controller.
      */
-    readonly physical_vehicle: MapPosition;
+    readonly physical_vehicle?: LuaEntity;
     /**
      * If items not included in this map editor infinity inventory filters should be removed.
      */

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.30
+// Factorio version 2.0.31
 // API version 6
 
 declare namespace runtime {
@@ -5797,6 +5797,16 @@ interface PrototypeHistory {
      */
     changed: string[];
 }
+interface PrototypeWithQuality {
+    /**
+     * Name of a prototype.
+     */
+    name: string;
+    /**
+     * Name of a quality prototype. Always defined when reading, defaults to "normal" when writing.
+     */
+    quality?: string;
+}
 /**
  * An item filter may be specified in two ways, either as a string which is a quality prototype name or as a table.
  */
@@ -6105,7 +6115,7 @@ LuaLogisticCell | /**
  * Target type {@link logistic_network | runtime:defines.target_type.logistic_network}; `useful_id` {@link LuaLogisticNetwork::network_id | runtime:LuaLogisticNetwork::network_id}
  */
 LuaLogisticNetwork | /**
- * Target type {@link logistic_section | runtime:defines.target_type.logistic_section};
+ * Target type {@link logistic_section | runtime:defines.target_type.logistic_section}
  */
 LuaLogisticSection | /**
  * Target type {@link permission_group | runtime:defines.target_type.permission_group}; `useful_id` {@link LuaPermissionGroup::group_id | runtime:LuaPermissionGroup::group_id}
@@ -6117,7 +6127,7 @@ LuaPlanet | /**
  * Target type {@link player | runtime:defines.target_type.player}; `useful_id` {@link LuaPlayer::index | runtime:LuaPlayer::index}
  */
 LuaPlayer | /**
- * Target type {@link rail_path | runtime:defines.target_type.rail_path};
+ * Target type {@link rail_path | runtime:defines.target_type.rail_path}
  */
 LuaRailPath | /**
  * Target type {@link render_object | runtime:defines.target_type.render_object}; `useful_id` {@link LuaRenderObject::id | runtime:LuaRenderObject::id}

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.30
+// Factorio version 2.0.31
 // 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.30
+// Factorio version 2.0.31
 // 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.30
+// Factorio version 2.0.31
 // API version 6
 
 declare namespace runtime {
@@ -1444,7 +1444,7 @@ interface on_object_destroyed {
      */
     type: defines.target_type;
     /**
-     * Useful identifier of the object. Same as second value returned by {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}
+     * The {@link useful identifier | runtime:RegistrationTarget} of the object. Same as second value returned by {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}
      */
     useful_id: uint64;
 }

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.30
+// Factorio version 2.0.31
 // 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.30
+// Factorio version 2.0.31
 // API version 6
 
 declare namespace prototype {
@@ -1206,7 +1206,7 @@ interface BurnerGeneratorPrototype extends EntityWithOwnerPrototype {
      */
     max_power_output: Energy;
     /**
-     * Affects animation speed.
+     * Affects animation speed and working sound.
      */
     perceived_performance?: PerceivedPerformance;
 }
@@ -1728,7 +1728,7 @@ interface ConstantCombinatorPrototype extends EntityWithOwnerPrototype {
     /**
      * When not zero, toggle entity will enable constant combinator for that amount of ticks and then turn it off.
      */
-    pulse_duration?: uint;
+    pulse_duration?: uint32;
     sprites?: Sprite4Way;
 }
 /**
@@ -3971,7 +3971,7 @@ interface FusionGeneratorPrototype extends EntityWithOwnerPrototype {
      */
     output_fluid_box: FluidBox;
     /**
-     * Affects animation speed.
+     * Affects animation speed and working sound.
      */
     perceived_performance?: PerceivedPerformance;
 }
@@ -4012,7 +4012,7 @@ interface FusionReactorPrototype extends EntityWithOwnerPrototype {
      */
     output_fluid_box: FluidBox;
     /**
-     * Affects animation speed.
+     * Affects working sound.
      */
     perceived_performance?: PerceivedPerformance;
     /**
@@ -4118,7 +4118,7 @@ interface GeneratorPrototype extends EntityWithOwnerPrototype {
      */
     maximum_temperature: float;
     /**
-     * Affects animation speed.
+     * Affects animation speed and working sound.
      */
     perceived_performance?: PerceivedPerformance;
     /**
@@ -4583,9 +4583,6 @@ interface ItemPrototype extends Prototype {
     spoil_level?: uint8;
     spoil_result?: ItemID;
     spoil_ticks?: uint32;
-    /**
-     * Only loaded if `spoil_result` is not defined.
-     */
     spoil_to_trigger_result?: SpoilToTriggerResult;
     /**
      * Count of items of the same name that can be stored in one inventory slot. Must be 1 when the `"not-stackable"` flag is set.

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.30
+// Factorio version 2.0.31
 // API version 6
 
 declare namespace prototype {
@@ -88,11 +88,21 @@ interface AdvancedMapGenSettings {
     pollution?: MapGenPresetPollutionSettings;
 }
 interface AdvancedVolumeControl {
+    /**
+     * Volume reduction (fade-out) controlled by distance (fraction of audible distance).
+     */
     attenuation?: Fade;
     /**
-     * Has to be in the range (-1.0, 1.0).
+     * Has to be in the range [-1.0, 1.0].
+     *
+     * Positive values are used for night sounds, the volume of the sound is 1.0 when darkness = threshold, 0.0 when darkness = 0.0 and linearly interpolated in between.
+     *
+     * Negative values are used for day sounds, the sound of the sound is 0.0  when darkness = -threshold, 1.0 when darkness = 1.0 and linearly interpolated in between.
      */
     darkness_threshold?: float;
+    /**
+     * Volume reduction (fade-out) or increase (fade-in) controlled by zoom level.
+     */
     fades?: Fades;
 }
 interface AggregationSpecification {
@@ -6932,12 +6942,23 @@ interface PathFinderSettings {
     start_to_goal_cost_multiplier_to_terminate_path_find: double;
     use_path_cache: bool;
 }
+/**
+ * Not all prototypes that use this type are affected by all properties.
+ */
 interface PerceivedPerformance {
+    /**
+     * Affects animation speed.
+     */
     maximum?: double;
     /**
+     * Affects animation speed.
+     *
      * Must be less than or equal to `maximum`.
      */
     minimum?: double;
+    /**
+     * Affects {@link MainSound | prototype:MainSound} if {@link MainSound::match_progress_to_activity | prototype:MainSound::match_progress_to_activity}, {@link MainSound::match_volume_to_activity | prototype:MainSound::match_volume_to_activity} or {@link MainSound::match_speed_to_activity | prototype:MainSound::match_speed_to_activity} is `true`.
+     */
     performance_to_activity_rate?: double;
 }
 type PersistentWorldAmbientSoundDefinition = {

package/package.json

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