factorio-types 1.2.16 → 1.2.18

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.23
+// Factorio version 2.0.27
 // API version 6
 
 declare namespace runtime {
@@ -22,6 +22,10 @@ interface LuaAISettings {
      * If enabled, units will try to separate themselves from nearby friendly units.
      */
     do_separation: boolean;
+    /**
+     * If enabled, the unit will join attack groups.
+     */
+    join_attacks: 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.
      */
@@ -30,6 +34,12 @@ interface LuaAISettings {
      * Defines how coarse the pathfinder's grid is, where smaller values mean a coarser grid. Defaults to `0`, which equals a resolution of `1x1` tiles, centered on tile centers. Values range from `-8` to `8` inclusive, where each integer increment doubles/halves the resolution. So, a resolution of `-8` equals a grid of `256x256` tiles, and a resolution of `8` equals `1/256` of a tile.
      */
     path_resolution_modifier: int8;
+    /**
+     * The number of "slots" that the unit takes up in a unit group. Must be greater than 0.
+     *
+     * If this value is changed after the unit has been added to a group, the exact behavior is undefined.
+     */
+    size_in_group: float;
     /**
      * 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.
      */
@@ -344,21 +354,25 @@ interface LuaAutoplaceControlPrototype extends LuaPrototypeBase {
 interface LuaBootstrap {
     /**
      * Generate a new, unique event ID that can be used to raise custom events with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event}.
-     * @returns The newly generated event ID.
+     * @returns The newly generated event ID. This will be a new value that does not correspond to any named entry in defines.events.
      */
-    generate_event_name(this: void): uint;
+    generate_event_name(this: void): defines.events;
     /**
      * Gets the filters for the given event.
      * @param event ID of the event to get.
      * @returns The filters or `nil` if none are defined.
      */
-    get_event_filter(this: void, event: uint): EventFilter | null;
+    get_event_filter(this: void, event: LuaEventType): EventFilter | null;
     /**
      * Find the event handler for an event.
      * @param event The event identifier to get a handler for.
      * @returns Reference to the function currently registered as the handler, if it was found.
      */
-    get_event_handler(this: void, event: uint): ((this: void, arg0: EventData) => any) | null;
+    get_event_handler(this: void, event: LuaEventType): ((this: void, arg0: EventData) => any) | null;
+    /**
+     * Converts LuaEventType into related value of defines.events. Value will be provided also if event was not given a constant inside of defines.events.
+     */
+    get_event_id(this: void, event: LuaEventType): defines.events;
     /**
      * Gets the mod event order as a string.
      */
@@ -3989,7 +4003,7 @@ interface LuaBootstrap {
     {{filter = "name", name = "fast-inserter"}})
     ```
      */
-    on_event(this: void, event: defines.events | string | (defines.events | string)[], handler: ((this: void, arg0: EventData) => any) | nil, filters?: EventFilter): void;
+    on_event(this: void, event: LuaEventType | LuaEventType[], handler: ((this: void, arg0: EventData) => any) | nil, filters?: EventFilter): void;
     /**
      * Register a function to be run on mod initialization.
      *
@@ -4206,7 +4220,7 @@ interface LuaBootstrap {
      * @param event ID of the event to filter.
      * @param filters The filters or `nil` to clear them.
      */
-    set_event_filter(this: void, event: uint, filters?: EventFilter): void;
+    set_event_filter(this: void, event: LuaEventType, filters?: EventFilter): void;
     /**
      * A dictionary listing the names of all currently active mods and mapping them to their version.
      * @example ```
@@ -4336,6 +4350,8 @@ interface LuaBurnerPrototype {
      */
     readonly fuel_categories: Record<string, true>;
     readonly fuel_inventory_size: uint;
+    readonly initial_fuel?: LuaItemPrototype;
+    readonly initial_fuel_percent: double;
     /**
      * The light flicker definition for this burner prototype.
      */
@@ -5259,6 +5275,10 @@ interface LuaCustomChartTag {
  * Prototype of a custom event.
  */
 interface LuaCustomEventPrototype extends LuaPrototypeBase {
+    /**
+     * Event identifier associated with this custom event.
+     */
+    readonly event_id: defines.events;
     /**
      * 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.
      */
@@ -5304,6 +5324,10 @@ interface LuaCustomInputPrototype extends LuaPrototypeBase {
      * Whether this custom input is enabled while using the spectator controller.
      */
     readonly enabled_while_spectating: boolean;
+    /**
+     * Event identifier associated with this custom input.
+     */
+    readonly event_id: defines.events;
     /**
      * Whether this custom input will include the selected prototype (if any) when triggered.
      */
@@ -6520,6 +6544,20 @@ interface LuaEntity extends LuaControl {
      * The current direction this entity is facing.
      */
     direction: defines.direction;
+    /**
+     * If the updatable entity is disabled by control behavior.
+     */
+    readonly disabled_by_control_behavior: boolean;
+    /**
+     * If the updatable entity is disabled by recipe.
+     */
+    readonly disabled_by_recipe: boolean;
+    /**
+     * If the updatable entity is disabled by script.
+     *
+     * Note: Some entities (Corpse, FireFlame, Roboport, RollingStock, dying entities) need to remain active and will ignore writes.
+     */
+    disabled_by_script: boolean;
     /**
      * Gives a draw data of the given entity if it supports such data.
      */
@@ -6622,6 +6660,10 @@ interface LuaEntity extends LuaControl {
     ```
      */
     friction_modifier: float;
+    /**
+     * If the freezable entity is currently frozen.
+     */
+    readonly frozen: boolean;
     readonly ghost_localised_description: LocalisedString;
     /**
      * Localised name of the entity or tile contained in this ghost.
@@ -6707,7 +6749,7 @@ interface LuaEntity extends LuaControl {
      */
     inserter_filter_mode?: 'whitelist' | 'blacklist';
     /**
-     * Sets the stack size limit on this inserter. If the stack size is > than the force stack size limit the value is ignored.
+     * Sets the stack size limit on this inserter.
      *
      * Set to `0` to reset.
      */
@@ -6726,6 +6768,10 @@ interface LuaEntity extends LuaControl {
      * If this entity is EntityWithOwner
      */
     readonly is_entity_with_owner: boolean;
+    /**
+     * If the entity is freezable.
+     */
+    readonly is_freezable: boolean;
     /**
      * If the rolling stock is facing train's front.
      */
@@ -6734,6 +6780,10 @@ interface LuaEntity extends LuaControl {
      * Whether this entity is a MilitaryTarget. Can be written to if {@link LuaEntityPrototype::allow_run_time_change_of_is_military_target | runtime:LuaEntityPrototype::allow_run_time_change_of_is_military_target} returns `true`.
      */
     is_military_target: boolean;
+    /**
+     * If the entity is updatable.
+     */
+    readonly is_updatable: boolean;
     /**
      * Items this ghost will request when revived or items this item request proxy is requesting.
      */
@@ -6800,9 +6850,15 @@ interface LuaEntity extends LuaControl {
     /**
      * Not minable entities can still be destroyed.
      *
-     * Entities that are not minable naturally (like smoke, character, enemy units etc) can't be set to minable.
+     * Tells if entity reports as being minable right now. This takes into account minable_flag and entity specific conditions (for example rail under rolling stocks is not minable, vehicle with passenger is not minable).
+     *
+     * Write to this field since 2.0.26 is deprecated and it will result in write to minable_flag instead.
      */
     minable: boolean;
+    /**
+     * Script controlled flag that allows entity to be mined.
+     */
+    minable_flag: boolean;
     /**
      * The filter mode for this mining drill. `nil` if this mining drill doesn't have filters.
      */
@@ -6816,7 +6872,7 @@ interface LuaEntity extends LuaControl {
      */
     readonly mining_target?: LuaEntity;
     /**
-     * If the entity is currently mirrored.
+     * If the entity is currently mirrored. This state is referred to as `flipped` elsewhere, such as on the {@link on_player_flipped_entity | runtime:on_player_flipped_entity} event.
      */
     mirroring: boolean;
     /**
@@ -7857,6 +7913,10 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * The bounding box used for map generator collision checking.
      */
     readonly map_generator_bounding_box: BoundingBox;
+    /**
+     * Count of defensive enemies this spawner can sustain.
+     */
+    readonly max_count_of_owned_defensive_units?: double;
     /**
      * Count of enemies this spawner can sustain.
      */
@@ -7865,6 +7925,10 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * The maximum darkness at which this unit spawner can spawn entities.
      */
     readonly max_darkness_to_spawn?: float;
+    /**
+     * How many defensive friendly units are required within the spawning_radius of this spawner for it to stop producing more units.
+     */
+    readonly max_defensive_friends_around_to_spawn?: double;
     /**
      * How many friendly units are required within the spawning_radius of this spawner for it to stop producing more units.
      */
@@ -8606,14 +8670,14 @@ interface LuaFlowStatistics {
      * Use `sample_index` to access the data used to generate the statistics graphs. Each precision level contains 300 samples of data so at a precision of 1 minute, each sample contains data averaged across 60s / 300 = 0.2s = 12 ticks.
      *
      * All return values are normalized to be per-tick for electric networks and per-minute for all other types.
-     * @param table.id The prototype ID.
+     * @param table.name The prototype ID.
      * @param table.category The statistics category to read from. Valid choices are `"input"`, `"output"` and `"storage"`.
      * @param table.precision_index The precision to read.
      * @param table.sample_index The sample index to read from within the precision range. If not provided, the entire precision range is read. Must be between 1 and 300 where 1 is the most recent sample and 300 is the oldest.
      * @param table.count If true, the count of items/fluids/entities is returned instead of the per-time-frame value.
      */
     get_flow_count(this: void, table: {
-        id: FlowStatisticsID;
+        name: FlowStatisticsID;
         category: string;
         precision_index: defines.flow_precision_index;
         sample_index?: uint16;
@@ -10037,7 +10101,7 @@ interface LuaGenericOnOffControlBehavior extends LuaControlBehavior {
     /**
      * `true` if this should connect to the logistic network.
      */
-    readonly connect_to_logistic_network: boolean;
+    connect_to_logistic_network: boolean;
     /**
      * If the entity is currently disabled because of the control behavior.
      */
@@ -10054,7 +10118,7 @@ interface LuaGenericOnOffControlBehavior extends LuaControlBehavior {
     }
     ```
      */
-    readonly logistic_condition: CircuitConditionDefinition;
+    logistic_condition: CircuitConditionDefinition;
 }
 /**
  * Item group or subgroup.
@@ -11762,7 +11826,7 @@ interface LuaItemCommon {
     /**
      * Gets the entity filter at the given index for this deconstruction item.
      */
-    get_entity_filter(this: void, index: uint): string | null;
+    get_entity_filter(this: void, index: uint): ItemFilter | null;
     /**
      * Access the inner inventory of an item.
      * @param inventory Index of the inventory to access, which can only be {@link defines.inventory.item_main | runtime:defines.inventory.item_main}.
@@ -11820,7 +11884,7 @@ interface LuaItemCommon {
      * @param filter Writing `nil` removes the filter.
      * @returns Whether the new filter was successfully set (meaning it was valid).
      */
-    set_entity_filter(this: void, index: uint, filter: string | LuaEntityPrototype | LuaEntity | nil): boolean;
+    set_entity_filter(this: void, index: uint, filter: ItemFilter | nil): boolean;
     /**
      * Sets the module filter at the given index for this upgrade item.
      *
@@ -11892,9 +11956,9 @@ interface LuaItemCommon {
      */
     entity_filter_mode: defines.deconstruction_item.entity_filter_mode;
     /**
-     * The entity filters for this deconstruction item. The attribute is a sparse array with the keys representing the index of the filter. All strings in this array must be entity prototype names that don't have the `"not-deconstructable"` flag set and are either a `cliff` or marked as `minable`.
+     * The entity filters for this deconstruction item. The attribute is a sparse array with the keys representing the index of the filter. All prototypes in this array must not have the `"not-deconstructable"` flag set and are either a `cliff` or marked as `minable`.
      */
-    entity_filters: string[];
+    entity_filters: ItemFilter[];
     /**
      * If this is an item with entity data, get the stored entity label.
      */
@@ -14761,7 +14825,7 @@ interface LuaRecord {
         raise_built?: boolean;
     }): LuaEntity[];
     /**
-     * Cancel deconstruct the given area with this deconstruction planner,.
+     * Cancel deconstruct the given area with this deconstruction planner.
      * @param table.surface Surface to cancel deconstruct on
      * @param table.force Force to use for canceling deconstruction
      * @param table.area The area to deconstruct
@@ -14814,7 +14878,7 @@ interface LuaRecord {
         include_fuel?: boolean;
     }): Record<uint, LuaEntity>;
     /**
-     * Deconstruct the given area with this deconstruction planner,.
+     * Deconstruct the given area with this deconstruction planner.
      * @param table.surface Surface to deconstruct on
      * @param table.force Force to use for the deconstruction
      * @param table.area The area to deconstruct
@@ -14853,9 +14917,9 @@ interface LuaRecord {
      */
     get_blueprint_tiles(this: void): Tile[] | null;
     /**
-     * Gets the entity filter at the given index for this deconstruction planner,.
+     * Gets the entity filter at the given index for this deconstruction planner.
      */
-    get_entity_filter(this: void, index: uint): string | null;
+    get_entity_filter(this: void, index: uint): ItemFilter | null;
     /**
      * Gets the filter at the given index for this upgrade item.
      *
@@ -14865,7 +14929,7 @@ interface LuaRecord {
      */
     get_mapper(this: void, index: uint, type: string): UpgradeMapperSource | UpgradeMapperDestination;
     /**
-     * Gets the tile filter at the given index for this deconstruction planner,.
+     * Gets the tile filter at the given index for this deconstruction planner.
      */
     get_tile_filter(this: void, index: uint): string | null;
     /**
@@ -14895,11 +14959,11 @@ interface LuaRecord {
      */
     set_blueprint_tiles(this: void, tiles: Tile[]): void;
     /**
-     * Sets the entity filter at the given index for this deconstruction planner,.
+     * Sets the entity filter at the given index for this deconstruction planner.
      * @param filter Writing `nil` removes the filter.
      * @returns Whether the new filter was successfully set (ie. was valid).
      */
-    set_entity_filter(this: void, index: uint, filter: string | LuaEntityPrototype | LuaEntity | nil): boolean;
+    set_entity_filter(this: void, index: uint, filter: ItemFilter | nil): boolean;
     /**
      * Sets the module filter at the given index for this upgrade item.
      *
@@ -14910,7 +14974,7 @@ interface LuaRecord {
      */
     set_mapper(this: void, index: uint, type: string, mapper: UpgradeMapperSource | UpgradeMapperDestination): void;
     /**
-     * Sets the tile filter at the given index for this deconstruction planner,.
+     * Sets the tile filter at the given index for this deconstruction planner.
      * @param filter Setting to nil erases the filter.
      * @returns Whether the new filter was successfully set (ie. was valid).
      */
@@ -14944,13 +15008,13 @@ interface LuaRecord {
      */
     readonly entity_filter_count: uint;
     /**
-     * The blacklist/whitelist entity filter mode for this deconstruction planner,.
+     * The blacklist/whitelist entity filter mode for this deconstruction planner.
      */
     entity_filter_mode: defines.deconstruction_item.entity_filter_mode;
     /**
-     * The entity filters for this deconstruction planner. The attribute is a sparse array with the keys representing the index of the filter. All strings in this array must be entity prototype names that don't have the `"not-deconstructable"` flag set and are either a `cliff` or marked as `minable`.
+     * The entity filters for this deconstruction planner. The attribute is a sparse array with the keys representing the index of the filter. All prototypes in this array must not have the `"not-deconstructable"` flag set and are either a `cliff` or marked as `minable`.
      */
-    entity_filters: string[];
+    entity_filters: ItemFilter[];
     /**
      * Is this blueprint record a preview? A preview record must be synced by the player before entity and tile data can be read.
      */
@@ -14968,15 +15032,15 @@ interface LuaRecord {
      */
     readonly tile_filter_count: uint;
     /**
-     * The blacklist/whitelist tile filter mode for this deconstruction planner,.
+     * The blacklist/whitelist tile filter mode for this deconstruction planner.
      */
     tile_filter_mode: defines.deconstruction_item.tile_filter_mode;
     /**
-     * The tile filters for this deconstruction planner,. The attribute is a sparse array with the keys representing the index of the filter. Reading filters always returns an array of strings which are the tile prototype names.
+     * The tile filters for this deconstruction planner. The attribute is a sparse array with the keys representing the index of the filter. Reading filters always returns an array of strings which are the tile prototype names.
      */
     tile_filters: TileID[];
     /**
-     * The tile selection mode for this deconstruction planner,.
+     * The tile selection mode for this deconstruction planner.
      */
     tile_selection_mode: defines.deconstruction_item.tile_selection_mode;
     /**
@@ -15984,6 +16048,10 @@ interface LuaSpacePlatform {
      * The unique index of this space platform.
      */
     readonly index: uint;
+    /**
+     * The space location this space platform previously went through or stopped at.
+     */
+    readonly last_visited_space_location?: LuaSpaceLocationPrototype;
     /**
      * The name of this space platform.
      */
@@ -15992,6 +16060,10 @@ interface LuaSpacePlatform {
      * 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;
+    /**
+     * When `true`, the platform has paused thrust and does not advance its schedule.
+     */
+    paused: boolean;
     /**
      * This platform's current schedule, if any. Set to `nil` to clear.
      *
@@ -16012,7 +16084,7 @@ interface LuaSpacePlatform {
     /**
      * The starter pack used to create this space platform.
      */
-    readonly starter_pack: ItemIDAndQualityIDPair;
+    readonly starter_pack?: ItemIDAndQualityIDPair;
     /**
      * The current state of this space platform.
      */
@@ -17140,6 +17212,10 @@ interface LuaSurface {
      * Whether this surface currently has a global electric network.
      */
     readonly has_global_electric_network: boolean;
+    /**
+     * If surface condition checks should not be performed on this surface.
+     */
+    ignore_surface_conditions: bool;
     /**
      * This surface's index in {@link LuaGameScript::surfaces | runtime:LuaGameScript::surfaces} (unique ID). It is assigned when a surface is created, and remains so until it is {@link deleted | runtime:on_surface_deleted}. Indexes of deleted surfaces can be reused.
      */
@@ -18774,7 +18850,7 @@ interface LuaWireConnector {
      */
     readonly is_ghost: boolean;
     /**
-     * Index of a CircuitNetwork or ElectricSubNetwork which is going through this wire connector. Returns 0 if there is no network associated with this wire connector right now. CircuitNetwork indexes are independent of indexes of ElectricSubNetwork so they may collide with each other
+     * Index of a CircuitNetwork or ElectricSubNetwork which is going through this wire connector. Returns 0 if there is no network associated with this wire connector right now. CircuitNetwork indexes are independent of indexes of ElectricSubNetwork so they may collide with each other.
      */
     readonly network_id: 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.23
+// Factorio version 2.0.27
 // API version 6
 
 declare namespace runtime {
@@ -3560,6 +3560,22 @@ interface LuaEntityMarkedForUpgradeEventFilterType extends BaseLuaEntityMarkedFo
      */
     'type': string;
 }
+/**
+ * Event name may be specified in one of four ways.
+ */
+type LuaEventType = /**
+ * Custom event prototype.
+ */
+LuaCustomEventPrototype | /**
+ * Custom input prototype.
+ */
+LuaCustomInputPrototype | /**
+ * Event identifier.
+ */
+defines.events | /**
+ * Name of the event.
+ */
+string;
 /**
  * Any LuaObject listed on the {@link Classes | runtime:classes} page.
  */
@@ -5293,15 +5309,14 @@ interface ModSettingPrototypeFilterType extends BaseModSettingPrototypeFilter {
 type ModifierType = 'inserter-stack-size-bonus' | 'bulk-inserter-capacity-bonus' | 'laboratory-speed' | 'character-logistic-trash-slots' | 'maximum-following-robots-count' | 'worker-robot-speed' | 'worker-robot-storage' | 'turret-attack' | 'ammo-damage' | 'give-item' | 'gun-speed' | 'unlock-recipe' | 'character-crafting-speed' | 'character-mining-speed' | 'character-running-speed' | 'character-build-distance' | 'character-item-drop-distance' | 'character-reach-distance' | 'character-resource-reach-distance' | 'character-item-pickup-distance' | 'character-loot-pickup-distance' | 'character-inventory-slots-bonus' | 'deconstruction-time-to-live' | 'max-failed-attempts-per-tick-per-construction-queue' | 'max-successful-attempts-per-tick-per-construction-queue' | 'character-health-bonus' | 'mining-drill-productivity-bonus' | 'train-braking-force-bonus' | 'worker-robot-battery' | 'laboratory-productivity' | 'follower-robot-lifetime' | 'artillery-range' | 'nothing' | 'character-logistic-requests' | 'unlock-space-location' | 'unlock-quality' | 'unlock-space-platforms' | 'unlock-circuit-network' | 'cargo-landing-pad-count' | 'change-recipe-productivity' | 'cliff-deconstruction-enabled' | 'mining-with-fluid' | 'rail-support-on-deep-oil-ocean' | 'rail-planner-allow-elevated-rails' | 'beacon-distribution' | 'create-ghost-on-entity-death' | 'belt-stack-size-bonus' | 'vehicle-logistics';
 /**
  * The percentual increase of the attribute. A value of `0.6` means a 60% increase.
+ *
+ * Quality values are divided by 10 internally, allowing for one more decimal of precision.
  */
 type ModuleEffectValue = float;
 /**
  * @example ```
--- These are the effects of the vanilla Productivity Module 3 (up to floating point imprecisions)
-{consumption=0.6,
-  speed=-0.15,
-  productivity=0.06,
-  pollution=0.075}
+-- These are the effects of the vanilla Speed Module 3
+{speed = 0.5, consumption = 0.7, quality = -0.25}
 ```
  */
 interface ModuleEffects {
@@ -6650,6 +6665,10 @@ interface SignalID {
      * Name of the prototype.
      */
     name?: string;
+    /**
+     * The prototype name of the signal's quality. Defaults to `normal`.
+     */
+    quality?: QualityID;
 }
 type SignalIDType = 'item' | 'fluid' | 'virtual' | 'entity' | 'recipe' | 'space-location' | 'asteroid-chunk' | 'quality';
 /**
@@ -7501,7 +7520,7 @@ interface TriggerEffectItem {
 /**
  * Used by {@link TriggerEffectItem | runtime:TriggerEffectItem}.
  */
-type TriggerEffectItemType = 'damage' | 'create-entity' | 'create-explosion' | 'create-fire' | 'create-smoke' | 'create-trivial-smoke' | 'create-asteroid-chunk' | 'create-particle' | 'create-sticker' | 'create-decorative' | 'nested-result' | 'play-sound' | 'push-back' | 'destroy-cliffs' | 'show-explosion-on-chart' | 'insert-item' | 'script' | 'set-tile' | 'invoke-tile-trigger' | 'destroy-decoratives' | 'camera-effect' | 'activate-impact';
+type TriggerEffectItemType = 'damage' | 'damage-tile' | 'create-entity' | 'create-explosion' | 'create-fire' | 'create-smoke' | 'create-trivial-smoke' | 'create-asteroid-chunk' | 'create-particle' | 'create-sticker' | 'create-decorative' | 'nested-result' | 'play-sound' | 'push-back' | 'destroy-cliffs' | 'show-explosion-on-chart' | 'insert-item' | 'script' | 'set-tile' | 'invoke-tile-trigger' | 'destroy-decoratives' | 'camera-effect' | 'activate-impact';
 interface TriggerItem {
     type: 'direct' | 'area' | 'line' | 'cluster';
     action_delivery?: TriggerDelivery[];

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.23
+// Factorio version 2.0.27
 // 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.23
+// Factorio version 2.0.27
 // API version 6
 
 declare namespace defines {
@@ -2078,7 +2078,7 @@ enum space_platform_state {
      */
     no_path = 6,
     /**
-     * Waiting for a starter pack
+     * Doesn't have any stations in schedule.
      */
     no_schedule = 5,
     /**

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.23
+// Factorio version 2.0.27
 // API version 6
 
 declare namespace runtime {
@@ -1422,9 +1422,9 @@ interface on_mod_item_opened {
     tick: uint;
 }
 /**
- * Called after an object is destroyed that has been registered with {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed}.
+ * Called after an object is destroyed which was registered with {@link LuaBootstrap::register_on_object_destroyed | runtime:LuaBootstrap::register_on_object_destroyed} previously.
  *
- * Depending on when a given object is destroyed, this event will be fired at the end of the current tick or at the end of the next tick.
+ * Depending on when a given object is destroyed, this event will be fired at the end of the current tick or at the end of the next tick. The event's timing is independent of the in-world object being destroyed.
  */
 interface on_object_destroyed {
     /**
@@ -2184,7 +2184,9 @@ interface on_player_fast_transferred {
     tick: uint;
 }
 /**
- * Called when the player flips an entity. This event is only fired when the entity actually changes its orientation or mirroring -- pressing the flip keys on an entity that can't be flipped won't fire this event.
+ * Called when the player flips an entity. This event is only fired when the entity actually changes its orientation or mirroring, so it won't be triggered when pressing the flip keys on an entity that can't be flipped.
+ *
+ * This event reflects a change in the {@link LuaEntity::mirroring | runtime:LuaEntity::mirroring} property.
  */
 interface on_player_flipped_entity {
     /**
@@ -2192,7 +2194,7 @@ interface on_player_flipped_entity {
      */
     entity: LuaEntity;
     /**
-     * The enacted flip. true = Horizontal, false = Vertical
+     * The enacted flip. `true` means a horizontal flip, `false` a vertical one.
      */
     horizontal: boolean;
     /**

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.23
+// Factorio version 2.0.27
 // 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.23
+// Factorio version 2.0.27
 // API version 6
 
 declare namespace prototype {
@@ -826,6 +826,9 @@ interface AssemblingMachinePrototype extends CraftingMachinePrototype {
     draw_circuit_wires?: bool;
     draw_copper_wires?: bool;
     enable_logistic_control_behavior?: bool;
+    /**
+     * Only loaded when fixed_recipe is provided.
+     */
     fixed_quality?: QualityID;
     /**
      * The preset recipe of this machine. This machine does not show a recipe selection if this is set. The base game uses this for the {@link rocket silo | https://wiki.factorio.com/Rocket_silo}.
@@ -1339,6 +1342,7 @@ interface CargoLandingPadPrototype extends EntityWithOwnerPrototype {
     graphics_set?: CargoBayConnectableGraphicsSet;
     inventory_size: ItemStackIndex;
     radar_range?: uint32;
+    radar_visualisation_color?: Color;
     /**
      * Drawn when a robot brings/takes items from this landing pad.
      */
@@ -2712,6 +2716,7 @@ interface EditorControllerPrototype {
     generate_neighbor_chunks: bool;
     gun_inventory_size: ItemStackIndex;
     ignore_surface_conditions: bool;
+    ignore_tile_conditions: bool;
     instant_blueprint_building: bool;
     instant_deconstruction: bool;
     instant_rail_planner: bool;
@@ -2859,11 +2864,19 @@ interface EnemySpawnerPrototype extends EntityWithOwnerPrototype {
      * Whether this prototype should be a high priority target for enemy forces. See {@link Military units and structures | https://wiki.factorio.com/Military_units_and_structures}.
      */
     is_military_target?: true;
+    /**
+     * Count of defensive enemies this spawner can sustain. Defensive units are units with {@link UnitAISettings::join_attacks | prototype:UnitAISettings::join_attacks} set to false. If set below {@link EnemySpawnerPrototype::max_count_of_owned_units | prototype:EnemySpawnerPrototype::max_count_of_owned_units}, the difference will be the space reserved for non-defensive units.
+     */
+    max_count_of_owned_defensive_units?: uint32;
     /**
      * Count of enemies this spawner can sustain.
      */
     max_count_of_owned_units: uint32;
     max_darkness_to_spawn?: float;
+    /**
+     * How many friendly defensive units are required within the {@link EnemySpawnerPrototype::spawning_radius | prototype:EnemySpawnerPrototype::spawning_radius} of this spawner for it to stop producing more units. Defensive units are units with {@link UnitAISettings::join_attacks | prototype:UnitAISettings::join_attacks} set to false. If set below {@link EnemySpawnerPrototype::max_friends_around_to_spawn | prototype:EnemySpawnerPrototype::max_friends_around_to_spawn}, the difference will be the space reserved for non-defensive units.
+     */
+    max_defensive_friends_around_to_spawn?: uint32;
     /**
      * How many friendly units are required within the {@link EnemySpawnerPrototype::spawning_radius | prototype:EnemySpawnerPrototype::spawning_radius} of this spawner for it to stop producing more units.
      */
@@ -3782,6 +3795,9 @@ interface FluidTurretPrototype extends TurretPrototype {
     prepared_muzzle_animation_shift?: AnimatedVector;
     preparing_muzzle_animation_shift?: AnimatedVector;
     starting_attack_muzzle_animation_shift?: AnimatedVector;
+    /**
+     * Always `true`, forcing the turret's collision box to be affected by its rotation.
+     */
     turret_base_has_direction: true;
 }
 /**
@@ -4194,6 +4210,10 @@ interface HeatPipePrototype extends EntityWithOwnerPrototype {
     connection_sprites?: ConnectableEntityGraphics;
     heat_buffer: HeatBuffer;
     heat_glow_sprites?: ConnectableEntityGraphics;
+    /**
+     * Must be >= 0.
+     */
+    heating_radius?: float;
 }
 /**
  * Used to attach graphics for {@link cursor boxes | prototype:CursorBoxType} to entities during runtime. HighlightBoxEntity can also be independent from entities so it is simply drawn somewhere in the world. See {@link LuaSurface::create_entity | runtime:LuaSurface::create_entity} for the available options for type "highlight-box".
@@ -4335,6 +4355,7 @@ interface InserterPrototype extends EntityWithOwnerPrototype {
      * Stack size bonus that is inherent to the prototype without having to be researched.
      */
     stack_size_bonus?: uint8;
+    starting_distance?: double;
     /**
      * Whether the inserter should be able to fish {@link fish | https://wiki.factorio.com/Raw_fish}.
      */
@@ -6395,6 +6416,10 @@ interface ReactorPrototype extends EntityWithOwnerPrototype {
      */
     heat_connection_patches_disconnected?: SpriteVariations;
     heat_lower_layer_picture?: Sprite;
+    /**
+     * Must be >= 0.
+     */
+    heating_radius?: double;
     light?: LightDefinition;
     lower_layer_picture?: Sprite;
     /**
@@ -7020,6 +7045,7 @@ interface RoboportPrototype extends EntityWithOwnerPrototype {
      * Defaults to the max of logistic range or construction range rounded up to chunks.
      */
     radar_range?: uint32;
+    radar_visualisation_color?: Color;
     /**
      * Minimum charge that the roboport has to have after a blackout (0 charge/buffered energy) to begin working again. Additionally, freshly placed roboports will have their energy buffer filled with `0.25 × recharge_minimum` energy.
      *
@@ -7825,7 +7851,7 @@ interface SoundPrototype {
     audible_distance_modifier?: double;
     category?: SoundType;
     /**
-     * Supported sound file formats are `.ogg` (Vorbis) and `.wav`.
+     * Supported sound file formats are `.ogg` (Vorbis and Opus) and `.wav`.
      *
      * Only loaded, and mandatory if `variations` is not defined.
      */
@@ -9188,6 +9214,7 @@ interface TurretPrototype extends EntityWithOwnerPrototype {
      */
     attacking_speed?: float;
     call_for_help_radius: double;
+    can_retarget_while_starting_attack?: bool;
     /**
      * Set of {@link circuit connector definitions | prototype:CircuitConnectorDefinition} for all directions used by this turret. Required amount of elements is based on other prototype values: 8 elements if building-direction-8-way flag is set, or 16 elements if building-direction-16-way flag is set, or 4 elements if turret_base_has_direction is set to true, or 1 element.
      */
@@ -9319,7 +9346,7 @@ interface TurretPrototype extends EntityWithOwnerPrototype {
     spawn_decorations_on_expansion?: bool;
     special_effect?: TurretSpecialEffect;
     /**
-     * When `false` turret will enter `starting_attack` state without checking its ammo or energy levels. {@link FluidTurretPrototype | prototype:FluidTurretPrototype} forces this to `true`.
+     * When `false` the turret will enter `starting_attack` state without checking its ammo or energy levels. {@link FluidTurretPrototype | prototype:FluidTurretPrototype} forces this to `true`.
      */
     start_attacking_only_when_can_shoot?: bool;
     starting_attack_animation?: RotatedAnimation8Way;
@@ -9331,6 +9358,9 @@ interface TurretPrototype extends EntityWithOwnerPrototype {
     starting_attack_speed_secondary?: float;
     starting_attack_speed_when_killed?: float;
     starting_attack_starting_progress_when_killed?: float;
+    /**
+     * When `true` the turret's collision box will affected by its rotation.
+     */
     turret_base_has_direction?: bool;
     unfolds_before_dying?: bool;
 }
@@ -9469,7 +9499,7 @@ interface UseEntityInEnergyProductionAchievementPrototype extends AchievementPro
     consumed_condition = "uranium-fuel-cell"
     ```
      */
-    consumed_condition?: ItemID;
+    consumed_condition?: ItemIDFilter;
     /**
      * This entity is needed to produce energy, for the player to complete the achievement.
      * @example ```
@@ -9477,6 +9507,10 @@ interface UseEntityInEnergyProductionAchievementPrototype extends AchievementPro
     ```
      */
     entity: EntityID;
+    /**
+     * This item needs to be produced before gaining the achievement.
+     */
+    produced_condition?: ItemIDFilter;
     /**
      * This item need to be built before gaining the achievement.
      * @example ```
@@ -9833,6 +9867,9 @@ interface UtilitySounds extends PrototypeBase {
     rotated_medium: Sound;
     rotated_small: Sound;
     scenario_message: Sound;
+    /**
+     * Only present when the Space Age mod is loaded.
+     */
     segment_dying_sound?: Sound;
     smart_pipette: Sound;
     switch_gun: Sound;
@@ -10277,7 +10314,10 @@ interface UtilitySprites extends PrototypeBase {
     pin_center: Sprite;
     pipeline_disabled_icon: Sprite;
     placement_indicator_leg: Sprite;
-    platform_entity_build_animations: EntityBuildAnimations;
+    /**
+     * Only present when the Space Age mod is loaded.
+     */
+    platform_entity_build_animations?: EntityBuildAnimations;
     play: Sprite;
     played_dark_green: Sprite;
     played_green: 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.23
+// Factorio version 2.0.27
 // API version 6
 
 declare namespace prototype {
@@ -2099,6 +2099,8 @@ interface BurnerEnergySource extends BaseEnergySource {
      */
     fuel_categories?: FuelCategoryID[];
     fuel_inventory_size: ItemStackIndex;
+    initial_fuel?: ItemID;
+    initial_fuel_percent?: double;
     light_flicker?: LightFlickeringDefinition;
     smoke?: SmokeSource[];
     type: 'burner';
@@ -2305,6 +2307,12 @@ interface CharacterArmorAnimation {
     idle_with_gun_in_air?: RotatedAnimation;
     landing?: RotatedAnimation;
     mining_with_tool: RotatedAnimation;
+    /**
+     * List of positions in the mining with tool animation when the mining sound and mining particles are created.
+     *
+     * Overrides {@link CharacterPrototype::mining_with_tool_particles_animation_positions | prototype:CharacterPrototype::mining_with_tool_particles_animation_positions} if defined
+     */
+    mining_with_tool_particles_animation_positions?: float[];
     running?: RotatedAnimation;
     /**
      * Must contain exactly 18 or 40 directions, so all of the combination of gun direction and moving direction can be covered. Some of these variations are used in reverse to save space. You can use the character animation in the base game for reference.
@@ -3404,6 +3412,11 @@ interface DamageParameters {
      */
     type: DamageTypeID;
 }
+interface DamageTileTriggerEffectItem extends TriggerEffectItem {
+    damage: DamageParameters;
+    radius?: float;
+    type: 'damage';
+}
 interface DamageTriggerEffectItem extends TriggerEffectItem {
     apply_damage_to_trees?: bool;
     damage: DamageParameters;
@@ -3691,15 +3704,10 @@ interface DropItemTipTrigger extends CountBasedTipTrigger {
     type: 'drop-item';
 }
 /**
- * When applied to {@link modules | prototype:ModulePrototype}, the resulting effect is a sum of all module effects, multiplied through calculations: `(1 + sum module effects)` or, for productivity `(0 + sum)`.
+ * When applied to {@link modules | prototype:ModulePrototype}, the resulting effect is a sum of all module effects, multiplied through calculations: `(1 + sum module effects)`, or `(0 + sum)` for productivity. Quality calculations follow their own separate logic.
  * @example ```
-effect =
-{
-  productivity = 0.04,
-  consumption = 0.4,
-  pollution = 0.05,
-  speed = -0.05
-}
+-- These are the effects of the vanilla Speed Module 3
+{speed = 0.5, consumption = 0.7, quality = -0.25}
 ```
  */
 interface Effect {
@@ -3715,6 +3723,9 @@ interface Effect {
      * Multiplied against work completed, adds to the bonus results of operating. E.g. an extra crafted recipe or immediate research bonus. The minimum possible sum is 0%.
      */
     productivity?: EffectValue;
+    /**
+     * Adds a bonus chance to increase a product's quality. The minimum possible sum is 0%. Quality is a special case because its effect value is divided by 10 internally for actual usage. This allows for one more decimal of precision, as anything beyond two decimals of effect value is ignored.
+     */
     quality?: EffectValue;
     /**
      * Modifier to crafting speed, research speed, etc. The minimum possible sum is -80%.
@@ -3765,7 +3776,10 @@ type EffectTypeLimitation = (/**
 'consumption' | /**
  * Modules that make the machine produce more or less pollution.
  */
-'pollution' | 'quality') | (/**
+'pollution' | /**
+ * Modules that provide a bonus chance to increase a product's quality.
+ */
+'quality') | (/**
  * Modules that increase or decrease the machine's speed.
  */
 'speed' | /**
@@ -3777,11 +3791,19 @@ type EffectTypeLimitation = (/**
 'consumption' | /**
  * Modules that make the machine produce more or less pollution.
  */
-'pollution' | 'quality')[];
+'pollution' | /**
+ * Modules that provide a bonus chance to increase a product's quality.
+ */
+'quality')[];
 /**
  * Precision is ignored beyond two decimals - `0.567` results in `0.56` and means 56% etc. Values can range from `-327.68` to `327.67`. Numbers outside of this range will wrap around.
+ *
+ * Quality values are divided by 10 internally, allowing for one more decimal of precision.
  * @example ```
-0.07 -- 7% bonus
+{speed = 0.07}  -- 7% bonus
+```
+ * @example ```
+{quality = 0.25}  -- 2.5% bonus
 ```
  */
 type EffectValue = float;
@@ -4499,6 +4521,14 @@ interface FluidBox {
     ```
      */
     minimum_temperature?: float;
+    /**
+     * Pipe picture variation used when owner machine is flipped. If no picture is loaded, pipe_picture is used instead.
+     */
+    mirrored_pipe_picture?: Sprite4Way;
+    /**
+     * Frozen pipe picture variation used when owner machine is flipped. If no picture is loaded, pipe_picture_frozen is used instead.
+     */
+    mirrored_pipe_picture_frozen?: Sprite4Way;
     /**
      * Connection points to connect to other fluidboxes. This is also marked as blue arrows in alt mode. Fluid may flow in or out depending on the `type` field of each connection.
      *
@@ -9029,7 +9059,7 @@ type Sound = {
     audible_distance_modifier?: double;
     category?: SoundType;
     /**
-     * Supported sound file formats are `.ogg` (Vorbis) and `.wav`.
+     * Supported sound file formats are `.ogg` (Vorbis and Opus) and `.wav`.
      *
      * Only loaded, and mandatory if `variations` is not defined.
      */
@@ -11497,6 +11527,9 @@ type TriggerEffect = (/**
  * Loaded when the `type` is `"damage"`.
  */
 DamageTriggerEffectItem | /**
+ * Loaded when the `type` is `"damage-tile"`.
+ */
+DamageTileTriggerEffectItem | /**
  * Loaded when the `type` is `"create-entity"`.
  */
 CreateEntityTriggerEffectItem | /**
@@ -11563,6 +11596,9 @@ ActivateImpactTriggerEffectItem) | (/**
  * Loaded when the `type` is `"damage"`.
  */
 DamageTriggerEffectItem | /**
+ * Loaded when the `type` is `"damage-tile"`.
+ */
+DamageTileTriggerEffectItem | /**
  * Loaded when the `type` is `"create-entity"`.
  */
 CreateEntityTriggerEffectItem | /**
@@ -11813,10 +11849,18 @@ interface UnitAISettings {
      * If enabled, units will try to separate themselves from nearby friendly units.
      */
     do_separation?: bool;
+    /**
+     * If enabled, the unit is permitted to join attack groups.
+     */
+    join_attacks?: bool;
     /**
      * Must be between -8 and 8.
      */
     path_resolution_modifier?: int8;
+    /**
+     * The amount of slots in a unit group this unit takes up. For example, a unit with `groupingSize` of 2 will count as 2 normal-sized units when filling up a unit group. Must be greater than 0.
+     */
+    size_in_group?: float;
     strafe_settings?: PrototypeStrafeSettings;
 }
 interface UnitAlternativeFrameSequence {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.16",
+  "version": "1.2.18",
   "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.23",
+  "factorioVersion": "2.0.27",
   "dependencies": {
     "lua-types": "^2.13.1"
   },