factorio-types 0.0.47 → 0.0.49

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.102
+// Factorio version 1.1.106
 // API version 4
 
 declare namespace runtime {
@@ -2019,6 +2019,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Whether this character can shoot the given entity or position.
+     * @remarks
+     * Applies to subclasses: Character
+     *
      */
     can_shoot(this: void,
         target: LuaEntity,
@@ -2113,6 +2116,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Connects the rolling stock in the given direction.
+     * @remarks
+     * Applies to subclasses: RollingStock
+     *
      * @returns Whether any connection was made
      */
     connect_rolling_stock(this: void,
@@ -2213,6 +2219,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Tries to disconnect this rolling stock in the given direction.
+     * @remarks
+     * Applies to subclasses: RollingStock
+     *
      * @returns If anything was disconnected
      */
     disconnect_rolling_stock(this: void,
@@ -2294,6 +2303,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Gets rolling stock connected to the given end of this stock.
+     * @remarks
+     * Applies to subclasses: RollingStock
+     *
      * @returns multiple values
      *  [0] - The rolling stock connected at the given end, `nil` if none is connected there.
      *  [1] - The rail direction of the connected rolling stock if any.
@@ -2863,6 +2875,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Revive a ghost. I.e. turn it from a ghost to a real entity or tile.
+     * @remarks
+     * Applies to subclasses: Ghost
+     *
      * @param table.raise_revive - If true, and an entity ghost; [script_raised_revive](runtime:script_raised_revive) will be called. Else if true, and a tile ghost; [script_raised_set_tiles](runtime:script_raised_set_tiles) will be called.
      * @param table.return_item_request_proxy - If `true` the function will return item request proxy as the third return value.
      * @returns multiple values
@@ -3024,6 +3039,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Revives a ghost silently.
+     * @remarks
+     * Applies to subclasses: Ghost
+     *
      * @param table.raise_revive - If true, and an entity ghost; [script_raised_revive](runtime:script_raised_revive) will be called. Else if true, and a tile ghost; [script_raised_set_tiles](runtime:script_raised_set_tiles) will be called.
      * @param table.return_item_request_proxy - If `true` the function will return item request proxy as the third parameter.
      * @returns multiple values
@@ -3044,6 +3062,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Only works if the entity is a speech-bubble, with an "effect" defined in its wrapper_flow_style. Starts animating the opacity of the speech bubble towards zero, and destroys the entity when it hits zero.
+     * @remarks
+     * Applies to subclasses: SpeechBubble
+     *
      */
     start_fading_out(this: void): void
 
@@ -3220,7 +3241,7 @@ interface LuaEntity extends LuaControl {
     /**
      * Whether this underground belt goes into or out of the ground.
      * @remarks
-     * Applies to subclasses: TransportBeltToGround
+     * Applies to subclasses: UndergroundBelt
      *
      */
     readonly belt_to_ground_type: 'input' | 'output'
@@ -3304,6 +3325,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The orientation of this cliff.
+     * @remarks
+     * Applies to subclasses: Cliff
+     *
      */
     readonly cliff_orientation: CliffOrientation
 
@@ -3317,6 +3341,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The owner of this combat robot, if any.
+     * @remarks
+     * Applies to subclasses: CombatRobot
+     *
      */
     combat_robot_owner?: LuaEntity
 
@@ -3368,15 +3395,15 @@ interface LuaEntity extends LuaControl {
     /**
      * Whether this corpse will ever fade away.
      * @remarks
-     * Useable only on corpses.
+     * Applies to subclasses: Corpse
      *
      */
     corpse_expires: boolean
 
     /**
-     * If true, corpse won't be destroyed when entities are placed over it. If false, whether corpse will be removed or not depends on value of CorpsePrototype::remove_on_entity_placement.
+     * If true, corpse won't be destroyed when entities are placed over it. If false, whether corpse will be removed or not depends on value of {@link CorpsePrototype::remove_on_entity_placement | prototype:CorpsePrototype::remove_on_entity_placement}.
      * @remarks
-     * Useable only on corpses.
+     * Applies to subclasses: Corpse
      *
      */
     corpse_immune_to_entity_placement: boolean
@@ -3729,6 +3756,7 @@ interface LuaEntity extends LuaControl {
      * Sets the stack size limit on this inserter. If the stack size is > than the force stack size limit the value is ignored.
      * @remarks
      * Set to 0 to reset.
+     * Applies to subclasses: Inserter
      *
      */
     inserter_stack_size_override: number
@@ -3737,6 +3765,7 @@ interface LuaEntity extends LuaControl {
      * Returns the current target pickup count of the inserter.
      * @remarks
      * This considers the circuit network, manual override and the inserter stack size limit based on technology.
+     * Applies to subclasses: Inserter
      *
      */
     readonly inserter_target_pickup_count: number
@@ -3794,6 +3823,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The link ID this linked container is using.
+     * @remarks
+     * Applies to subclasses: LinkedContainer
+     *
      */
     link_id: number
 
@@ -3965,6 +3997,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The state of this power switch.
+     * @remarks
+     * Applies to subclasses: PowerSwitch
+     *
      */
     power_switch_state: boolean
 
@@ -4007,6 +4042,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The target entity for this item-request-proxy, if any.
+     * @remarks
+     * Applies to subclasses: ItemRequestProxy
+     *
      */
     readonly proxy_target?: LuaEntity
 
@@ -4088,6 +4126,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The status of this rocket silo entity.
+     * @remarks
+     * Applies to subclasses: RocketSilo
+     *
      */
     readonly rocket_silo_status: defines.rocket_silo_status
 
@@ -4124,6 +4165,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The shooting target for this turret, if any. Can't be set to `nil` via script.
+     * @remarks
+     * Applies to subclasses: Turret
+     *
      */
     shooting_target?: LuaEntity
 
@@ -4144,6 +4188,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The spawner associated with this unit entity, if any.
+     * @remarks
+     * Applies to subclasses: Unit
+     *
      */
     readonly spawner?: LuaEntity
 
@@ -4207,6 +4254,9 @@ interface LuaEntity extends LuaControl {
 
     /**
      * The entity this sticker is sticked to.
+     * @remarks
+     * Applies to subclasses: Sticker
+     *
      */
     readonly sticked_to: LuaEntity
 
@@ -4278,10 +4328,13 @@ interface LuaEntity extends LuaControl {
     readonly tile_width: number
 
     /**
-     * The ticks left before a ghost, combat robot, highlight box or smoke with trigger is destroyed.
+     * The ticks left before a ghost, combat robot, highlight box, smoke with trigger or sticker is destroyed.
      * 
      * - for ghosts set to uint32 max (4 294 967 295) to never expire.
      * - for ghosts can not be set higher than {@link LuaForce::ghost_time_to_live | runtime:LuaForce::ghost_time_to_live} of the entity's force.
+     * @remarks
+     * Applies to subclasses: Ghost,CombatRobot,HighlightBox,SmokeWithTrigger,Sticker
+     *
      */
     time_to_live: number
 
@@ -4351,31 +4404,49 @@ interface LuaEntity extends LuaControl {
 
     /**
      * Index of the tree color.
+     * @remarks
+     * Applies to subclasses: Tree
+     *
      */
     tree_color_index: number
 
     /**
      * Maximum index of the tree colors.
+     * @remarks
+     * Applies to subclasses: Tree
+     *
      */
     readonly tree_color_index_max: number
 
     /**
      * Index of the tree gray stage
+     * @remarks
+     * Applies to subclasses: Tree
+     *
      */
     tree_gray_stage_index: number
 
     /**
      * Maximum index of the tree gray stages.
+     * @remarks
+     * Applies to subclasses: Tree
+     *
      */
     readonly tree_gray_stage_index_max: number
 
     /**
      * Index of the tree stage.
+     * @remarks
+     * Applies to subclasses: Tree
+     *
      */
     tree_stage_index: number
 
     /**
      * Maximum index of the tree stages.
+     * @remarks
+     * Applies to subclasses: Tree
+     *
      */
     readonly tree_stage_index_max: number
 
@@ -5471,8 +5542,9 @@ interface LuaEntityPrototype {
 
     /**
      * The manual range modifier for this artillery turret or wagon prototype.
-     * 
-     * subclass(ArtilleryWagon, ArtilleryTurret)
+     * @remarks
+     * Applies to subclasses: ArtilleryWagon,ArtilleryTurret
+     *
      */
     readonly manual_range_modifier?: number
 
@@ -6202,6 +6274,13 @@ interface LuaEntityPrototype {
      */
     readonly valid: boolean
 
+    /**
+     * @remarks
+     * Applies to subclasses: MiningDrill
+     *
+     */
+    readonly vector_to_place_result?: Vector
+
     /**
      * Vertical selection shift used by rolling stocks. It affects selection box vertical position but is also used to shift rolling stock graphics along the rails to fine tune train's look.
      * @remarks
@@ -8555,7 +8634,7 @@ interface LuaGameScript {
      * @param table.player - The player to focus on. Defaults to the local player.
      * @param table.position - If defined, the screenshot will be centered on this position. Otherwise, the screenshot will center on `player`.
      * @param table.quality - The `.jpg` render quality as a percentage (from 0% to 100% inclusive), if used. A lower value means a more compressed image. Defaults to `80`.
-     * @param table.resolution - The maximum allowed resolution is 16384x16384 (8192x8192 when `anti_alias` is `true`), but the maximum recommended resolution is 4096x4096 (resp. 2048x2048).
+     * @param table.resolution - The maximum allowed resolution is 16384x16384 (8192x8192 when `anti_alias` is `true`), but the maximum recommended resolution is 4096x4096 (resp. 2048x2048). The `x` value of the position is used as the width, the `y` value as the height.
      * @param table.show_cursor_building_preview - When `true` and when `player` is specified, the building preview for the item in the player's cursor will also be rendered. Defaults to `false`.
      * @param table.show_entity_info - Whether to include entity info ("Alt mode") or not. Defaults to `false`.
      * @param table.show_gui - Whether to include GUIs in the screenshot or not. Defaults to `false`.
@@ -10005,7 +10084,7 @@ interface LuaGuiElement {
     /**
      * The type of this GUI element.
      */
-    readonly type: string
+    readonly type: GuiElementType
 
     /**
      * 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.
@@ -11518,7 +11597,7 @@ interface LuaItemStack {
      * Applies to subclasses: DeconstructionItem
      *
      * @param filter - Writing `nil` removes the filter.
-     * @returns Whether the new filter was successfully set (meaning was valid).
+     * @returns Whether the new filter was successfully set (meaning it was valid).
      */
     set_tile_filter(this: void,
         index: number,
@@ -11701,6 +11780,11 @@ interface LuaItemStack {
      */
     health: number
 
+    /**
+     * If this is an ammo item.
+     */
+    readonly is_ammo: boolean
+
     /**
      * If this is an armor item.
      */
@@ -13307,11 +13391,11 @@ interface LuaPlayer extends LuaControl {
     /**
      * Starts selection with selection tool from the specified position. Does nothing if the players cursor is not a selection tool.
      * @param position - The position to start selection from.
-     * @param selection_mode - The type of selection to start. Can be `select`, `alternative-select`, `reverse-select`.
+     * @param selection_mode - The type of selection to start.
      */
     start_selection(this: void,
         position: MapPosition,
-        selection_mode: string): void
+        selection_mode: 'select' | 'alternative-select' | 'reverse-select'): void
 
     /**
      * Toggles this player into or out of the map editor. Does nothing if this player isn't an admin or if the player doesn't have permission to use the map editor.
@@ -14221,7 +14305,7 @@ interface LuaRendering {
         mod_name?: string): void
 
     /**
-     * Destroy the object with the given id.
+     * Destroy the object with the given id. Does not error when the object is invalid.
      */
     destroy(this: void,
         id: number): void
@@ -15032,6 +15116,12 @@ interface LuaRendering {
     is_valid(this: void,
         id: number): boolean
 
+    /**
+     * Reorder this object so that it is drawn in the back of the already existing objects.
+     */
+    move_to_back(this: void,
+        id: number): void
+
     /**
      * Set the alignment of the text with this id. Does nothing if this object is not a text.
      * @remarks
@@ -16219,7 +16309,7 @@ interface LuaSurface {
 
     /**
      * Clears this surface deleting all entities and chunks on it.
-     * @param ignore_characters - Whether characters on this surface that are connected to or associated with players should be ignored (not destroyed).
+     * @param ignore_characters - Whether characters on this surface that are connected to or associated with players should be ignored (not destroyed). Defaults to `false`.
      */
     clear(this: void,
         ignore_characters?: boolean): void
@@ -16310,8 +16400,12 @@ interface LuaSurface {
      * Count entities of given type or name in a given area. Works just like {@link LuaSurface::find_entities_filtered | runtime:LuaSurface::find_entities_filtered}, except this only returns the count. As it doesn't construct all the wrapper objects, this is more efficient if one is only interested in the number of entities.
      * 
      * If no `area` or `position` are given, the entire surface is searched. If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box). If `position` and `radius` are given, this returns entities in the radius of the position. If `area` is specified, this returns entities colliding with that area.
+     * @param table.ghost_name - An empty array means the same as providing nothing (`nil`).
+     * @param table.ghost_type - An empty array means the same as providing nothing (`nil`).
      * @param table.invert - Whether the filters should be inverted.
+     * @param table.name - An empty array means the same as providing nothing (`nil`).
      * @param table.radius - If given with position, will count all entities within the radius of the position.
+     * @param table.type - An empty array means the same as providing nothing (`nil`).
      */
     count_entities_filtered(this: void,
         table: {
@@ -16338,8 +16432,9 @@ interface LuaSurface {
      * If no `area` or `position` and `radius` is given, the entire surface is searched. If `position` and `radius` are given, only tiles within the radius of the position are included.
      * @param table.has_tile_ghost - Can be further filtered by supplying a `force` filter.
      * @param table.invert - If the filters should be inverted.
+     * @param table.name - An empty array means the same as providing nothing (`nil`).
      * @param table.position - Ignored if not given with radius.
-     * @param table.radius - If given with position, will return all entities within the radius of the position.
+     * @param table.radius - If given with position, will return all tiles within the radius of the position.
      * @param table.to_be_deconstructed - Can be further filtered by supplying a `force` filter.
      */
     count_tiles_filtered(this: void,
@@ -16607,8 +16702,12 @@ interface LuaSurface {
      * - If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box).
      * - If `position` and `radius` are given, this returns the entities within the radius of the position. Looks for the center of entities.
      * - If `area` is specified, this returns the entities colliding with that area.
+     * @param table.ghost_name - An empty array means the same as providing nothing (`nil`).
+     * @param table.ghost_type - An empty array means the same as providing nothing (`nil`).
      * @param table.invert - Whether the filters should be inverted.
+     * @param table.name - An empty array means the same as providing nothing (`nil`).
      * @param table.position - Has precedence over area field.
+     * @param table.type - An empty array means the same as providing nothing (`nil`).
      * @example
      * ```
      * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, type = "resource"} -- gets all resources in the rectangle
@@ -16741,8 +16840,9 @@ interface LuaSurface {
      * If no `area` or `position` and `radius` is given, the entire surface is searched. If `position` and `radius` are given, only tiles within the radius of the position are included.
      * @param table.has_tile_ghost - Can be further filtered by supplying a `force` filter.
      * @param table.invert - Whether the filters should be inverted.
+     * @param table.name - An empty array means the same as providing nothing (`nil`).
      * @param table.position - Ignored if not given with radius.
-     * @param table.radius - If given with position, will return all entities within the radius of the position.
+     * @param table.radius - If given with position, will return all tiles within the radius of the position.
      * @param table.to_be_deconstructed - Can be further filtered by supplying a `force` filter.
      */
     find_tiles_filtered(this: void,

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.102
+// Factorio version 1.1.106
 // API version 4
 
 declare namespace runtime {
@@ -1382,7 +1382,7 @@ interface InfinityPipeFilter {
     name: string,
     
     /**
-     * The fill percentage the pipe (`0.5` for 50%). Can't be negative.
+     * The fill percentage the pipe (for example `0.5` for 50%). Can't be negative.
      */
     percentage?: number,
     
@@ -2044,8 +2044,12 @@ interface MapViewSettings {
     'show-non-standard-map-info'?: boolean,
     'show-player-names'?: boolean,
     'show-pollution'?: boolean,
+    'show-rail-signal-states'?: boolean,
+    'show-recipe-icons'?: boolean,
+    'show-tags'?: boolean,
     'show-train-station-names'?: boolean,
-    'show-turret-range'?: boolean
+    'show-turret-range'?: boolean,
+    'show-worker-robots'?: boolean
 }
 
 interface ModChangeData {
@@ -2428,7 +2432,7 @@ type PlayerIdentification = /* The player index. */ number | /* The player name.
 interface PollutionMapSettings {
     
     /**
-     * The amount of pollution eaten by a chunk's tiles as a percentage of 1. Defaults to `1`.
+     * The amount of pollution eaten by a chunk's tiles as a percentage of 1. Also known as absorption modifier. Defaults to `1`.
      */
     ageing: number,
     

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.102
+// Factorio version 1.1.106
 // API version 4
 
 declare namespace defines {
@@ -701,11 +701,11 @@ declare namespace defines {
          */
         always,
         /**
-         * Hover according to the element type and implementation.
+         * Never hover this element with a game controller.
          */
         never,
         /**
-         * Never hover this element with a game controller.
+         * Hover according to the element type and implementation.
          */
         normal,
     }

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.102
+// Factorio version 1.1.106
 // 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.102
+// Factorio version 1.1.106
 // 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.102
+// Factorio version 1.1.106
 // API version 4
 
 declare namespace prototype {
@@ -1025,12 +1025,12 @@ interface BatteryEquipmentPrototype extends EquipmentPrototype{
 }
 
 /**
- * Entity with the ability to transfer module's effects to its neighboring entities.
+ * Entity with the ability to transfer {@link module | prototype:ModulePrototype} effects to its neighboring entities.
  */
 interface BeaconPrototype extends EntityWithOwnerPrototype{
     
     /**
-     * The types of modules that a player can place inside of the beacon.
+     * The types of {@link modules | prototype:ModulePrototype} that a player can place inside of the beacon.
      */
     allowed_effects?: EffectTypeLimitation,
     
@@ -2012,7 +2012,7 @@ Controls the speed of the animation: `1 ÷ dying_speed = duration of the animati
 interface CraftingMachinePrototype extends EntityWithOwnerPrototype{
     
     /**
-     * Sets the module effects that are allowed to be used on this machine.
+     * Sets the {@link modules | prototype:ModulePrototype} and {@link beacon | prototype:BeaconPrototype} effects that are allowed to be used on this machine.
 
 Note: If the time to complete a recipe is shorter than one tick, only one craft can be completed per tick, but productivity bonus is applied to the non-limited ''completable'' work. For a simple example, if a recipe were to take half a tick, only one recipe would be completed, but twice the productivity bonus would occur. The surplus production from productivity is **not** limited to one craft per tick.
      */
@@ -3416,7 +3416,7 @@ Mandatory if `icons` is not defined, or if `icon_size` is not specified for all
     max_temperature?: number,
     
     /**
-     * The value of this property may not be an empty string. It either has to be nil, or a non-empty string.
+     * The name of the {@link subgroup | prototype:ItemSubGroup} of this fluid. The value of this property may not be an empty string. It either has to be `nil`, or a non-empty string.
      */
     subgroup?: ItemSubGroupID
 }
@@ -4274,7 +4274,9 @@ The localised name of the entity will be used as the in-game item name. This beh
     stack_size: ItemCountType,
     
     /**
-     * Empty text of subgroup is not allowed. (You can omit the definition to get the default "other").
+     * The name of the {@link subgroup | prototype:ItemSubGroup} this item should be sorted into in item selection GUIs like logistic requests.
+
+Empty text of subgroup is not allowed. (You can omit the definition to get the default "other").
      */
     subgroup?: ItemSubGroupID,
     
@@ -4403,7 +4405,7 @@ interface ItemWithInventoryPrototype extends ItemWithLabelPrototype{
     item_group_filters?: ItemGroupID[],
     
     /**
-     * A list of explicit item subgroup names to be used as filters.
+     * A list of explicit {@link item subgroup | prototype:ItemSubGroup} names to be used as filters.
      */
     item_subgroup_filters?: ItemSubGroupID[],
     
@@ -4473,12 +4475,12 @@ interface KillAchievementPrototype extends AchievementPrototype{
 }
 
 /**
- * A {@link lab | https://wiki.factorio.com/Lab}.
+ * A {@link lab | https://wiki.factorio.com/Lab}. It consumes {@link science packs | prototype:ToolPrototype} to research {@link technologies | prototype:TechnologyPrototype}.
  */
 interface LabPrototype extends EntityWithOwnerPrototype{
     
     /**
-     * Sets the module effects that are allowed to be used on this lab.
+     * Sets the {@link modules | prototype:ModulePrototype} and {@link beacon | prototype:BeaconPrototype} effects that are allowed to be used on this lab.
      */
     allowed_effects?: EffectTypeLimitation,
     
@@ -5049,6 +5051,10 @@ interface MarketPrototype extends EntityWithOwnerPrototype{
  * A mining drill for automatically extracting resources from {@link resource entities | prototype:ResourceEntityPrototype}. This prototype type is used by {@link burner mining drill | https://wiki.factorio.com/Burner_mining_drill}, {@link electric mining drill | https://wiki.factorio.com/Electric_mining_drill} and {@link pumpjack | https://wiki.factorio.com/Pumpjack} in vanilla.
  */
 interface MiningDrillPrototype extends EntityWithOwnerPrototype{
+    
+    /**
+     * Sets the {@link modules | prototype:ModulePrototype} and {@link beacon | prototype:BeaconPrototype} effects that are allowed to be used on this mining drill.
+     */
     allowed_effects?: EffectTypeLimitation,
     
     /**
@@ -5159,12 +5165,12 @@ interface ModuleCategory extends PrototypeBase{
 }
 
 /**
- * A {@link module | https://wiki.factorio.com/Module}.
+ * A {@link module | https://wiki.factorio.com/Module}. They are used to affect the capabilities of existing machines, for example by increasing the crafting speed of a {@link crafting machine | prototype:CraftingMachinePrototype}.
  */
 interface ModulePrototype extends ItemPrototype{
     
     /**
-     * Chooses with what art style the module is shown inside beacons. See {@link BeaconModuleVisualizations::art_style | prototype:BeaconModuleVisualizations::art_style}. Vanilla uses "vanilla" here.
+     * Chooses with what art style the module is shown inside {@link beacons | prototype:BeaconPrototype}. See {@link BeaconModuleVisualizations::art_style | prototype:BeaconModuleVisualizations::art_style}. Vanilla uses `"vanilla"` here.
      */
     art_style?: string,
     beacon_tint?: BeaconVisualizationTints,
@@ -5173,15 +5179,19 @@ interface ModulePrototype extends ItemPrototype{
      * Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.
      */
     category: ModuleCategoryID,
+    
+    /**
+     * The effect of the module on the machine it's inserted in, such as increased pollution.
+     */
     effect: Effect,
     
     /**
-     * Array of recipe names this module can be used on. If empty, the module can be used on all recipes.
+     * Array of {@link recipe names | prototype:RecipePrototype} this module can be used on. If empty, the module can be used on all recipes.
      */
     limitation?: RecipeID[],
     
     /**
-     * Array of recipe names this module can **not** be used on, implicitly allowing its use on all other recipes. This property has no effect if set to an empty table.
+     * Array of {@link recipe names | prototype:RecipePrototype} this module can **not** be used on, implicitly allowing its use on all other recipes. This property has no effect if set to an empty table.
 
 Note that the game converts this into a normal list of limitations internally, so reading {@link LuaItemPrototype::limitations | runtime:LuaItemPrototype::limitations} at runtime will be the product of both ways of defining limitations.
      */
@@ -5540,6 +5550,10 @@ interface PipePrototype extends EntityWithOwnerPrototype{
      */
     fluid_box: FluidBox,
     horizontal_window_bounding_box: BoundingBox,
+    
+    /**
+     * All graphics for this pipe.
+     */
     pictures: PipePictures,
     vertical_window_bounding_box: BoundingBox
 }
@@ -6253,7 +6267,7 @@ Only loaded if neither `normal` nor `expensive` are defined.
     always_show_products?: boolean,
     
     /**
-     * Controls which category of machines can craft this recipe.
+     * The {@link category | prototype:RecipeCategory} of this recipe. Controls which machines can craft this recipe.
 
 The built-in categories can be found {@link here | https://wiki.factorio.com/Data.raw#recipe-category}. The base `"crafting"` category can not contain recipes with fluid ingredients or products.
      */
@@ -6409,7 +6423,7 @@ Only loaded if neither `normal` nor `expensive` are defined.
     show_amount_in_title?: boolean,
     
     /**
-     * The subgroup of this recipe. If not specified, it defaults to the subgroup of the product if there is only one, or of the `main_product` if multiple products exist.
+     * The name of the {@link subgroup | prototype:ItemSubGroup} of this recipe. If not specified, it defaults to the subgroup of the product if there is only one, or of the `main_product` if multiple products exist.
 
 Mandatory if multiple products exist and no `main_product` is specified, or if there is no product.
      */
@@ -7566,7 +7580,7 @@ interface SoundPrototype {
     category?: SoundType,
     
     /**
-     * Supported sound file formats are `.ogg (Vorbis)` and `.wav`.
+     * Supported sound file formats are `.ogg` (Vorbis) and `.wav`.
 
 Only loaded, and mandatory if `variations` is not defined.
      */
@@ -8101,6 +8115,11 @@ The x position of the sprite will be `((game.tick % flow_length_in_ticks) ÷ flo
      * If the icons of fluids shown in alt-mode should be scaled to the storage tank's size.
      */
     scale_info_icons?: boolean,
+    
+    /**
+     * Whether the "alt-mode icon" should be drawn at all.
+     */
+    show_fluid_icon?: boolean,
     two_direction_only?: boolean,
     
     /**
@@ -8651,7 +8670,7 @@ interface TransportBeltConnectablePrototype extends EntityWithOwnerPrototype{
     ends_with_stopper?: boolean,
     
     /**
-     * Transport belt connectable entities cannot have any of the following flags: "placeable-off-grid", "building-direction-8-way".
+     * Transport belt connectable entities cannot have the `"building-direction-8-way"` flag.
      */
     flags?: EntityPrototypeFlags,
     
@@ -10014,7 +10033,7 @@ Mandatory if `icons` is not defined, or if `icon_size` is not specified for all
     icons?: IconData[],
     
     /**
-     * The name of a {@link ItemSubGroup | prototype:ItemSubGroup}.
+     * The name of an {@link ItemSubGroup | prototype:ItemSubGroup}.
      */
     subgroup?: ItemSubGroupID
 }

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.102
+// Factorio version 1.1.106
 // API version 4
 
 declare namespace prototype {
@@ -2475,6 +2475,9 @@ interface DirectTriggerItem extends TriggerItem{
     type: 'direct'
 }
 
+/**
+ * Usually specified by using {@link defines.direction | runtime:defines.direction}.
+ */
 type Direction = /* North */ 0 | /* Northeast */ 1 | /* East */ 2 | /* Southeast */ 3 | /* South */ 4 | /* Southwest */ 5 | /* West */ 6 | /* Northwest */ 7
 
 interface DirectionShift {
@@ -2505,7 +2508,7 @@ interface DropDownStyleSpecification extends BaseStyleSpecification{
 }
 
 /**
- * When applied to modules, the resulting effect is a sum of all module affects, 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, for productivity `(0 + sum)`.
  * @example
  * ```
  * effect =
@@ -2542,7 +2545,7 @@ interface Effect {
 }
 
 /**
- * A list of module effects, or just a single effect. Modules with other effects cannot be used on the machine. This means that both effects from modules and from surrounding beacons are restricted to the listed effects. If `allowed_effects` is set to `nil`, the machine cannot be affected by modules or beacons.
+ * A list of {@link module | prototype:ModulePrototype} effects, or just a single effect. Modules with other effects cannot be used on the machine. This means that both effects from modules and from surrounding beacons are restricted to the listed effects. If `allowed_effects` is an empty array, the machine cannot be affected by modules or beacons.
  * @example
  * ```
  * -- Allow all module types
@@ -2561,7 +2564,7 @@ type EffectTypeLimitation = /* Modules that increase or decrease the machine's s
 interface EffectValue {
     
     /**
-     * Precision is ignored beyond two decimals - `0.567` results in `0.56` etc.
+     * Precision is ignored beyond two decimals - `0.567` results in `0.56` and means 56% etc.
      */
     bonus?: number
 }
@@ -3931,15 +3934,20 @@ interface ImageStyleSpecification extends BaseStyleSpecification{
 }
 
 /**
- * Defaults to loading ingredients as items.
+ * Defaults to loading ingredients as items. This allows {@link ItemIngredientPrototype | prototype:ItemIngredientPrototype} to load in a shorthand array format.
  * @example
  * ```
- * {type="item", name="steel-plate", amount=8}
+ * {"electronic-circuit", 5} -- short format used for item ingredients
  * ```
  *
  * @example
  * ```
- * {type="fluid", name="water", amount=50}
+ * {type="item", name="steel-plate", amount=8} -- long format used for item ingredients
+ * ```
+ *
+ * @example
+ * ```
+ * {type="fluid", name="water", amount=50} -- fluid ingredients must use the long format
  * ```
  *
  */
@@ -4117,16 +4125,21 @@ type ItemSubGroupID = string
 
 /**
  * Item that when placed creates this entity/tile.
+ * @example
+ * ```
+ * {item = "iron-chest", count = 1}
+ * ```
+ *
  */
 interface ItemToPlace {
     
     /**
-     * How many items are used to place one of this entity. Can't be larger than the stack size of the item.
+     * How many items are used to place one of this entity/tile. Can't be larger than the stack size of the item.
      */
     count: number,
     
     /**
-     * The item used to place this entity.
+     * The item used to place this entity/tile.
      */
     item: ItemID
 }
@@ -4597,7 +4610,7 @@ interface MapGenPresetEnemyExpansionSettings {
 interface MapGenPresetPollutionSettings {
     
     /**
-     * Must be >= 0.1. Also known as dissipation rate.
+     * Must be >= 0.1. Also known as absorption modifier and previously dissipation rate.
      */
     ageing?: number,
     
@@ -5686,6 +5699,7 @@ type NoiseVariableConstants = /* Additional constants are generated for all {@li
 
 interface NothingModifier extends BaseModifier{
     effect_description?: LocalisedString,
+    type: 'nothing',
     
     /**
      * If `false`, do not draw the small "constant" icon over the technology effect icon.
@@ -6113,7 +6127,7 @@ type PlayerInputMethodFilter = 'all' | 'keyboard_and_mouse' | 'game_controller'
 interface PollutionSettings {
     
     /**
-     * Constant modifier a percentage of 1; the pollution eaten by a chunks tiles.
+     * Constant modifier a percentage of 1; the pollution eaten by a chunks tiles. Also known as absorption modifier.
      */
     ageing: number,
     
@@ -6993,7 +7007,7 @@ interface ScrollPaneStyleSpecification extends BaseStyleSpecification{
 /**
  * An array containing the following values.
  */
-type SelectionModeFlags = Array</* Selects entities and tiles as if selecting them for a blueprint. */ 'blueprint' | /* Selects entities and tiles as if selecting them for deconstruction. */ 'deconstruct' | /* Selects entities and tiles as if selecting them for deconstruction cancellation. */ 'cancel-deconstruct' | /* Selects items on the ground. */ 'items' | /* Selects trees. */ 'trees' | /* Selects entities which are considered {@link a building | runtime:LuaEntityPrototype::is_building}, plus landmines. */ 'buildable-type' | /* Selects no entities or tiles, but is useful to select an area. */ 'nothing' | /* Selects entities and tiles that can be built by an item. */ 'items-to-place' | /* Selects all entities. */ 'any-entity' | /* Selects all tiles. */ 'any-tile' | /* Selects entities with the same force as the selecting player. */ 'same-force' | /* Selects entities with a different force as the selecting player. */ 'not-same-force' | /* Selects entities from a friendly force. */ 'friend' | /* Selects entities from an enemy force. */ 'enemy' | /* Selects entities as if selecting them for upgrading. */ 'upgrade' | /* Selects entities as if selecting them for upgrade cancellation. */ 'cancel-upgrade' | /* Selects entities as if selecting them for downgrading. */ 'downgrade' | /* Selects entities that are an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype}. */ 'entity-with-health' | /* Deprecated. Replaced by "is-military-target". */ 'entity-with-force' | /* Selects entities which are {@link EntityWithOwnerPrototype::is_military_target | prototype:EntityWithOwnerPrototype::is_military_target}. */ 'is-military-target' | /* Selects entities that are an {@link EntityWithOwnerPrototype | prototype:EntityWithOwnerPrototype}. */ 'entity-with-owner' | /* Selects entities that are not a {@link RollingStockPrototype | prototype:RollingStockPrototype}. */ 'avoid-rolling-stock' | /* Selects entities that are an {@link EntityGhostPrototype | prototype:EntityGhostPrototype}. */ 'entity-ghost' | /* Selects entities that are a {@link TileGhostPrototype | prototype:TileGhostPrototype}. */ 'tile-ghost'>
+type SelectionModeFlags = /* Selects entities and tiles as if selecting them for a blueprint. */ 'blueprint' | /* Selects entities and tiles as if selecting them for deconstruction. */ 'deconstruct' | /* Selects entities and tiles as if selecting them for deconstruction cancellation. */ 'cancel-deconstruct' | /* Selects items on the ground. */ 'items' | /* Selects trees. */ 'trees' | /* Selects entities which are considered {@link a building | runtime:LuaEntityPrototype::is_building}, plus landmines. */ 'buildable-type' | /* Selects no entities or tiles, but is useful to select an area. */ 'nothing' | /* Selects entities and tiles that can be built by an item. */ 'items-to-place' | /* Selects all entities. */ 'any-entity' | /* Selects all tiles. */ 'any-tile' | /* Selects entities with the same force as the selecting player. */ 'same-force' | /* Selects entities with a different force as the selecting player. */ 'not-same-force' | /* Selects entities from a friendly force. */ 'friend' | /* Selects entities from an enemy force. */ 'enemy' | /* Selects entities as if selecting them for upgrading. */ 'upgrade' | /* Selects entities as if selecting them for upgrade cancellation. */ 'cancel-upgrade' | /* Selects entities as if selecting them for downgrading. */ 'downgrade' | /* Selects entities that are an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype}. */ 'entity-with-health' | /* Deprecated. Replaced by "is-military-target". */ 'entity-with-force' | /* Selects entities which are {@link EntityWithOwnerPrototype::is_military_target | prototype:EntityWithOwnerPrototype::is_military_target}. */ 'is-military-target' | /* Selects entities that are an {@link EntityWithOwnerPrototype | prototype:EntityWithOwnerPrototype}. */ 'entity-with-owner' | /* Selects entities that are not a {@link RollingStockPrototype | prototype:RollingStockPrototype}. */ 'avoid-rolling-stock' | /* Selects entities that are an {@link EntityGhostPrototype | prototype:EntityGhostPrototype}. */ 'entity-ghost' | /* Selects entities that are a {@link TileGhostPrototype | prototype:TileGhostPrototype}. */ 'tile-ghost' | Array</* Selects entities and tiles as if selecting them for a blueprint. */ 'blueprint' | /* Selects entities and tiles as if selecting them for deconstruction. */ 'deconstruct' | /* Selects entities and tiles as if selecting them for deconstruction cancellation. */ 'cancel-deconstruct' | /* Selects items on the ground. */ 'items' | /* Selects trees. */ 'trees' | /* Selects entities which are considered {@link a building | runtime:LuaEntityPrototype::is_building}, plus landmines. */ 'buildable-type' | /* Selects no entities or tiles, but is useful to select an area. */ 'nothing' | /* Selects entities and tiles that can be built by an item. */ 'items-to-place' | /* Selects all entities. */ 'any-entity' | /* Selects all tiles. */ 'any-tile' | /* Selects entities with the same force as the selecting player. */ 'same-force' | /* Selects entities with a different force as the selecting player. */ 'not-same-force' | /* Selects entities from a friendly force. */ 'friend' | /* Selects entities from an enemy force. */ 'enemy' | /* Selects entities as if selecting them for upgrading. */ 'upgrade' | /* Selects entities as if selecting them for upgrade cancellation. */ 'cancel-upgrade' | /* Selects entities as if selecting them for downgrading. */ 'downgrade' | /* Selects entities that are an {@link EntityWithHealthPrototype | prototype:EntityWithHealthPrototype}. */ 'entity-with-health' | /* Deprecated. Replaced by "is-military-target". */ 'entity-with-force' | /* Selects entities which are {@link EntityWithOwnerPrototype::is_military_target | prototype:EntityWithOwnerPrototype::is_military_target}. */ 'is-military-target' | /* Selects entities that are an {@link EntityWithOwnerPrototype | prototype:EntityWithOwnerPrototype}. */ 'entity-with-owner' | /* Selects entities that are not a {@link RollingStockPrototype | prototype:RollingStockPrototype}. */ 'avoid-rolling-stock' | /* Selects entities that are an {@link EntityGhostPrototype | prototype:EntityGhostPrototype}. */ 'entity-ghost' | /* Selects entities that are a {@link TileGhostPrototype | prototype:TileGhostPrototype}. */ 'tile-ghost'>
 
 interface SequenceTipTrigger {
     
@@ -7249,7 +7263,7 @@ type Sound = {
     audible_distance_modifier?: number,
     
     /**
-     * Supported sound file formats are `.ogg (Vorbis)` and `.wav`.
+     * Supported sound file formats are `.ogg` (Vorbis) and `.wav`.
 
 Only loaded, and mandatory if `variations` is not defined.
      */
@@ -7292,7 +7306,7 @@ Only loaded if `variations` is not defined.
 interface SoundDefinition {
     
     /**
-     * Supported sound file formats are `.ogg (Vorbis)` and `.wav`.
+     * Supported sound file formats are `.ogg` (Vorbis) and `.wav`.
      */
     filename: FileName,
     
@@ -7667,6 +7681,45 @@ Same as `slice`, but this specifies only how many slices there are on the y-axis
 
 /**
  * A map of sprites for all 4 directions of the entity. If this is loaded as a single Sprite, it applies to all directions.
+ * @example
+ * ```
+ * -- separate sprites per direction
+ * {
+ *   north =
+ *   {
+ *     filename = "__base__/graphics/entity/assembling-machine-3/assembling-machine-3-pipe-N.png",
+ *     priority = "extra-high",
+ *     width = 35,
+ *     height = 18,
+ *     shift = util.by_pixel(2.5, 14)
+ *   },
+ *   east =
+ *   {
+ *     filename = "__base__/graphics/entity/assembling-machine-3/assembling-machine-3-pipe-E.png",
+ *     priority = "extra-high",
+ *     width = 20,
+ *     height = 38,
+ *     shift = util.by_pixel(-25, 1)
+ *   },
+ *   south =
+ *   {
+ *     filename = "__base__/graphics/entity/assembling-machine-3/assembling-machine-3-pipe-S.png",
+ *     priority = "extra-high",
+ *     width = 44,
+ *     height = 31,
+ *     shift = util.by_pixel(0, -31.5)
+ *   },
+ *   west =
+ *   {
+ *     filename = "__base__/graphics/entity/assembling-machine-3/assembling-machine-3-pipe-W.png",
+ *     priority = "extra-high",
+ *     width = 19,
+ *     height = 37,
+ *     shift = util.by_pixel(25.5, 1.5)
+ *   }
+ * }
+ * ```
+ *
  */
 type Sprite4Way = {
     
@@ -8444,11 +8497,15 @@ interface TileSprite {
     
     /**
      * Frame count.
+
+Optional if it is loaded inside of a `hr_version`, see that property for more information.
      */
     count: number,
     
     /**
      * If this property exists and high resolution sprites are turned on, its contents are used to load the tile sprite.
+
+`count` in `hr_version` has to be either unspecified or the same as for normal resolution definition.
      */
     hr_version?: TileSprite,
     

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "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.102"
+  "factorioVersion": "1.1.106"
 }