factorio-types 0.0.45 → 0.0.46

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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 declare namespace runtime {
@@ -2616,11 +2616,11 @@ interface LuaEntity extends LuaControl {
      * @remarks
      * Applies to subclasses: EntityGhost
      *
-     * @param flag - The flag to test. See [EntityPrototypeFlags](runtime:EntityPrototypeFlags) for a list of flags.
+     * @param flag - The flag to test.
      * @returns `true` if the entity has the given flag set.
      */
     ghost_has_flag(this: void,
-        flag: string): boolean
+        flag: EntityPrototypeFlag): boolean
 
     /**
      * Has this unit been assigned a command?
@@ -2635,11 +2635,11 @@ interface LuaEntity extends LuaControl {
      * @remarks
      * `entity.has_flag(f)` is a shortcut for `entity.prototype.has_flag(f)`.
      *
-     * @param flag - The flag to test. See [EntityPrototypeFlags](runtime:EntityPrototypeFlags) for a list of flags.
+     * @param flag - The flag to test.
      * @returns `true` if this entity has the given flag set.
      */
     has_flag(this: void,
-        flag: string): boolean
+        flag: EntityPrototypeFlag): boolean
 
     /**
      * All methods and properties that this object supports.
@@ -3190,12 +3190,23 @@ interface LuaEntity extends LuaControl {
     readonly beacons_count?: number
 
     /**
-     * The belt connectable neighbours of this belt connectable entity. Only entities that input to or are outputs of this entity. Does not contain the other end of an underground belt, see {@link LuaEntity::neighbours | runtime:LuaEntity::neighbours} for that. This is a dictionary with `"inputs"`, `"outputs"` entries that are arrays of transport belt connectable entities, or empty tables if no entities.
+     * The belt connectable neighbours of this belt connectable entity. Only entities that input to or are outputs of this entity. Does not contain the other end of an underground belt, see {@link LuaEntity::neighbours | runtime:LuaEntity::neighbours} for that.
      * @remarks
      * Applies to subclasses: TransportBeltConnectable
      *
      */
-    readonly belt_neighbours: {[key: string]: LuaEntity[]}
+    readonly belt_neighbours: {
+        
+        /**
+         * Array of transport belt connectable entities.
+         */
+        inputs: LuaEntity[],
+        
+        /**
+         * Array of transport belt connectable entities.
+         */
+        outputs: LuaEntity[]
+    }
 
     /**
      * Gives what is the current shape of a transport-belt.
@@ -4414,11 +4425,11 @@ interface LuaEntityPrototype {
 
     /**
      * Test whether this entity prototype has a certain flag set.
-     * @param flag - The flag to test. See [EntityPrototypeFlags](runtime:EntityPrototypeFlags) for a list of flags.
+     * @param flag - The flag to test.
      * @returns `true` if this prototype has the given flag set.
      */
     has_flag(this: void,
-        flag: string): boolean
+        flag: EntityPrototypeFlag): boolean
 
     /**
      * All methods and properties that this object supports.
@@ -4639,6 +4650,14 @@ interface LuaEntityPrototype {
      */
     readonly belt_speed?: number
 
+    /**
+     * The boiler operation mode of this boiler prototype.
+     * @remarks
+     * Applies to subclasses: Boiler
+     *
+     */
+    readonly boiler_mode?: 'heat-water-inside' | 'output-to-separate-pipe'
+
     /**
      * The braking force of this vehicle prototype.
      * @remarks
@@ -8404,6 +8423,12 @@ interface LuaGameScript {
     remove_path(this: void,
         path: string): void
 
+    /**
+     * Direct access to Trains Pathfinder. Allows to search rail paths or querying which stops are accessible
+     */
+    request_train_path(this: void,
+        request: TrainPathFinderRequest): TrainPathFinderPathResult | TrainPathAnyGoalResult | TrainPathAllGoalsResult
+
     /**
      * Reset scenario state (game_finished, player_won, etc.).
      */
@@ -9326,8 +9351,8 @@ interface LuaGuiElement {
      * @remarks
      * Applies to subclasses: textfield,text-box
      *
-     * @param end - The index of the last character to select
-     * @param start - The index of the first character to select
+     * @param end_index - The index of the last character to select
+     * @param start_index - The index of the first character to select
      * @example
      * Select the characters `amp` from `example`: 
      * ```
@@ -9342,8 +9367,8 @@ interface LuaGuiElement {
      *
      */
     select(this: void,
-        start: number,
-        end: number): void
+        start_index: number,
+        end_index: number): void
 
     /**
      * Selects all the text in this textbox.
@@ -9578,6 +9603,11 @@ interface LuaGuiElement {
      */
     elem_filters?: ItemPrototypeFilter | TilePrototypeFilter | EntityPrototypeFilter | FluidPrototypeFilter | RecipePrototypeFilter | DecorativePrototypeFilter | AchievementPrototypeFilter | EquipmentPrototypeFilter | TechnologyPrototypeFilter
 
+    /**
+     * The element tooltip to display when hovering over this element, or `nil`.
+     */
+    elem_tooltip?: ElemID
+
     /**
      * The elem type of this choose-elem-button.
      * @remarks
@@ -10390,10 +10420,10 @@ interface LuaItemPrototype {
 
     /**
      * Does this prototype have a flag enabled?
-     * @param flag - The flag to check. Can be one of [ItemPrototypeFlags](runtime:ItemPrototypeFlags). Any other value will cause an error.
+     * @param flag - The flag to check.
      */
     has_flag(this: void,
-        flag: string): boolean
+        flag: ItemPrototypeFlag): boolean
 
     /**
      * All methods and properties that this object supports.
@@ -12048,18 +12078,16 @@ interface LuaLogisticNetwork {
     /**
      * Get the amount of items of the given type indexed by the storage member.
      * @param item - Item name to check.
-     * @returns A mapping of member types ("storage", "passive-provider", "buffer", "active-provider") to the number available in the members.
      */
     get_supply_counts(this: void,
-        item: string): {[key: string]: number}
+        item: string): LogisticsNetworkSupplyCounts
 
     /**
      * Gets the logistic points with of the given type indexed by the storage member.
      * @param item - Item name to check.
-     * @returns A mapping of member types ("storage", "passive-provider", "buffer", "active-provider") to an array of LuaLogisticPoint.
      */
     get_supply_points(this: void,
-        item: string): {[key: string]: LuaLogisticPoint[]}
+        item: string): LogisticsNetworkSupplyPoints
 
     /**
      * All methods and properties that this object supports.
@@ -16561,8 +16589,8 @@ interface LuaSurface {
         }): LuaEntity[]
 
     /**
-     * Find an entity of the given type at the given position. This checks both the exact position and the bounding box of the entity.
-     * @param entity - Entity to look for.
+     * Find an entity of the given name at the given position. This checks both the exact position and the bounding box of the entity.
+     * @param entity - Name of the entity to look for.
      * @param position - Coordinates to look at.
      * @example
      * ```
@@ -17778,9 +17806,26 @@ interface LuaTrain {
     readonly killed_players: {[key: number]: number}
 
     /**
-     * Arrays of locomotives. The result is two arrays, indexed by `"front_movers"` and `"back_movers"` containing the locomotives. E.g. `{front_movers={loco1, loco2}, back_movers={loco3}}`.
+     * Locomotives of the train.
+     * @example
+     * ```
+     * -- called on a LuaTrain with 3 locomotives, it returns 3 LuaEntities:
+     * train.locomotives -- => {front_movers = {loco1, loco2}, back_movers = {loco3}}
+     * ```
+     *
      */
-    readonly locomotives: {[key: string]: LuaEntity[]}
+    readonly locomotives: {
+        
+        /**
+         * Array of locomotives.
+         */
+        back_movers: LuaEntity[],
+        
+        /**
+         * Array of locomotives.
+         */
+        front_movers: LuaEntity[]
+    }
 
     /**
      * When `true`, the train is explicitly controlled by the player or script. When `false`, the train moves autonomously according to its schedule.
@@ -18437,6 +18482,11 @@ interface LuaGuiElementAddParams {
      */
     'caption'?: LocalisedString
 
+    /**
+     * Elem tooltip of the child element. Will be displayed above `tooltip`.
+     */
+    'elem_tooltip'?: ElemID
+
     /**
      * Whether the child element is enabled. Defaults to `true`.
      */

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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 declare namespace runtime {
@@ -772,6 +772,19 @@ interface DragTarget {
     target_wire_id?: defines.wire_connection_id
 }
 
+interface ElemID {
+    
+    /**
+     * Name of a prototype as defined by `type`.
+     */
+    name: string,
+    
+    /**
+     * One of `"achievement"`, `"decorative"`, `"entity"`, `"equipment"`, `"fluid"`, `"item"`, `"item-group"`, `"recipe"`, `"signal"`, or `"technology"`.
+     */
+    type: string
+}
+
 /**
  * These values represent a percentual increase in evolution. This means a value of `0.1` would increase evolution by 10%.
  */
@@ -895,6 +908,11 @@ interface EnemyExpansionMapSettings {
  */
 type EntityPrototypeFilter = EntityPrototypeFilterBuildBaseEvolutionRequirement | EntityPrototypeFilterCollisionMask | EntityPrototypeFilterCraftingCategory | EntityPrototypeFilterEmissions | EntityPrototypeFilterFlag | EntityPrototypeFilterName | EntityPrototypeFilterSelectionPriority | EntityPrototypeFilterType | DefaultEntityPrototypeFilter
 
+/**
+ * A {@link string | runtime:string} specifying an entity prototype flag.
+ */
+type EntityPrototypeFlag = /* Prevents the entity from being rotated before or after placement. */ 'not-rotatable' | /* Determines the default force when placing entities in the map editor and using the "AUTO" option for the force. */ 'placeable-neutral' | /* Determines the default force when placing entities in the map editor and using the "AUTO" option for the force. */ 'placeable-player' | /* Determines the default force when placing entities in the map editor and using the "AUTO" option for the force. */ 'placeable-enemy' | /* Determines whether the entity needs to be aligned with the invisible grid within the world. Most entities are confined in this way, with a few exceptions such as trees and land mines. */ 'placeable-off-grid' | /* Makes it possible to blueprint, deconstruct, and repair the entity (which can be turned off again using the specific flags). Makes it possible for the biter AI to target the entity as a distraction. Enables dust to automatically be created when building the entity. If the entity does not have a `map_color` set, this flag makes the entity appear on the map with the default color specified by the UtilityConstants. */ 'player-creation' | /* Uses 45 degree angle increments when selecting direction. */ 'building-direction-8-way' | /* Used to automatically detect the proper direction of the entity if possible. Used by the pump, train stop, and train signal by default. */ 'filter-directions' | /* Fast replace will not apply when building while moving. */ 'fast-replaceable-no-build-while-moving' | /* Used to specify that the entity breathes air, and is thus affected by poison. */ 'breaths-air' | /* Used to specify that the entity can not be 'healed' by repair packs. */ 'not-repairable' | /* Prevents the entity from being drawn on the map. */ 'not-on-map' | /* Prevents the entity from being deconstructed. */ 'not-deconstructable' | /* Prevents the entity from being part of a blueprint. */ 'not-blueprintable' | /* Hides the entity from the bonus GUI and from the "made in"-property of recipe tooltips. */ 'hidden' | /* Hides the alt-info of this entity when in alt-mode. */ 'hide-alt-info' | /* Does not fast replace this entity over other entity types when building while moving. */ 'fast-replaceable-no-cross-type-while-moving' | 'no-gap-fill-while-building' | /* Does not apply fire stickers to the entity. */ 'not-flammable' | /* Prevents inserters and loaders from taking items from this entity. */ 'no-automated-item-removal' | /* Prevents inserters and loaders from inserting items into this entity. */ 'no-automated-item-insertion' | /* Prevents the entity from being copy-pasted. */ 'no-copy-paste' | /* Disallows selection of the entity even when a selection box is specified for other reasons. For example, selection boxes are used to determine the size of outlines to be shown when highlighting entities inside electric pole ranges. */ 'not-selectable-in-game' | /* Prevents the entity from being selected by the upgrade planner. */ 'not-upgradable' | /* Prevents the entity from being shown in the kill statistics. */ 'not-in-kill-statistics' | /* Prevents the entity from being shown in the "made in" list in recipe tooltips. */ 'not-in-made-in'
+
 /**
  * A set of flags. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  * 
@@ -1194,6 +1212,13 @@ type GuiLocation = {
     y: number
 }
 
+interface GunShift4Way {
+    east: Vector,
+    north: Vector,
+    south: Vector,
+    west: Vector
+}
+
 interface HeatConnection {
     direction: defines.direction,
     position: Vector
@@ -1300,6 +1325,11 @@ interface InventoryFilter {
  */
 type ItemPrototypeFilter = ItemPrototypeFilterBurntResult | ItemPrototypeFilterDefaultRequestAmount | ItemPrototypeFilterFlag | ItemPrototypeFilterFuelAccelerationMultiplier | ItemPrototypeFilterFuelCategory | ItemPrototypeFilterFuelEmissionsMultiplier | ItemPrototypeFilterFuelTopSpeedMultiplier | ItemPrototypeFilterFuelValue | ItemPrototypeFilterName | ItemPrototypeFilterPlaceAsTile | ItemPrototypeFilterPlaceResult | ItemPrototypeFilterPlacedAsEquipmentResult | ItemPrototypeFilterStackSize | ItemPrototypeFilterSubgroup | ItemPrototypeFilterType | ItemPrototypeFilterWireCount | DefaultItemPrototypeFilter
 
+/**
+ * A {@link string | runtime:string} specifying an item prototype flag.
+ */
+type ItemPrototypeFlag = /* Determines whether the logistics areas of roboports should be drawn when holding this item. Used by the deconstruction planner by default. */ 'draw-logistic-overlay' | /* Hides the item in the logistic requests and filters GUIs (among others). */ 'hidden' | /* Always shows the item in the logistic requests and filters GUIs (among others) even when the recipe for that item is locked. */ 'always-show' | /* Hides the item from the bonus GUI. */ 'hide-from-bonus-gui' | /* Hides the item from the tooltip that's shown when hovering over a burner inventory. */ 'hide-from-fuel-tooltip' | /* Prevents the item from being stacked. It also prevents the item from stacking in assembling machine input slots, which can otherwise exceed the item stack size if required by the recipe. Additionally, the item does not show an item count when in the cursor. */ 'not-stackable' | /* Makes the item act as an extension to the inventory that it is placed in. Only has an effect for items with inventory. */ 'can-extend-inventory' | /* 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. */ '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. */ 'only-in-cursor' | /* Allows the item to be spawned by a quickbar shortcut or custom input. */ 'spawnable'
+
 /**
  * A set of flags. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  * 
@@ -1429,6 +1459,36 @@ interface LogisticParameters {
     name?: string
 }
 
+interface LogisticsNetworkSupplyCounts {
+    
+    /**
+     * Number of available items in the active provider members.
+     */
+    'active-provider': number,
+    
+    /**
+     * Number of available items in the buffer members.
+     */
+    buffer: number,
+    
+    /**
+     * Number of available items in the passive provider members.
+     */
+    'passive-provider': number,
+    
+    /**
+     * Number of available items in the storage members.
+     */
+    storage: number
+}
+
+interface LogisticsNetworkSupplyPoints {
+    'active-provider': LuaLogisticPoint[],
+    buffer: LuaLogisticPoint[],
+    'passive-provider': LuaLogisticPoint[],
+    storage: LuaLogisticPoint[]
+}
+
 interface Loot {
     
     /**
@@ -2418,6 +2478,11 @@ interface RadiusVisualisationSpecification {
     offset: Vector
 }
 
+interface RailEnd {
+    direction: defines.rail_direction,
+    rail: LuaEntity
+}
+
 /**
  * The smooth orientation. It is a {@link float | runtime:float} in the range `[0, 1)` that covers a full circle, starting at the top and going clockwise. This means a value of `0` indicates "north", a value of `0.5` indicates "south".
  * 
@@ -2769,6 +2834,144 @@ type TilePosition = {
  */
 type TilePrototypeFilter = TilePrototypeFilterCollisionMask | TilePrototypeFilterDecorativeRemovalProbability | TilePrototypeFilterEmissions | TilePrototypeFilterVehicleFrictionModifier | TilePrototypeFilterWalkingSpeedModifier | DefaultTilePrototypeFilter
 
+interface TrainPathAllGoalsResult {
+    
+    /**
+     * Table of the same length as requested goals: each field will tell if related goal is accessible for the train
+     */
+    accessible: boolean[],
+    
+    /**
+     * Amount of goals that are accessible
+     */
+    amount_accessible: number,
+    
+    /**
+     * Table of the same length as requested goals. Only present if request type was "all-goals-penalties"
+     */
+    penalties?: number[],
+    
+    /**
+     * Amount of steps pathfinder performed. This is a measure of how expensive this search was.
+     */
+    steps_count: number
+}
+
+interface TrainPathAnyGoalResult {
+    
+    /**
+     * True if any goal was accessible
+     */
+    found_path: boolean,
+    
+    /**
+     * If any goal was accessible, this gives index of the particular goal that was found
+     */
+    goal_index?: number,
+    
+    /**
+     * Penalty of the path to goal if a goal was accessible
+     */
+    penalty?: number,
+    
+    /**
+     * Amount of steps pathfinder performed. This is a measure of how expensive this search was.
+     */
+    steps_count: number
+}
+
+interface TrainPathFinderPathResult {
+    
+    /**
+     * True if found path.
+     */
+    found_path: boolean,
+    
+    /**
+     * If path was found, provides index of the specific goal to which the path goes to
+     */
+    goal_index?: number,
+    
+    /**
+     * If path was found, tells if the path was reached from the from_front or train's front end.
+     */
+    is_front?: boolean,
+    
+    /**
+     * Only returned if return_path was set to true and path was found. Contains all rails in order that are part of the found path
+     */
+    path?: LuaEntity[],
+    
+    /**
+     * Penalty of the path to goal if path was found
+     */
+    penalty?: number,
+    
+    /**
+     * Amount of steps pathfinder performed. This is a measure of how expensive this search was.
+     */
+    steps_count: number,
+    
+    /**
+     * If path was found, provides total length of all rails of the path
+     */
+    total_length?: number
+}
+
+interface TrainPathFinderRequest {
+    
+    /**
+     * Only relevant if from_back is given. Defaults to true. Providing false will cause the pathfinder to reject a path that starts on back and ends within the same segment as the path would be too short to provide correct alignment with a goal.
+     */
+    allow_path_within_segment_back?: boolean,
+    
+    /**
+     * Only relevant if from_front is given. Defaults to true. Providing false will cause the pathfinder to reject a path that starts on front and ends within the same segment as the path would be too short to provide correct alignment with a goal.
+     */
+    allow_path_within_segment_front?: boolean,
+    
+    /**
+     * Manually provided starting back of the train.
+     */
+    from_back?: RailEnd,
+    
+    /**
+     * Manually provided starting front of the train.
+     */
+    from_front?: RailEnd,
+    goals: Array<TrainStopGoal | RailEnd>,
+    
+    /**
+     * Defaults to false. If set to true, pathfinder will not return a path that cannot have its beginning immediately reserved causing train to stop inside of intersection.
+     */
+    in_chain_signal_section?: boolean,
+    
+    /**
+     * Only relevant if request type is "path". Returning a full path is expensive due to multiple LuaEntity created. In order for path to be returned, true must be provided here. Defaults to false in which case a path will not be provided.
+     */
+    return_path?: boolean,
+    
+    /**
+     * Only relevant if none of from_front/from_back was provied in which case from_front and from_back are deduced from the train. Selects which train ends should be considered as starts. Possible values: "respect-movement-direction", "any-direction-with-locomotives". Defaults to "any-direction-with-locomotives"
+     */
+    search_direction?: string,
+    
+    /**
+     * Maximum amount of steps pathfinder is allowed to perform
+     */
+    steps_limit?: number,
+    
+    /**
+     * Mandatory if from_front and from_back are not provided, optional otherwise. Selects a context for the pathfinder to decide which train to exclude from penalties and which signals are considered possible to reacquire. If from_front and from_back are not provided, then it is also used to collect front and back ends for the search
+     */
+    train?: LuaTrain,
+    
+    /**
+     * Request type. "path", "any-goal-accessible", "all-goals-accessible" or "all-goals-penalties". Defaults to "path"
+     */
+    type?: string
+}
+
 interface TrainSchedule {
     
     /**
@@ -2802,6 +3005,14 @@ interface TrainScheduleRecord {
     wait_conditions?: WaitCondition[]
 }
 
+interface TrainStopGoal {
+    
+    /**
+     * Train stop target. Must be connected to rail (LuaEntity::connected_rail returns valid LuaEntity)
+     */
+    train_stop: LuaEntity
+}
+
 interface TriggerDelivery {
     source_effects: TriggerEffectItem[],
     target_effects: TriggerEffectItem[],
@@ -3146,7 +3357,7 @@ interface AttackParametersStream extends BaseAttackParameters {
     fluid_consumption: number,
     fluids?: AttackParameterFluid[],
     gun_barrel_length: number,
-    gun_center_shift: {[key: string]: Vector},
+    gun_center_shift: GunShift4Way,
     projectile_creation_parameters?: CircularProjectileCreationSpecification[]
 }
 

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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 /**

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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 declare namespace prototype {
@@ -446,7 +446,7 @@ When using an array of AmmoTypes, they have the additional {@link AmmoType::sour
 }
 
 /**
- * A turret that consumes ammo items.
+ * A turret that consumes {@link ammo items | prototype:AmmoItemPrototype}.
  */
 interface AmmoTurretPrototype extends TurretPrototype{
     automated_ammo_count: ItemCountType,
@@ -2563,7 +2563,7 @@ Max value is 64.
 }
 
 /**
- * A turret that consumes electricity as ammo.
+ * A turret that uses electricity as ammunition.
  */
 interface ElectricTurretPrototype extends TurretPrototype{
     energy_source: ElectricEnergySource | VoidEnergySource
@@ -2629,7 +2629,7 @@ interface EnemySpawnerPrototype extends EntityWithOwnerPrototype{
     spawn_decorations_on_expansion?: boolean,
     
     /**
-     * Ticks for cooldown after unit is spawned
+     * Ticks for cooldown after unit is spawned. The first member of the tuple is min, the second member of the tuple is max.
      */
     spawning_cooldown: 
 [    number,
@@ -2890,7 +2890,7 @@ The item count specified here can't be larger than the stack size of that item.
     /**
      * Specification of the entity selection area. When empty the entity will have no selection area (and thus is not selectable).
 
-The selection box is usually a little bit bigger than the collision box, for tileable entities (like buildings) it should match the tile size of the building.
+The selection box is usually a little bit bigger than the collision box. For tileable entities (like buildings) it should match the tile size of the building.
      */
     selection_box?: BoundingBox,
     
@@ -3502,12 +3502,12 @@ interface FluidStreamPrototype extends EntityPrototype{
 }
 
 /**
- * A turret that consumes fluid as ammo.
+ * A turret that uses {@link fluid | prototype:FluidPrototype} as ammunition.
  */
 interface FluidTurretPrototype extends TurretPrototype{
     
     /**
-     * Before an turret that was out of ammo is able to fire again, the `fluid_buffer_size` must fill to this proportion.
+     * Before an turret that was out of fluid ammunition is able to fire again, the `fluid_buffer_size` must fill to this proportion.
      */
     activation_buffer_ratio: number,
     
@@ -3528,6 +3528,10 @@ interface FluidTurretPrototype extends TurretPrototype{
     muzzle_light?: LightDefinition,
     not_enough_fuel_indicator_light?: LightDefinition,
     not_enough_fuel_indicator_picture?: Sprite4Way,
+    
+    /**
+     * The sprite will be drawn on top of fluid turrets that are out of fluid ammunition. If the `out_of_ammo_alert_icon` is not set, {@link UtilitySprites::fluid_icon | prototype:UtilitySprites::fluid_icon} will be used instead.
+     */
     out_of_ammo_alert_icon?: Sprite,
     prepared_muzzle_animation_shift?: AnimatedVector,
     preparing_muzzle_animation_shift?: AnimatedVector,
@@ -4195,7 +4199,9 @@ Mandatory if `icons` is not defined, or if `icon_size` is not specified for all
     open_sound?: Sound,
     
     /**
-     * Used to give the item multiple different icons so that they look less uniform on belts etc. For inventory icons and similar, `icon/icons` will be used. Maximum number of variations is 16.
+     * Used to give the item multiple different icons so that they look less uniform on belts. For inventory icons and similar, `icon/icons` will be used. Maximum number of variations is 16.
+
+When using sprites of size `64` (same as base game icons), the `scale` should be set to 0.25.
      */
     pictures?: SpriteVariations,
     place_as_tile?: PlaceAsTile,
@@ -8577,7 +8583,7 @@ interface TransportBeltConnectablePrototype extends EntityWithOwnerPrototype{
     ends_with_stopper?: boolean,
     
     /**
-     * Transport belt connectable entities cannot have the "placeable-off-grid" flag specified.
+     * Transport belt connectable entities cannot have any of the following flags: "placeable-off-grid", "building-direction-8-way".
      */
     flags?: EntityPrototypeFlags,
     
@@ -9579,6 +9585,10 @@ interface UtilitySprites extends PrototypeBase{
     export: Sprite,
     export_slot: Sprite,
     favourite_server_icon: Sprite,
+    
+    /**
+     * The sprite will be drawn on top of {@link fluid turrets | prototype:FluidTurretPrototype} that are out of fluid ammunition and don't have {@link FluidTurretPrototype::out_of_ammo_alert_icon | prototype:FluidTurretPrototype::out_of_ammo_alert_icon} set.
+     */
     fluid_icon: Sprite,
     fluid_indication_arrow: Sprite,
     fluid_indication_arrow_both_ways: 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 1.1.100
+// Factorio version 1.1.101
 // API version 4
 
 declare namespace prototype {
@@ -454,6 +454,67 @@ interface AnimationSheet extends AnimationParameters{
     variation_count: number
 }
 
+/**
+ * @example
+ * ```
+ * -- array of animations
+ * animations =
+ * {
+ *   {
+ *     filename = "__base__/graphics/entity/explosion-gunshot/explosion-gunshot.png",
+ *     draw_as_glow = true,
+ *     priority = "extra-high",
+ *     width = 34,
+ *     height = 38,
+ *     frame_count = 2,
+ *     animation_speed = 1.5,
+ *     shift = {0, 0}
+ *   },
+ *   {
+ *     filename = "__base__/graphics/entity/explosion-gunshot/explosion-gunshot.png",
+ *     draw_as_glow = true,
+ *     priority = "extra-high",
+ *     width = 34,
+ *     height = 38,
+ *     x = 34 * 2,
+ *     frame_count = 2,
+ *     animation_speed = 1.5,
+ *     shift = {0, 0}
+ *   },
+ *   -- [...]
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * -- animation sheet using "sheet"
+ * pictures =
+ * {
+ *   sheet =
+ *   {
+ *     filename = "__base__/graphics/entity/character/footprints.png",
+ *     line_length = 2,
+ *     frame_count = 2,
+ *     width = 15,
+ *     height = 11,
+ *     shift = util.by_pixel(0.5, 0.5),
+ *     variation_count = 8,
+ *     hr_version =
+ *     {
+ *       filename = "__base__/graphics/entity/character/hr-footprints.png",
+ *       line_length = 2,
+ *       frame_count = 2,
+ *       width = 30,
+ *       height = 22,
+ *       shift = util.by_pixel(0.25, 0.25),
+ *       scale = 0.5,
+ *       variation_count = 8
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ */
 type AnimationVariations = {
     
     /**
@@ -1456,7 +1517,7 @@ Only loaded if `fuel_categories` is not defined.
     smoke?: SmokeSource[],
     
     /**
-     * This is mandatory if the energy source can be loaded as multiple energy source types.
+     * This is only loaded, and mandatory if the energy source can be loaded as multiple energy source types.
      */
     type?: 'burner'
 }
@@ -1849,7 +1910,7 @@ type CollisionMaskLayer = 'ground-tile' | 'water-tile' | 'resource-layer' | 'doo
 /**
  * Table of red, green, blue, and alpha float values between 0 and 1. Alternatively, values can be from 0-255, they are interpreted as such if at least one value is `> 1`.
  * 
- * Color allows the short-hand notation of passing an array of exactly 3 or 4 numbers.
+ * Color allows the short-hand notation of passing an array of exactly 3 or 4 numbers. The array items are r, g, b and optionally a, in that order.
  * 
  * The game usually expects colors to be in pre-multiplied form (color channels are pre-multiplied by alpha).
  * @example
@@ -2483,7 +2544,7 @@ interface ElectricEnergySource extends BaseEnergySource{
     output_flow_limit?: Energy,
     
     /**
-     * This is mandatory if the energy source can be loaded as multiple energy source types.
+     * This is only loaded, and mandatory if the energy source can be loaded as multiple energy source types.
      */
     type?: 'electric',
     usage_priority: ElectricUsagePriority
@@ -2799,13 +2860,19 @@ type EntityID = string
 
 /**
  * An array containing the following values.
+ * 
+ * If an entity is a {@link building | runtime:LuaEntityPrototype::is_building} and has the `"player-creation"` flag set, it is considered for multiple enemy/unit behaviors:
+ * 
+ * - Autonomous enemy attacks (usually triggered by pollution) can only attack within chunks that contain at least one entity that is both a building and a player-creation.
+ * 
+ * - Enemy expansion considers entities that are both buildings and player-creations as "enemy" entities that may block expansion.
  * @example
  * ```
  * flags = {"placeable-neutral", "player-creation"}
  * ```
  *
  */
-type EntityPrototypeFlags = Array</* Can't be rotated before or after placing. */ 'not-rotatable' | /* Determines the default force when placing entities in the map editor and using the *AUTO* option for the force. */ 'placeable-neutral' | /* Determines the default force when placing entities in the map editor and using the *AUTO* option for the force. */ 'placeable-player' | /* Determines the default force when placing entities in the map editor and using the *AUTO* option for the force. */ 'placeable-enemy' | /* Refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with this flag do not have to line up with this grid (like trees and land-mines). */ 'placeable-off-grid' | /* Makes it possible for the biter AI to target the entity as a distraction in distraction mode {@link by_anything | runtime:defines.distraction.by_anything}. Makes it possible to blueprint, deconstruct, and repair the entity (can be turned off again using the specific flags). Enables smoke to be created automatically when building the entity. If the entity does not have {@link EntityPrototype::map_color | prototype:EntityPrototype::map_color} set, this flag makes the entity appear on the map/minimap with the default color specified in the {@link UtilityConstants | prototype:UtilityConstants}. Entities that are {@link buildings | runtime:LuaEntityPrototype::is_building} and have this flag set are considered for multiple enemy/unit behaviors: [1] Autonomous enemy attacks (usually triggered by pollution) can only attack within chunks that contain at least one entity that is both a building and a player-creation. [2] Enemy expansion considers entities that are both buildings and player-creations as "enemy" entities that may block expansion. */ 'player-creation' | /* Uses 45 degree angle increments when selecting direction. */ 'building-direction-8-way' | /* Used to automatically detect the proper direction, if possible. Used by base with the pump, train stop, and train signal. */ 'filter-directions' | /* Fast replace will not apply when building while moving. */ 'fast-replaceable-no-build-while-moving' | /* This is used to specify that the entity breathes air, and so is affected by poison (currently {@link poison capsules | https://wiki.factorio.com/Poison_capsule} are the only source). */ 'breaths-air' | /* Used to specify that the entity can not be 'healed' by repair-packs (or construction robots with repair packs) */ 'not-repairable' | /* The entity does not get drawn on the map. */ 'not-on-map' | /* The entity can not be deconstructed. */ 'not-deconstructable' | /* The entity can not be used in blueprints. */ 'not-blueprintable' | /* Hides the entity from the bonus GUI (button above the map) and from the made in property of recipe tooltips. */ 'hidden' | /* Hides the alt-info of an entity in alt-mode, for example the recipe icon. */ 'hide-alt-info' | /* Do not fast replace over other entity types when building while moving. */ 'fast-replaceable-no-cross-type-while-moving' | 'no-gap-fill-while-building' | /* Do not apply fire stickers to the entity. */ 'not-flammable' | /* Prevents inserters and loaders from taking items from this entity. */ 'no-automated-item-removal' | /* Prevents inserters and loaders from inserting items into this entity. */ 'no-automated-item-insertion' | /* This flag does nothing when set in the data stage because it gets overridden by {@link EntityPrototype::allow_copy_paste | prototype:EntityPrototype::allow_copy_paste}. Thus, it must be set on the entity via that property. */ 'no-copy-paste' | /* Disallows selection of the entity even when a selection box is specified for other reasons. For example, selection boxes are used to determine the size of outlines to be shown when highlighting entities inside electric pole ranges. This flag does nothing when set in the data stage because it gets overridden by {@link EntityPrototype::selectable_in_game | prototype:EntityPrototype::selectable_in_game}. Thus, it must be set on the entity via that property. */ 'not-selectable-in-game' | /* The entity can't be selected by the {@link upgrade planner | https://wiki.factorio.com/Upgrade_planner}. */ 'not-upgradable' | /* The entity is not shown in the kill statistics. */ 'not-in-kill-statistics' | /* The entity is not shown in the made in property of recipe tooltips. */ 'not-in-made-in'>
+type EntityPrototypeFlags = Array</* Can't be rotated before or after placing. */ 'not-rotatable' | /* Determines the default force when placing entities in the map editor and using the *AUTO* option for the force. */ 'placeable-neutral' | /* Determines the default force when placing entities in the map editor and using the *AUTO* option for the force. */ 'placeable-player' | /* Determines the default force when placing entities in the map editor and using the *AUTO* option for the force. */ 'placeable-enemy' | /* Refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with this flag do not have to line up with this grid (like trees and land-mines). */ 'placeable-off-grid' | /* Makes it possible for the biter AI to target the entity as a distraction in distraction mode {@link by_anything | runtime:defines.distraction.by_anything}. Makes it possible to blueprint, deconstruct, and repair the entity (can be turned off again using the specific flags). Enables smoke to be created automatically when building the entity. If the entity does not have {@link EntityPrototype::map_color | prototype:EntityPrototype::map_color} set, this flag makes the entity appear on the map/minimap with the default color specified in the {@link UtilityConstants | prototype:UtilityConstants}. */ 'player-creation' | /* Uses 45 degree angle increments when selecting direction. */ 'building-direction-8-way' | /* Used to automatically detect the proper direction, if possible. Used by base with the pump, train stop, and train signal. */ 'filter-directions' | /* Fast replace will not apply when building while moving. */ 'fast-replaceable-no-build-while-moving' | /* This is used to specify that the entity breathes air, and so is affected by poison (currently {@link poison capsules | https://wiki.factorio.com/Poison_capsule} are the only source). */ 'breaths-air' | /* Used to specify that the entity can not be 'healed' by repair-packs (or construction robots with repair packs) */ 'not-repairable' | /* The entity does not get drawn on the map. */ 'not-on-map' | /* The entity can not be deconstructed. */ 'not-deconstructable' | /* The entity can not be used in blueprints. */ 'not-blueprintable' | /* Hides the entity from the bonus GUI (button above the map) and from the made in property of recipe tooltips. */ 'hidden' | /* Hides the alt-info of an entity in alt-mode, for example the recipe icon. */ 'hide-alt-info' | /* Do not fast replace over other entity types when building while moving. */ 'fast-replaceable-no-cross-type-while-moving' | 'no-gap-fill-while-building' | /* Do not apply fire stickers to the entity. */ 'not-flammable' | /* Prevents inserters and loaders from taking items from this entity. */ 'no-automated-item-removal' | /* Prevents inserters and loaders from inserting items into this entity. */ 'no-automated-item-insertion' | /* This flag does nothing when set in the data stage because it gets overridden by {@link EntityPrototype::allow_copy_paste | prototype:EntityPrototype::allow_copy_paste}. Thus, it must be set on the entity via that property. */ 'no-copy-paste' | /* Disallows selection of the entity even when a selection box is specified for other reasons. For example, selection boxes are used to determine the size of outlines to be shown when highlighting entities inside electric pole ranges. This flag does nothing when set in the data stage because it gets overridden by {@link EntityPrototype::selectable_in_game | prototype:EntityPrototype::selectable_in_game}. Thus, it must be set on the entity via that property. */ 'not-selectable-in-game' | /* The entity can't be selected by the {@link upgrade planner | https://wiki.factorio.com/Upgrade_planner}. */ 'not-upgradable' | /* The entity is not shown in the kill statistics. */ 'not-in-kill-statistics' | /* The entity is not shown in the made in property of recipe tooltips. */ 'not-in-made-in'>
 
 /**
  * How far (in tiles) entities should be rendered outside the visible area of the screen.
@@ -3196,7 +3263,7 @@ type FluidID = string
 interface FluidIngredientPrototype {
     
     /**
-     * Can not be `< 0`.
+     * Can not be `<= 0`.
      */
     amount: number,
     
@@ -3859,7 +3926,7 @@ type ItemGroupID = string
 type ItemID = string
 
 /**
- * An item ingredient definition. It can be specified as a table with named or numbered keys, but not a mix of both.
+ * An item ingredient definition. It can be specified as a table with named or numbered keys, but not a mix of both. If this is specified as a table with numbered keys then the first value is the item name and the second is the amount.
  * @example
  * ```
  * {type="item", name="steel-plate", amount=8}
@@ -3888,7 +3955,7 @@ If this fluid is used in a recipe, the `catalyst_amount` is calculated automatic
 ]
 
 /**
- * An item product definition. It can be specified as a table with named or numbered keys, but not a mix of both.
+ * An item product definition. It can be specified as a table with named or numbered keys, but not a mix of both. If this is specified as a table with numbered keys then the first value is the item name and the second is the amount.
  */
 type ItemProductPrototype = {
     amount?: number,
@@ -4292,7 +4359,7 @@ interface LoaderStructure {
  * ```
  *
  */
-type LocalisedString = string | boolean | LocalisedString[]
+type LocalisedString = string | number | boolean | LocalisedString[]
 
 /**
  * The items generated when an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype} is killed.
@@ -5587,6 +5654,10 @@ type Order = string
 
 interface OrientedCliffPrototype {
     collision_bounding_box: BoundingBox,
+    
+    /**
+     * Unused.
+     */
     fill_volume: number,
     pictures: SpriteVariations
 }
@@ -7113,7 +7184,7 @@ type SoundType = 'game-effect' | 'gui-effect' | 'ambient' | 'environment' | 'wal
 /**
  * The definition of a evolution and probability weights for a {@link spawnable unit | prototype:UnitSpawnDefinition} for a {@link EnemySpawnerPrototype | prototype:EnemySpawnerPrototype}.
  * 
- * It can be specified as a table with named or numbered keys, but not a mix of both.
+ * It can be specified as a table with named or numbered keys, but not a mix of both. If this is specified as a table with numbered keys then the first value is the evolution factor and the second is the spawn weight.
  */
 type SpawnPoint = {
     evolution_factor: number,
@@ -7303,6 +7374,7 @@ interface SpotNoiseArguments {
  * When there is more than one sprite or {@link Animation | prototype:Animation} frame with the same source file and dimensions/position in the game, they all share the same memory.
  * @example
  * ```
+ * -- simple sprite
  * picture_set_enemy =
  * {
  *   filename = "__base__/graphics/entity/land-mine/land-mine-set-enemy.png",
@@ -7312,6 +7384,99 @@ interface SpotNoiseArguments {
  * }
  * ```
  *
+ * @example
+ * ```
+ * -- sprite with hr version
+ * picture =
+ * {
+ *   filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
+ *   priority = "extra-high",
+ *   width = 32,
+ *   height = 36,
+ *   shift = util.by_pixel(0.5, -2),
+ *   hr_version =
+ *   {
+ *     filename = "__base__/graphics/entity/wooden-chest/hr-wooden-chest.png",
+ *     priority = "extra-high",
+ *     width = 62,
+ *     height = 72,
+ *     shift = util.by_pixel(0.5, -2),
+ *     scale = 0.5
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * -- sprite with layers
+ * picture =
+ * {
+ *   layers =
+ *   {
+ *     {
+ *       filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
+ *       priority = "extra-high",
+ *       width = 32,
+ *       height = 36,
+ *       shift = util.by_pixel(0.5, -2)
+ *     },
+ *     {
+ *       filename = "__base__/graphics/entity/wooden-chest/wooden-chest-shadow.png",
+ *       priority = "extra-high",
+ *       width = 52,
+ *       height = 20,
+ *       shift = util.by_pixel(10, 6.5),
+ *       draw_as_shadow = true
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * -- sprite with layers and hr version
+ * picture =
+ * {
+ *   layers =
+ *   {
+ *     {
+ *       filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
+ *       priority = "extra-high",
+ *       width = 32,
+ *       height = 36,
+ *       shift = util.by_pixel(0.5, -2),
+ *       hr_version =
+ *       {
+ *         filename = "__base__/graphics/entity/wooden-chest/hr-wooden-chest.png",
+ *         priority = "extra-high",
+ *         width = 62,
+ *         height = 72,
+ *         shift = util.by_pixel(0.5, -2),
+ *         scale = 0.5
+ *       }
+ *     },
+ *     {
+ *       filename = "__base__/graphics/entity/wooden-chest/wooden-chest-shadow.png",
+ *       priority = "extra-high",
+ *       width = 52,
+ *       height = 20,
+ *       shift = util.by_pixel(10, 6.5),
+ *       draw_as_shadow = true,
+ *       hr_version =
+ *       {
+ *         filename = "__base__/graphics/entity/wooden-chest/hr-wooden-chest-shadow.png",
+ *         priority = "extra-high",
+ *         width = 104,
+ *         height = 40,
+ *         shift = util.by_pixel(10, 6.5),
+ *         draw_as_shadow = true,
+ *         scale = 0.5
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
  */
 interface Sprite extends SpriteParameters{
     
@@ -7625,19 +7790,36 @@ type SpriteSizeType = number
 /**
  * @example
  * ```
+ * -- array of sprites
  * pictures =
  * {
+ *   { size = 64, filename = "__base__/graphics/icons/coal.png",   scale = 0.25, mipmap_count = 4 },
+ *   { size = 64, filename = "__base__/graphics/icons/coal-1.png", scale = 0.25, mipmap_count = 4 },
+ *   { size = 64, filename = "__base__/graphics/icons/coal-2.png", scale = 0.25, mipmap_count = 4 },
+ *   { size = 64, filename = "__base__/graphics/icons/coal-3.png", scale = 0.25, mipmap_count = 4 }
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * -- sprite sheet using "sheet"
+ * connection_patches_connected =
+ * {
+ *   sheet =
  *   {
- *     filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-01.png",
- *     width = 105,
- *     height = 73
- *   },
- *   {
- *     filename = "__base__/graphics/entity/decorative/green-carpet-grass/green-carpet-grass-02.png",
- *     width = 185,
- *     height = 164
- *   },
- *   [...]
+ *     filename = "__base__/graphics/entity/nuclear-reactor/reactor-connect-patches.png",
+ *     width = 32,
+ *     height = 32,
+ *     variation_count = 12,
+ *     hr_version =
+ *     {
+ *       filename = "__base__/graphics/entity/nuclear-reactor/hr-reactor-connect-patches.png",
+ *       width = 64,
+ *       height = 64,
+ *       variation_count = 12,
+ *       scale = 0.5
+ *     }
+ *   }
  * }
  * ```
  *
@@ -8687,7 +8869,7 @@ interface UnitGroupSettings {
 }
 
 /**
- * It can be specified as a table with named or numbered keys, but not a mix of both.
+ * It can be specified as a table with named or numbered keys, but not a mix of both. If this is specified as a table with numbered keys then the first value is the unit and the second is the spawn points.
  */
 type UnitSpawnDefinition = {
     
@@ -8774,6 +8956,9 @@ type Vector = {
     number
 ]
 
+/**
+ * If this is specified as a three-element array then the array items are x, y and z, in that order.
+ */
 type Vector3D = {
     x: number,
     y: number,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "0.0.45",
+  "version": "0.0.46",
   "description": "Typescript declarations for the factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",
@@ -24,5 +24,5 @@
     "index.d.ts",
     "dist/**/*.d.ts"
   ],
-  "factorioVersion": "1.1.100"
+  "factorioVersion": "1.1.101"
 }