factorio-types 0.0.45 → 0.0.47

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.102
 // 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 = {
     
     /**
@@ -467,6 +528,13 @@ type AnimationVariations = {
     sheets?: AnimationSheet[]
 } | Animation | Animation[]
 
+/**
+ * A union of all prototypes. A specific prototype is loaded based on the value of the `type` key.
+ * 
+ * See the {@link Prototypes page | prototype:prototypes} for more information.
+ */
+type AnyPrototype = PrototypeBase | AmbientSound | AnimationPrototype | EditorControllerPrototype | FontPrototype | GodControllerPrototype | MapGenPresets | MapSettings | MouseCursor | SoundPrototype | SpectatorControllerPrototype | SpritePrototype | TileEffectDefinition | TipsAndTricksItemCategory | TriggerTargetType | WindSound
+
 interface AreaTriggerItem extends TriggerItem{
     collision_mode?: 'distance-from-collision-box' | 'distance-from-center',
     radius: number,
@@ -1054,7 +1122,7 @@ Only loaded if `icons` is not defined.
     icon_mipmaps?: IconMipMapType,
     
     /**
-     * The size of the square icon, in pixels, e.g. `32` for a 32px by 32px icon.
+     * The size of the square icon, in pixels. E.g. `32` for a 32px by 32px icon.
 
 Only loaded if `icons` is not defined, or if `icon_size` is not specified for all instances of `icons`.
      */
@@ -1456,7 +1524,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 +1917,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
@@ -2247,6 +2315,33 @@ type DamageTypeFilters = {
  */
 type DamageTypeID = string
 
+/**
+ * The data table is read by the game to load all prototypes.
+ * 
+ * At the end of the prototype stage, the data table is loaded by the game engine and the format of the prototypes is validated. Any extra properties are ignored. See {@link Data Lifecycle | runtime:data-lifecycle} for more information.
+ * 
+ * The data table and its properties are defined in Lua, so their source code can be viewed in {@link dataloader.lua | https://github.com/wube/factorio-data/blob/master/core/lualib/dataloader.lua}.
+ */
+interface Data {
+    
+    /**
+     * The primary way to add prototypes to the data table.
+     */
+    extend: DataExtendMethod,
+    
+    /**
+     * Set by the game based on whether the demo or retail version is running. Should not be used by mods.
+     */
+    is_demo: boolean,
+    
+    /**
+     * A dictionary of prototype types to values that themselves are dictionaries of prototype names to specific prototypes.
+
+This means that individual prototypes can be accessed with `local prototype = data.raw["prototype-type"]["internal-name"]`.
+     */
+    raw: {[key: string]: {[key: string]: AnyPrototype}}
+}
+
 /**
  * The first member of the tuple states at which time of the day the LUT should be used. If the current game time is between two values defined in the color lookup that have different LUTs, the color is interpolated to create a smooth transition. (Sharp transition can be achieved by having the two values differing only by a small fraction.)
  * 
@@ -2411,6 +2506,17 @@ 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)`.
+ * @example
+ * ```
+ * effect =
+ * {
+ *   productivity = {bonus = 0.04},
+ *   consumption = {bonus = 0.4},
+ *   pollution = {bonus = 0.05},
+ *   speed = {bonus = -0.05}
+ * }
+ * ```
+ *
  */
 interface Effect {
     
@@ -2455,11 +2561,44 @@ type EffectTypeLimitation = /* Modules that increase or decrease the machine's s
 interface EffectValue {
     
     /**
-     * Precision is ignored beyond two decimals - 17.567 results in 17.56 etc.
+     * Precision is ignored beyond two decimals - `0.567` results in `0.56` etc.
      */
     bonus?: number
 }
 
+/**
+ * @example
+ * ```
+ * energy_source = -- energy source of oil pumpjack
+ * {
+ *   type = "electric",
+ *   emissions_per_minute = 10,
+ *   usage_priority = "secondary-input"
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * energy_source = -- energy source of accumulator
+ * {
+ *   type = "electric",
+ *   buffer_capacity = "5MJ",
+ *   usage_priority = "tertiary",
+ *   input_flow_limit = "300kW",
+ *   output_flow_limit = "300kW"
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * energy_source = -- energy source of steam engine
+ * {
+ *   type = "electric",
+ *   usage_priority = "secondary-output"
+ * }
+ * ```
+ *
+ */
 interface ElectricEnergySource extends BaseEnergySource{
     
     /**
@@ -2483,7 +2622,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
@@ -2749,7 +2888,7 @@ interface EnemyExpansionSettings {
 /**
  * Specifies an amount of electric energy in joules, or electric energy per time in watts.
  * 
- * Internally, the input in `Watt` or `Joule/second` is always converted into `Joule/tick` or `Joule/(1/60)second`, using the following formula: `Power in Joule/tick = Power in Watt / 60`. See {@link Power | https://wiki.factorio.com/Units#Power}.
+ * Internally, the input in `Watt` or `Joule/second` is always converted into `Joule/tick`, where 1 second is equal to 60 ticks. This means it uses the following formula: `Power in Joule/tick = Power in Watt / 60`. See {@link Power | https://wiki.factorio.com/Units#Power}.
  * 
  * Supported Multipliers:
  * 
@@ -2772,6 +2911,9 @@ interface EnemyExpansionSettings {
  * ```
  * buffer_capacity = "5MJ"
  * input_flow_limit = "300W"
+ * -- the following two lines result in the same power consumption:
+ * energy_usage = "60W"
+ * energy_usage = "1J" -- not recommended, Watt is convention for power
  * ```
  *
  */
@@ -2799,13 +2941,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.
@@ -2998,7 +3146,12 @@ interface FastReplaceTipTrigger {
  * - **mod path**: The format `__<mod-name>__` is placeholder for root of any other mod (mods/<mod-name>), and is accessible as long as the mod is active.
  * @example
  * ```
- * filename = "__base__/graphics/entity/basic-transport-belt/basic-transport-belt.png"
+ * filename = "__base__/graphics/entity/accumulator/accumulator.png"
+ * ```
+ *
+ * @example
+ * ```
+ * filename = "__a-mod__/animations/assembler.png"
  * ```
  *
  */
@@ -3196,7 +3349,7 @@ type FluidID = string
 interface FluidIngredientPrototype {
     
     /**
-     * Can not be `< 0`.
+     * Can not be `<= 0`.
      */
     amount: number,
     
@@ -3277,6 +3430,10 @@ If this FluidProductPrototype is used in a recipe, the `catalyst_amount` is calc
     
     /**
      * Value between 0 and 1, `0` for 0% chance and `1` for 100% chance.
+
+The effect of probability is no product, or a linear distribution on [min, max]. For a recipe with probability `p`, amount_min `min`, and amount_max `max`, the Expected Value of this product can be expressed as `p * (0.5 * (max + min))`. This is what will be shown in a recipe tooltip. The effect of `catalyst_amount` on the product is not shown.
+
+When `amount_min` and `amount_max` are not provided, `amount` applies as min and max. The Expected Value simplifies to `p * amount`, providing `0` product, or `amount` product, on recipe completion.
      */
     probability?: number,
     
@@ -3724,11 +3881,11 @@ interface IconData {
     icon_mipmaps?: IconMipMapType,
     
     /**
-     * The size of the square icon, in pixels, e.g. `32` for a 32px by 32px icon.
+     * The size of the square icon, in pixels. E.g. `32` for a 32px by 32px icon.
 
 Mandatory if `icon_size` is not specified outside of `icons`.
      */
-    icon_size: SpriteSizeType,
+    icon_size?: SpriteSizeType,
     
     /**
      * Defaults to `32/icon_size` for items and recipes, and `256/icon_size` for technologies.
@@ -3859,7 +4016,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 +4045,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 +4449,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.
@@ -4479,7 +4636,7 @@ interface MapGenSettings {
     peaceful_mode?: boolean,
     
     /**
-     * Map of property name (e.g. "elevation") to name of noise expression that will provide it. Entries may be omitted. A notable usage is changing autoplace behavior of an entity based on the preset, which cannot be read from a noise expression.
+     * Map of property name (`"elevation"`, etc) to name of noise expression that will provide it. Entries may be omitted. A notable usage is changing autoplace behavior of an entity based on the preset, which cannot be read from a noise expression.
      */
     property_expression_names?: {[key: string]: string | boolean | number},
     
@@ -4720,6 +4877,17 @@ interface MiningDrillProductivityBonusModifier extends SimpleModifier{
     use_icon_overlay_constant?: boolean
 }
 
+/**
+ * The user-set value of a startup {@link mod setting | https://wiki.factorio.com/Tutorial:Mod_settings}.
+ */
+interface ModSetting {
+    
+    /**
+     * The value of the mod setting. The type depends on the kind of setting.
+     */
+    value: number | boolean | string | Color
+}
+
 /**
  * The effect that is applied when a {@link TechnologyPrototype | prototype:TechnologyPrototype} is researched.
  * 
@@ -4727,6 +4895,28 @@ interface MiningDrillProductivityBonusModifier extends SimpleModifier{
  */
 type Modifier = /* Loaded when the `type` is `"inserter-stack-size-bonus"`. */ InserterStackSizeBonusModifier | /* Loaded when the `type` is `"stack-inserter-capacity-bonus"`. */ StackInserterCapacityBonusModifier | /* Loaded when the `type` is `"laboratory-speed"`. */ LaboratorySpeedModifier | /* Loaded when the `type` is `"laboratory-productivity"`. */ LaboratoryProductivityModifier | /* Loaded when the `type` is `"maximum-following-robots-count"`. */ MaximumFollowingRobotsCountModifier | /* Loaded when the `type` is `"worker-robot-speed"`. */ WorkerRobotSpeedModifier | /* Loaded when the `type` is `"worker-robot-storage"`. */ WorkerRobotStorageModifier | /* Loaded when the `type` is `"worker-robot-battery"`. */ WorkerRobotBatteryModifier | /* Loaded when the `type` is `"follower-robot-lifetime"`. */ FollowerRobotLifetimeModifier | /* Loaded when the `type` is `"ghost-time-to-live"`. */ GhostTimeToLiveModifier | /* Loaded when the `type` is `"deconstruction-time-to-live"`. */ DeconstructionTimeToLiveModifier | /* Loaded when the `type` is `"turret-attack"`. */ TurretAttackModifier | /* Loaded when the `type` is `"ammo-damage"`. */ AmmoDamageModifier | /* Loaded when the `type` is `"artillery-range"`. */ ArtilleryRangeModifier | /* Loaded when the `type` is `"give-item"`. */ GiveItemModifier | /* Loaded when the `type` is `"gun-speed"`. */ GunSpeedModifier | /* Loaded when the `type` is `"unlock-recipe"`. */ UnlockRecipeModifier | /* Loaded when the `type` is `"character-crafting-speed"`. */ CharacterCraftingSpeedModifier | /* Loaded when the `type` is `"character-mining-speed"`. */ CharacterMiningSpeedModifier | /* Loaded when the `type` is `"character-running-speed"`. */ CharacterRunningSpeedModifier | /* Loaded when the `type` is `"character-build-distance"`. */ CharacterBuildDistanceModifier | /* Loaded when the `type` is `"character-item-drop-distance"`. */ CharacterItemDropDistanceModifier | /* Loaded when the `type` is `"character-reach-distance"`. */ CharacterReachDistanceModifier | /* Loaded when the `type` is `"character-resource-reach-distance"`. */ CharacterResourceReachDistanceModifier | /* Loaded when the `type` is `"character-item-pickup-distance"`. */ CharacterItemPickupDistanceModifier | /* Loaded when the `type` is `"character-loot-pickup-distance"`. */ CharacterLootPickupDistanceModifier | /* Loaded when the `type` is `"character-inventory-slots-bonus"`. */ CharacterInventorySlotsBonusModifier | /* Loaded when the `type` is `"character-health-bonus"`. */ CharacterHealthBonusModifier | /* Loaded when the `type` is `"character-logistic-requests"`. */ CharacterLogisticRequestsModifier | /* Loaded when the `type` is `"character-logistic-trash-slots"`. */ CharacterLogisticTrashSlotsModifier | /* Loaded when the `type` is `"max-failed-attempts-per-tick-per-construction-queue"`. */ MaxFailedAttemptsPerTickPerConstructionQueueModifier | /* Loaded when the `type` is `"max-successful-attempts-per-tick-per-construction-queue"`. */ MaxSuccessfulAttemptsPerTickPerConstructionQueueModifier | /* Loaded when the `type` is `"mining-drill-productivity-bonus"`. */ MiningDrillProductivityBonusModifier | /* Loaded when the `type` is `"train-braking-force-bonus"`. */ TrainBrakingForceBonusModifier | /* Loaded when the `type` is `"zoom-to-world-enabled"`. */ ZoomToWorldEnabledModifier | /* Loaded when the `type` is `"zoom-to-world-ghost-building-enabled"`. */ ZoomToWorldGhostBuildingEnabledModifier | /* Loaded when the `type` is `"zoom-to-world-blueprint-enabled"`. */ ZoomToWorldBlueprintEnabledModifier | /* Loaded when the `type` is `"zoom-to-world-deconstruction-planner-enabled"`. */ ZoomToWorldDeconstructionPlannerEnabledModifier | /* Loaded when the `type` is `"zoom-to-world-upgrade-planner-enabled"`. */ ZoomToWorldUpgradePlannerEnabledModifier | /* Loaded when the `type` is `"zoom-to-world-selection-tool-enabled"`. */ ZoomToWorldSelectionToolEnabledModifier | /* Loaded when the `type` is `"nothing"`. */ NothingModifier
 
+/**
+ * A dictionary of mod names to mod versions of all active mods. It can be used to adjust mod functionality based on the presence of other mods.
+ * @example
+ * ```
+ * -- executes pineapple only when the pizza mod is active
+ * if mods["pizza"] then
+ *   pineapple()
+ * end
+ * ```
+ *
+ * @example
+ * ```
+ * -- when the only active mod is the space-age mod with version 1.2.0
+ * -- then this logs
+ * for name, version in pairs(mods) do
+ *   log(name .. " version " .. version) -- => space-age version 1.2.0
+ * end
+ * ```
+ *
+ */
+type Mods = {[key: string]: string}
+
 /**
  * The name of a {@link ModuleCategory | prototype:ModuleCategory}.
  * @example
@@ -4829,6 +5019,8 @@ interface NoiseArrayConstruction {
  * {@link noise.define_noise_function | https://github.com/wube/factorio-data/blob/master/core/lualib/noise.lua#L272} allows noise expressions to be defined using a shorthand that's a subset of Lua (see the example for details).
  * 
  * See {@link here | https://togos.github.io/togos-example-noise-programs/} for a tutorial on authoring noise expressions.
+ * 
+ * The most frequently used noise functions are loaded via {@link NoiseFunctionApplication | prototype:NoiseFunctionApplication}.
  * @example
  * ```
  * -- "noise" library required beforehand
@@ -5587,6 +5779,10 @@ type Order = string
 
 interface OrientedCliffPrototype {
     collision_bounding_box: BoundingBox,
+    
+    /**
+     * Unused.
+     */
     fill_volume: number,
     pictures: SpriteVariations
 }
@@ -6005,7 +6201,7 @@ When used without `projectile_creation_parameters`, this sets the turret's rotat
     projectile_orientation_offset?: number,
     
     /**
-     * Used to show bullet shells/casings being ejected from the gun, e.g. {@link artillery shell casings | https://factorio.com/blog/post/fff-345}.
+     * Used to show bullet shells/casings being ejected from the gun, see {@link artillery shell casings | https://factorio.com/blog/post/fff-345}.
      */
     shell_particle?: CircularParticleCreationSpecification,
     type: 'projectile'
@@ -6373,7 +6569,7 @@ Can be set to an empty table to create a recipe that produces nothing. Duplicate
     results: ProductPrototype[],
     
     /**
-     * Whether the recipe name should have the product amount in front of it, e.g. "2x Transport belt"
+     * Whether the recipe name should have the product amount in front of it. E.g. "2x Transport belt"
      */
     show_amount_in_title?: boolean,
     
@@ -6838,6 +7034,23 @@ interface SetTileTriggerEffectItem extends TriggerEffectItem{
     type: 'set-tile'
 }
 
+/**
+ * A struct that provides access to the user-set values of startup {@link mod settings | https://wiki.factorio.com/Tutorial:Mod_settings}.
+ * @example
+ * ```
+ * -- Accessing the value of a mod setting
+ * local val = settings.startup["my-mod-setting-name"].value
+ * ```
+ *
+ */
+interface Settings {
+    
+    /**
+     * All startup mod settings, indexed by the name of the setting.
+     */
+    startup: {[key: string]: ModSetting}
+}
+
 interface ShiftAnimationWaypoints {
     east: Vector[],
     north: Vector[],
@@ -7113,7 +7326,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 +7516,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 +7526,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 +7932,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
+ *     }
+ *   }
  * }
  * ```
  *
@@ -7882,7 +8206,7 @@ interface TechnologyData {
     hidden?: boolean,
     
     /**
-     * Controls whether the technology cost ignores the tech cost multiplier set in the {@link DifficultySettings | runtime:DifficultySettings}, e.g. `4` for the default expensive difficulty.
+     * Controls whether the technology cost ignores the tech cost multiplier set in the {@link DifficultySettings | runtime:DifficultySettings}. E.g. `4` for the default expensive difficulty.
      */
     ignore_tech_cost_multiplier?: boolean,
     
@@ -8687,7 +9011,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 +9098,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.47",
   "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.102"
 }