factorio-types 1.2.47 → 1.2.48

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.65
+// Factorio version 2.0.66
 // API version 6
 
 declare namespace runtime {
@@ -89,7 +89,7 @@ interface LuaAchievementPrototype extends LuaPrototypeBase {
     readonly minimum_damage?: float;
     readonly minimum_distance?: double;
     readonly minimum_energy_produced?: double;
-    readonly module?: string[];
+    readonly module?: LuaItemPrototype[];
     readonly more_than_manually?: boolean;
     readonly not_to_kill?: LuaEntityPrototype;
     /**
@@ -6587,7 +6587,7 @@ interface LuaEntity extends LuaControl {
      */
     play_note(this: void, instrument: uint, note: uint, stop_playing_sounds?: boolean): boolean;
     /**
-     * Registers the given tree in this agricultral tower.
+     * Registers the given tree in this agricultural tower.
      *
      * If the tree is not within range of the tower it will not be registered.
      *
@@ -6633,15 +6633,15 @@ interface LuaEntity extends LuaControl {
     request_to_open(this: void, force: ForceID, extra_time?: uint): void;
     /**
      * Revive a ghost, which turns it from a ghost into a real entity or tile.
-     * @param table.return_item_request_proxy If `true` the function will return item request proxy as the third return value.
      * @param table.raise_revive If true, and an entity ghost; {@link script_raised_revive | runtime:script_raised_revive} will be called. Else if true, and a tile ghost; {@link script_raised_set_tiles | runtime:script_raised_set_tiles} will be called.
+     * @param table.overflow Items that would be deleted will be transferred to this inventory. Must be a script inventory or inventory of other entity. Inventory references obtained from proxy container are not allowed.
      * @returns [0] - Any items the new real entity collided with or `nil` if the ghost could not be revived.
      * @returns [1] - The revived entity if an entity ghost was successfully revived.
-     * @returns [2] - The item request proxy if it was requested with `return_item_request_proxy`.
+     * @returns [2] - The item request proxy if one was created.
      */
     revive(this: void, table: {
-        return_item_request_proxy?: boolean;
         raise_revive?: boolean;
+        overflow?: LuaInventory;
     }): LuaMultiReturn<[
         Record<string, uint> | null,
         LuaEntity | null,
@@ -6742,12 +6742,14 @@ interface LuaEntity extends LuaControl {
     /**
      * Revives a ghost silently, so the revival makes no sound and no smoke is created.
      * @param table.raise_revive If true, and an entity ghost; {@link script_raised_revive | runtime:script_raised_revive} will be called. Else if true, and a tile ghost; {@link script_raised_set_tiles | runtime:script_raised_set_tiles} will be called.
+     * @param table.overflow Items that would be deleted will be transferred to this inventory. Must be a script inventory or inventory of other entity. Inventory references obtained from proxy container are not allowed.
      * @returns [0] - Any items the new real entity collided with or `nil` if the ghost could not be revived.
      * @returns [1] - The revived entity if an entity ghost was successfully revived.
-     * @returns [2] - The item request proxy.
+     * @returns [2] - The item request proxy if one was created.
      */
     silent_revive(this: void, table: {
         raise_revive?: boolean;
+        overflow?: LuaInventory;
     }): LuaMultiReturn<[
         ItemWithQualityCounts,
         LuaEntity | null,
@@ -7869,6 +7871,7 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
     get_inserter_rotation_speed(this: void, quality?: QualityID): double | null;
     /**
      * Gets the base size of the given inventory on this entity or `nil` if the given inventory doesn't exist.
+     * @param quality Defaults to `"normal"`.
      */
     get_inventory_size(this: void, index: defines.inventory, quality?: QualityID): uint | null;
     /**
@@ -8389,6 +8392,14 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
     readonly held_items_offset?: float;
     readonly held_items_spread?: float;
     readonly hide_resistances?: boolean;
+    /**
+     * The definition of where and how the alt-mode icons of this entity should be drawn.
+     */
+    readonly icon_draw_specification: IconDrawSpecification;
+    /**
+     * The icon positioning for inventories of this entity, if defined.
+     */
+    readonly icons_positioning?: IconSequencePositioning[];
     /**
      * A vector of the gun prototypes of this car, spider vehicle, artillery wagon, or turret.
      */
@@ -9826,6 +9837,7 @@ interface LuaForce {
     copy_from(this: void, force: ForceID): void;
     /**
      * Creates the given group if it doesn't already exist.
+     * @param type Defaults to `defines.logistic_group_type.with_trash`.
      */
     create_logistic_group(this: void, name: string, type?: defines.logistic_group_type): void;
     /**
@@ -9841,6 +9853,7 @@ interface LuaForce {
     }): LuaSpacePlatform | null;
     /**
      * Deletes the given logistic group if it exists.
+     * @param type Defaults to `defines.logistic_group_type.with_trash`.
      */
     delete_logistic_group(this: void, name: string, type?: defines.logistic_group_type): void;
     /**
@@ -9962,10 +9975,12 @@ interface LuaForce {
     get_linked_inventory(this: void, prototype: EntityID, link_id: uint): LuaInventory | null;
     /**
      * Gets the information about the given logistic group.
+     * @param type Defaults to `defines.logistic_group_type.with_trash`.
      */
     get_logistic_group(this: void, name: string, type?: defines.logistic_group_type): LogisticGroup | null;
     /**
      * Gets the names of the current logistic groups.
+     * @param type Defaults to `defines.logistic_group_type.with_trash`.
      */
     get_logistic_groups(this: void, type?: defines.logistic_group_type): string[];
     get_spawn_position(this: void, surface: SurfaceIdentification): MapPosition;
@@ -10753,6 +10768,12 @@ interface LuaGameScript {
      * @param player The player to unmute.
      */
     unmute_player(this: void, player: PlayerIdentification): void;
+    /**
+     * Whether players who are not {@link admins | runtime:LuaPlayer::admin} can access all debug settings. Set this to false to disallow access to most debug settings for non-admins.
+     *
+     * The following debug settings are always available to all players: `"show-fps"`, `"show-clock"`, `"show-time-to-next-autosave"`, `"show-detailed-info"`, `"show-time-usage"`, `"show-entity-time-usage"`, `"show-gpu-time-usage"`, `"show-sprite-counts"`, `"show-particle-counts"`, `"show-collector-navmesh-time-usage"`, `"show-lua-object-statistics"`, `"show-heat-buffer-info"`, `"show-multiplayer-waiting-icon"`, `"show-multiplayer-statistics"`, `"show-multiplayer-server-name"`, `"show-debug-info-in-tooltips"`, `"show-resistances-in-tooltips-always"`, `"hide-mod-guis"`, `"show-tile-grid"`, `"show-blueprint-grid"`, `"show-intermediate-volume-of-working-sounds"`, `"show-decorative-names"`, `"allow-increased-zoom"`, `"show-train-no-path-details"`, `"show-entity-tick"`, `"show-update-tick"`
+     */
+    allow_debug_settings: boolean;
     /**
      * If the tips are allowed to be activated in this scenario, it is false by default.
      *
@@ -14232,6 +14253,8 @@ interface LuaPlayer extends LuaControl {
     add_custom_alert(this: void, entity: LuaEntity, icon: SignalID, message: LocalisedString, show_on_map: boolean): void;
     /**
      * Adds a pin to this player for the given pin specification. Either entity, player, or surface and position must be defined.
+     * @param table.preview_distance Defaults to `16`.
+     * @param table.always_visible Defaults to `true`.
      * @param table.entity The entity to pin.
      * @param table.player The player to pin.
      * @param table.surface The surface to create the pin on.
@@ -16124,6 +16147,10 @@ interface LuaRecord {
      * Is this blueprint record a preview? A preview record must be synced by the player before entity and tile data can be read.
      */
     readonly is_blueprint_preview: boolean;
+    /**
+     * Checks if this record is in a preview state.
+     */
+    readonly is_preview: boolean;
     /**
      * The current count of mappers in the upgrade item.
      */
@@ -16277,6 +16304,10 @@ interface LuaRenderObject {
      * Dash length of this line.
      */
     dash_length: double;
+    /**
+     * Starting offset to apply to dashes of this line. Cannot be greater than dash_length + gap_length.
+     */
+    dash_offset: double;
     /**
      * If this object is being drawn on the ground, under most entities and sprites.
      *
@@ -18989,7 +19020,7 @@ interface BaseLuaSurfaceCreateEntityParams {
      */
     'burner_fuel_inventory'?: BlueprintInventoryWithFilters;
     /**
-     * Cause entity / force. The entity or force that triggered the chain of events that led to this entity being created. Used for beams, projectiles, stickers, etc. so that the damage receiver can know which entity or force to retaliate against.
+     * Cause entity / force. The entity or force that triggered the chain of events that led to this entity being created. Used for beams, projectiles, stickers, etc. so that the damage receiver can know which entity or force to retaliate against. Defaults to the value of `source`.
      */
     'cause'?: LuaEntity | ForceID;
     /**

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.65
+// Factorio version 2.0.66
 // API version 6
 
 declare namespace runtime {
@@ -52,8 +52,17 @@ interface AddRecordData {
      * When `rail` is given, this can be provided to further narrow down direction from which that rail should be approached.
      */
     rail_direction?: defines.rail_direction;
+    /**
+     * Defaults to `false`.
+     */
     temporary?: boolean;
+    /**
+     * Defaults to `false`.
+     */
     created_by_interrupt?: boolean;
+    /**
+     * Defaults to `true`.
+     */
     allows_unloading?: boolean;
     wait_conditions?: WaitCondition[];
     /**
@@ -3113,9 +3122,9 @@ interface GuiAnchor {
      */
     names?: string[];
     /**
-     * One of `'both'`, `'only_ghosts'`, or `'only_real'`
+     * Defaults to `"only_real"`.
      */
-    ghost_mode?: string;
+    ghost_mode?: 'both' | 'only_ghosts' | 'only_real';
 }
 /**
  * Used for specifying where a GUI arrow should point to.
@@ -3317,6 +3326,21 @@ type HeatSettingMode = 'at-least' | 'at-most' | 'exactly' | 'add' | 'remove';
  * All base prototype types.
  */
 type IDType = 'custom-input' | 'equipment-grid' | 'entity' | 'particle' | 'item' | 'collision-layer' | 'airborne-pollutant' | 'tile' | 'decorative' | 'recipe-category' | 'item-group' | 'item-subgroup' | 'recipe' | 'fluid' | 'ammo-category' | 'fuel-category' | 'resource-category' | 'technology' | 'noise-function' | 'noise-expression' | 'autoplace-control' | 'equipment' | 'damage-type' | 'virtual-signal' | 'achievement' | 'module-category' | 'equipment-category' | 'mod-setting' | 'trivial-smoke' | 'asteroid-chunk' | 'quality' | 'surface-property' | 'procession-layer-inheritance-group' | 'procession' | 'space-location' | 'space-connection' | 'active-trigger' | 'shortcut' | 'burner-usage' | 'surface' | 'mod-data' | 'custom-event';
+interface IconDrawSpecification {
+    shift: Vector;
+    scale: float;
+    scale_for_many: float;
+    render_layer?: 'entity-info-icon-below' | 'entity-info-icon-above' | 'air-entity-info-icon';
+}
+interface IconSequencePositioning {
+    inventory_index: defines.inventory;
+    max_icons_per_row: uint8;
+    max_icon_rows: uint8;
+    shift: Vector;
+    scale: float;
+    separation_multiplier: float;
+    multi_row_initial_height_modifier: float;
+}
 /**
  * A single filter used by an infinity-filters instance.
  */
@@ -3851,7 +3875,7 @@ type ItemPrototypeFlag = /**
  * Makes construction bots prefer this item when building the entity specified by its `place_result`.
  */
 'primary-place-result' | /**
- * Allows the item to be opened by the player, firing the `on_mod_item_opened` event. Only has an effect for selection tool items.
+ * Allows the item to be opened by the player, firing the {@link on_mod_item_opened | runtime:on_mod_item_opened} event.
  */
 'mod-openable' | /**
  * Makes it so the item is deleted when clearing the cursor, instead of being put into the player's inventory. The copy-paste tools use this by default, for example.
@@ -6916,6 +6940,7 @@ interface PlaceAsTileResult {
     condition_size: uint;
     condition: CollisionMask;
     invert: boolean;
+    tile_condition: LuaTilePrototype[];
 }
 interface PlatformSchedule {
     /**

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.65
+// Factorio version 2.0.66
 // 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.65
+// Factorio version 2.0.66
 // 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.65
+// Factorio version 2.0.66
 // API version 6
 
 declare namespace runtime {
@@ -4511,7 +4511,7 @@ interface on_tower_mined_plant {
     tower: LuaEntity;
 }
 /**
- * Called before an agricultural tower planets a seed.
+ * Called before an agricultural tower plants a seed.
  */
 interface on_tower_planted_seed {
     /**
@@ -4519,7 +4519,7 @@ interface on_tower_planted_seed {
      */
     name: defines.events;
     /**
-     * The plant which was planted.
+     * The plant that was planted.
      */
     plant: LuaEntity;
     /**
@@ -4531,7 +4531,7 @@ interface on_tower_planted_seed {
      */
     tick: uint;
     /**
-     * The tower that's did the planting.
+     * The tower that did the planting.
      */
     tower: LuaEntity;
 }
@@ -4544,7 +4544,7 @@ interface on_tower_pre_mined_plant {
      */
     name: defines.events;
     /**
-     * The plant which is about to be mined.
+     * The plant that is about to be mined.
      */
     plant: LuaEntity;
     /**
@@ -4552,7 +4552,7 @@ interface on_tower_pre_mined_plant {
      */
     tick: uint;
     /**
-     * The tower that's about to do the mining.
+     * The tower that is about to do the mining.
      */
     tower: LuaEntity;
 }

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.65
+// Factorio version 2.0.66
 // 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.65
+// Factorio version 2.0.66
 // API version 6
 
 declare namespace prototype {
@@ -1531,10 +1531,6 @@ interface CharacterPrototype extends EntityWithOwnerPrototype {
     damage_hit_tint: Color;
     distance_per_frame: double;
     drop_item_distance: uint32;
-    /**
-     * The sound played when the character eats (fish for example).
-     */
-    eat: Sound;
     /**
      * Must be >= 0.
      */
@@ -1569,7 +1565,7 @@ interface CharacterPrototype extends EntityWithOwnerPrototype {
     /**
      * The sound played when the character's health is low.
      */
-    heartbeat: Sound;
+    heartbeat?: Sound;
     /**
      * Number of slots in the main inventory. May be 0.
      */
@@ -2016,6 +2012,8 @@ interface CraftingMachinePrototype extends EntityWithOwnerPrototype {
     fast_transfer_modules_into_module_slots_only?: boolean;
     /**
      * The crafting machine's fluid boxes. If an assembling machine has fluid boxes *and* {@link AssemblingMachinePrototype::fluid_boxes_off_when_no_fluid_recipe | prototype:AssemblingMachinePrototype::fluid_boxes_off_when_no_fluid_recipe} is true, the assembling machine can only be rotated when a recipe consuming or producing fluid is set, or if it has one of the other properties listed at the top of this page.
+     *
+     * For assembling machines, any {@link filters | prototype:FluidBox::filter} set on the fluidboxes are ignored.
      * @example ```
     fluid_boxes =
     {
@@ -3228,7 +3226,7 @@ interface EntityPrototype extends Prototype {
      */
     icon?: FileName;
     /**
-     * Used to specify where and how should be the alt-mode icons of entities should be drawn.
+     * Used to specify where and how the alt-mode icons should be drawn.
      * @example ```
     icon_draw_specification = {shift = {0, 0.5}, scale = 0.75, scale_for_many = 0.5, render_layer = "entity-info-icon"}
     ```
@@ -5062,7 +5060,7 @@ interface LabPrototype extends EntityWithOwnerPrototype {
     science_pack_drain_rate_percent?: uint8;
     trash_inventory_size?: ItemStackIndex;
     /**
-     * Whether the {@link QualityPrototype::science_pack_drain_multiplier | prototype:QualityPrototype::science_pack_drain_multiplier} of the quality of the science pack should be considered by the lab.
+     * Whether the {@link QualityPrototype::science_pack_drain_multiplier | prototype:QualityPrototype::science_pack_drain_multiplier} of the quality of this lab should affect how much science is consumed to research one unit of technology.
      */
     uses_quality_drain_modifier?: boolean;
 }
@@ -5416,11 +5414,14 @@ interface LoaderPrototype extends TransportBeltConnectablePrototype {
      * If filters are per lane. Can only be set to true if filter_count is equal to 2.
      */
     per_lane_filters?: boolean;
+    /**
+     * When set, this loader will respect the same automated insertion limits as inserters do, instead of inserting up to the full ingredient stack capacity.
+     */
     respect_insert_limits?: boolean;
     structure?: LoaderStructure;
     structure_render_layer?: RenderLayer;
     /**
-     * When set, loader will ignore items for which there is not enough to create a full belt stack. Relevant only when loader can create belt stacks.
+     * When set, this loader will ignore items for which there is not enough to create a full belt stack. Relevant only when loader can create belt stacks.
      */
     wait_for_full_stack?: boolean;
 }
@@ -6575,6 +6576,8 @@ interface QualityPrototype extends Prototype {
     range_multiplier?: double;
     /**
      * Must be in range `[0, 1]`.
+     *
+     * Only affects labs with {@link LabPrototype::uses_quality_drain_modifier | prototype:LabPrototype::uses_quality_drain_modifier} set.
      */
     science_pack_drain_multiplier?: float;
     /**
@@ -8439,7 +8442,7 @@ interface SpaceLocationPrototype extends Prototype {
     asteroid_spawn_influence?: double;
     auto_save_on_first_trip?: boolean;
     /**
-     * Distance from the location's parent body in map coordinates.
+     * Distance from the sun in map coordinates.
      */
     distance: double;
     /**
@@ -8479,7 +8482,7 @@ interface SpaceLocationPrototype extends Prototype {
      */
     magnitude?: double;
     /**
-     * Angle in relation to the parent body.
+     * Angle in relation to the sun.
      */
     orientation: RealOrientation;
     /**
@@ -8504,7 +8507,7 @@ interface SpaceLocationPrototype extends Prototype {
      */
     starmap_icon?: FileName;
     /**
-     * Orientation of the starmap icon, defaults to pointing towards the parent body.
+     * Orientation of the starmap icon, defaults to pointing towards the sun.
      */
     starmap_icon_orientation?: RealOrientation;
     /**
@@ -9329,7 +9332,7 @@ interface TilePrototype extends Prototype {
      * If items dropped on this tile are destroyed.
      */
     destroys_dropped_items?: boolean;
-    driving_sound?: Sound;
+    driving_sound?: InterruptibleSound;
     /**
      * Triggers when a foundation tile is destroyed by an asteroid.
      */

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.65
+// Factorio version 2.0.66
 // API version 6
 
 declare namespace prototype {
@@ -5352,7 +5352,7 @@ interface IconData {
     tint?: Color;
 }
 /**
- * Specification of where and how should be the alt-mode icons of entities be drawn.
+ * Specification of where and how the alt-mode icons of entities should be drawn.
  */
 interface IconDrawSpecification {
     /**
@@ -5612,7 +5612,7 @@ type ItemPrototypeFlags = (/**
  * Item will be preferred by construction bots when building the entity specified by the item's {@link place_result | prototype:ItemPrototype::place_result}.
  */
 'primary-place-result' | /**
- * Only works for {@link SelectionToolPrototype | prototype:SelectionToolPrototype} and derived classes. Corresponds to the runtime {@link on_mod_item_opened | runtime:on_mod_item_opened} event.
+ * Allows the item to be opened by the player, firing the {@link on_mod_item_opened | runtime:on_mod_item_opened} event.
  */
 'mod-openable' | /**
  * Item is deleted when removed from the cursor by pressing `Q` ("clear cursor"). Used for example by the copy/paste tools.
@@ -9947,6 +9947,12 @@ interface SpriteSheet extends SpriteParameters {
      * Same as `dice` above, but this specifies only how many slices there are on the y axis.
      */
     dice_y?: SpriteSizeType;
+    /**
+     * Only loaded, and mandatory if `layers` and `filenames` are not defined.
+     *
+     * The path to the sprite file to use.
+     */
+    filename?: FileName;
     filenames?: FileName[];
     /**
      * If this property is present, all SpriteSheet definitions have to be placed as entries in the array, and they will all be loaded from there. `layers` may not be an empty table. Each definition in the array may also have the `layers` property.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.47",
+  "version": "1.2.48",
   "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.65",
+  "factorioVersion": "2.0.66",
   "dependencies": {
     "lua-types": "^2.13.1"
   },