Factorio Runtime Docs

The item. nil clears the filter.

If provided, only anchors the GUI element when the opened things type matches the type.

If provided, only anchors the GUI element when the opened thing matches the name. name takes precedence over names.

If provided, only anchors the GUI element when the opened thing matches one of the names. When reading an anchor, names is always populated.

The index of the item in the crafting queue.

The recipe being crafted.

The amount of items being crafted.

The item is a prerequisite for another item in the queue.

The tick this alert was created.

The SignalID used for a custom alert. Only present for custom alerts.

The message for a custom alert. Only present for custom alerts.

Only used if target is a LuaEntity.

The position of the waypoint on its surface.

true if the path from the previous waypoint to this one goes through an entity that must be destroyed.

Position to pan the camera to.

Entity or unit group to pan the camera to.

How many ticks it will take to reach this waypoint from the previous one.

Time in ticks to wait before moving to the next waypoint.

Zoom level to be set when the waypoint is reached. When not specified, the previous waypoint's zoom is used.

The name of the decorative prototype.

The mod that created this prototype.

The mods that changed this prototype in the order they changed it.

Whether pollution is enabled at all.

The amount that is diffused to a neighboring chunk (possibly repeated for other directions as well). Defaults to 0.02.

The amount of PUs that need to be in a chunk for it to start diffusing. Defaults to 15.

The amount of pollution eaten by a chunk's tiles as a percentage of 1. Defaults to 1.

Any amount of pollution larger than this value is visualized as this value instead. Defaults to 150.

Any amount of pollution smaller than this value (but bigger than zero) is visualized as this value instead. Defaults to 50.

Defaults to 60.

Defaults to 150.

Defaults to 50.

Defaults to 10.

Defaults to 20.

Defaults to 1.

Whether enemy evolution is enabled at all.

The amount evolution naturally progresses by every second. Defaults to 0.000004.

The amount evolution progresses for every destroyed spawner. Defaults to 0.002.

The amount evolution progresses for every unit of pollution. Defaults to 0.0000009.

Whether enemy expansion is enabled at all.

Distance in chunks from the furthest base around to prevent expansions from reaching too far into the player's territory. Defaults to 7.

Defaults to 2.

Defaults to 2.

Defaults to 0.1.

Defaults to 2.0.

Defaults to 0.5.

Defaults to 0.4.

A chunk has to have at most this high of a percentage of unbuildable tiles for it to be considered a candidate to avoid chunks full of water as candidates. Defaults to 0.9, or 90%.

The minimum size of a biter group that goes to build a new base. This is multiplied by the evolution factor. Defaults to 5.

The maximum size of a biter group that goes to build a new base. This is multiplied by the evolution factor. Defaults to 20.

The minimum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to 4*3,600=14,400 ticks.

The maximum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to 60*3,600=216,000 ticks.

The minimum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to 3,600 ticks.

The maximum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to 10*3,600=36,000 ticks.

After gathering has finished, the group is allowed to wait this long in ticks for delayed members. New members are not accepted anymore however. Defaults to 2*3,600=7,200 ticks.

The minimum group radius in tiles. The actual radius is adjusted based on the number of members. Defaults to 5.0.

The maximum group radius in tiles. The actual radius is adjusted based on the number of members. Defaults to 30.0.

The maximum speed a percentage of its regular speed that a group member can speed up to when catching up with the group. Defaults to 1.4, or 140%.

The minimum speed a percentage of its regular speed that a group member can slow down to when ahead of the group. Defaults to 0.6, or 60%.

The minimum speed as a percentage of its maximum speed that a group will slow down to so members that fell behind can catch up. Defaults to 0.3, or 30%.

When a member of a group falls back more than this factor times the group radius, the group will slow down to its max_group_slowdown_factor speed to let them catch up. Defaults to 3.

When a member of a group falls back more than this factor times the group radius, it will be dropped from the group. Defaults to 10.

The maximum number of automatically created unit groups gathering for attack at any time. Defaults to 30.

The maximum number of members for an attack unit group. This only affects automatically created unit groups, manual groups created through the API are unaffected. Defaults to 200.

Does not include the radius of the unit.

Used to make steering look better for aesthetic purposes.

The pathfinder performs a step of the backward search every fwd2bwd_ratio'th step. The minimum allowed value is 2, which means symmetric search. The default value is 5.

When looking at which node to check next, their heuristic value is multiplied by this ratio. The higher it is, the more the search is directed straight at the goal. Defaults to 2.

The maximum number of nodes that are expanded per tick. Defaults to 1,000.

The maximum amount of work each pathfinding job is allowed to do per tick. Defaults to 8,000.

Whether to cache paths at all. Defaults to true.

Number of elements in the short cache. Defaults to 5.

Number of elements in the long cache. Defaults to 25.

The minimal distance to the goal in tiles required to be searched in the short path cache. Defaults to 10.

The minimal number of nodes required to be searched in the short path cache. Defaults to 50.

The minimal distance to the goal in tiles required to be searched in the long path cache. Defaults to 30.

When looking for a connection to a cached path, search at most for this number of steps times the original estimate. Defaults to 100.

When looking for a path from cache, make sure it doesn't start too far from the requested start in relative terms. Defaults to 0.2.

When looking for a path from cache, make sure it doesn't end too far from the requested end in relative terms. This is typically more lenient than the start ratio since the end target could be moving. Defaults to 0.15.

Same principle as cache_accept_path_start_distance_ratio, but used for negative cache queries. Defaults to 0.3.

Same principle as cache_accept_path_end_distance_ratio, but used for negative cache queries. Defaults to 0.3.

When assigning a rating to the best path, this multiplier times start distances is considered. Defaults to 10.

When assigning a rating to the best path, this multiplier times end distances is considered. This value is typically higher than the start multiplier as this results in better end path quality. Defaults to 20.

A penalty that is applied for another unit that is on the way to the goal. This is mainly relevant for situations where a group of units has arrived at the target they are supposed to attack, making units further back circle around to reach the target. Defaults to 30.

The distance in tiles after which other moving units are not considered for pathfinding. Defaults to 5.

A penalty that is applied for another unit that is too close and either not moving or has a different goal. Defaults to 30.

The general collision penalty with other units. Defaults to 10.

The collision penalty for positions that require the destruction of an entity to get to. Defaults to 3.

The collision penalty for collisions in the extended bounding box but outside the entity's actual bounding box. Defaults to 3.

The amount of path finder requests accepted per tick regardless of the requested path's length. Defaults to 10.

When the max_clients_to_accept_any_new_request amount is exhausted, only path finder requests with a short estimate will be accepted until this amount (per tick) is reached. Defaults to 100.

The maximum direct distance in tiles before a request is no longer considered short. Defaults to 100.

The maximum amount of nodes a short request will traverse before being rescheduled as a long request. Defaults to 1000.

The amount of steps that are allocated to short requests each tick, as a percentage of all available steps. Defaults to 0.5, or 50%.

The minimum amount of steps that are guaranteed to be performed for every request. Defaults to 2000.

If the actual amount of steps is higher than the initial estimate by this factor, pathfinding is terminated. Defaults to 2000.0.

The thresholds of waiting clients after each of which the per-tick work limit will be increased by the corresponding value in overload_multipliers. This is to avoid clients having to wait too long. Must have the same number of elements as overload_multipliers. Defaults to {0, 100, 500}.

The multipliers to the amount of per-tick work applied after the corresponding thresholds in overload_levels have been reached. Must have the same number of elements as overload_multipliers. Defaults to {2, 3, 4}.

The delay in ticks between decrementing the score of all paths in the negative cache by one. Defaults to 20.

If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck within their own base.

A value in range [0.001, 1000].

Either "after-victory", "always" or "never". Changing this to "always" or "after-victory" does not automatically unlock the research queue. See LuaForce for that.

If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck within their own base.

Name of the item prototype whose icon should be used.

Index of the icon in the blueprint icons slots. Has to be an integer in the range [1, 4].

The icon to use. It can be any item icon as well as any virtual signal icon.

Index of the icon in the blueprint icons slots. Has to be an integer in the range [1, 4].

The entity's unique identifier in the blueprint.

The prototype name of the entity.

The position of the entity.

The direction the entity is facing. Only present for entities that can face in different directions and when the entity is not facing north.

The entity tags of the entity, if there are any. Only relevant for entity ghosts.

The items that the entity will request when revived, if there are any. It's a mapping of prototype names to amounts. Only relevant for entity ghosts.

The circuit network connections of the entity, if there are any. Only relevant for entities that support circuit connections.

The control behavior of the entity, if it has one. The format of the control behavior depends on the entity's type. Only relevant for entities that support control behaviors.

The schedule of the entity, if it has one. Only relevant for locomotives.

The position of the tile.

The prototype name of the tile.

Fluid prototype name of the fluid.

Amount of the fluid.

The temperature. When reading from LuaFluidBox, this field will always be present. It is not necessary to specify it when writing, however. When not specified, the fluid will be set to the fluid's default temperature as specified in the fluid's prototype.

"item" or "fluid".

Prototype name of the required item or fluid.

Amount of the item or fluid.

How much of this ingredient is a catalyst.

"item" or "fluid".

Prototype name of the result.

Amount of the item or fluid to give. If not specified, amount_min, amount_max and probability must all be specified.

Minimal amount of the item or fluid to give. Has no effect when amount is specified.

Maximum amount of the item or fluid to give. Has no effect when amount is specified.

A value in range [0, 1]. Item or fluid is only given with this probability; otherwise no product is produced.

How much of this product is a catalyst.

Item prototype name of the result.

Probability that any loot at all will drop, as a number in range [0, 1].

Minimum amount of loot to drop.

Maximum amount of loot to drop.

Modifier type. Specifies which of the other fields will be available. Possible values are: "inserter-stack-size-bonus", "stack-inserter-capacity-bonus", "laboratory-speed", "character-logistic-trash-slots", "maximum-following-robots-count", "worker-robot-speed", "worker-robot-storage", "ghost-time-to-live", "turret-attack", "ammo-damage", "give-item", "gun-speed", "unlock-recipe", "character-crafting-speed", "character-mining-speed", "character-running-speed", "character-build-distance", "character-item-drop-distance", "character-reach-distance", "character-resource-reach-distance", "character-item-pickup-distance", "character-loot-pickup-distance", "character-inventory-slots-bonus", "deconstruction-time-to-live", "max-failed-attempts-per-tick-per-construction-queue", "max-successful-attempts-per-tick-per-construction-queue", "character-health-bonus", "mining-drill-productivity-bonus", "train-braking-force-bonus", "zoom-to-world-enabled", "zoom-to-world-ghost-building-enabled", "zoom-to-world-blueprint-enabled", "zoom-to-world-deconstruction-planner-enabled", "zoom-to-world-upgrade-planner-enabled", "zoom-to-world-selection-tool-enabled", "worker-robot-battery", "laboratory-productivity", "follower-robot-lifetime", "artillery-range", "nothing", "character-additional-mining-categories", "character-logistic-requests".

List of prices.

The action that will take place when a player accepts the offer. Usually a "give-item" modifier.

Control prototype name.

Names the type of the expression and determines what other fields are required.

Prototype name of the noise layer.

Tile prototype name

Second prototype name

Absolute damage decrease

Percentual damage decrease

For things that are placed as spots such as ores and enemy bases, frequency is generally proportional to number of spots placed per unit area. For continuous features such as forests, frequency is how compressed the probability function is over distance, i.e. the inverse of 'scale' (similar to terrain_segmentation). When the LuaAutoplaceControlPrototype is of the category "terrain", then scale is shown in the map generator GUI instead of frequency.

For things that are placed as spots, size is proportional to the area of each spot. For continuous features, size affects how much of the map is covered with the thing, and is called 'coverage' in the GUI.

Has different effects for different things, but generally affects the 'health' or density of a thing that is placed without affecting where it is placed. For trees, richness affects tree health. For ores, richness multiplies the amount of ore at any given tile in a patch. Metadata about autoplace controls (such as whether or not 'richness' does anything for them) can be found in the LuaAutoplaceControlPrototype by looking up game.autoplace_control_prototypes[(control prototype name)], e.g. game.autoplace_control_prototypes["enemy-base"].richness is false, because enemy base autoplacement doesn't use richness.

Whether missing autoplace names for this type should be default enabled.

Name of the cliff prototype.

Elevation at which the first row of cliffs is placed. The default is 10, and this cannot be set from the map generation GUI.

Elevation difference between successive rows of cliffs. This is inversely proportional to 'frequency' in the map generation GUI. Specifically, when set from the GUI the value is 40 / frequency.

Corresponds to 'continuity' in the GUI. This value is not used directly, but is used by the 'cliffiness' noise expression, which in combination with elevation and the two cliff elevation properties drives cliff placement (cliffs are placed when elevation crosses the elevation contours defined by cliff_elevation_0 and cliff_elevation_interval when 'cliffiness' is greater than 0.5). The default 'cliffiness' expression interprets this value such that larger values result in longer unbroken walls of cliffs, and smaller values (between 0 and 1) result in larger gaps in cliff walls.

The inverse of 'water scale' in the map generator GUI. Lower terrain_segmentation increases the scale of elevation features (lakes, continents, etc). This behavior can be overridden with alternate elevation generators (see property_expression_names, below).

The equivalent to 'water coverage' in the map generator GUI. Specifically, when this value is non-zero, water_level = 10 * log2 (the value of this field), and the elevation generator subtracts water level from elevation before adding starting lakes. If water is set to 'none', elevation is clamped to a small positive value before adding starting lakes. This behavior can be overridden with alternate elevation generators (see property_expression_names, below).

Indexed by autoplace control prototype name.

Whether undefined autoplace_controls should fall back to the default controls or not. Defaults to true.

Each setting in this dictionary maps the string type to the settings for that type. Valid types are "entity", "tile" and "decorative".

Map generation settings for entities of the type "cliff".

The random seed used to generated this map.

Width in tiles. If 0, the map has 'infinite' width, with the actual limitation being one million tiles in each direction from the center.

Height in tiles. If 0, the map has 'infinite' height, with the actual limitation being one million tiles in each direction from the center.

Size of the starting area.

Positions of the starting areas.

Whether peaceful mode is enabled for this map.

Overrides for tile property value generators. Values either name a NamedNoiseExpression or can be literal numbers, stored as strings (e.g. "5"). All other controls can be overridden by a property expression names. Notable properties:
- moisture - a value between 0 and 1 that determines whether a tile becomes sandy (low moisture) or grassy (high moisture).
- aux - a value between 0 and 1 that determines whether low-moisture tiles become sand or red desert.
- temperature - provides a value (vaguely representing degrees Celsius, varying between -20 and 50) that is used (together with moisture and aux) as part of tree and decorative placement.
- elevation - tiles values less than zero become water. Cliffs are placed along certain contours according to CliffPlacementSettings.
- cliffiness - determines whether (when >0.5) or not (when <0.5) a cliff will be placed at an otherwise suitable (according to CliffPlacementSettings) location.
- enemy-base-intensity - a number that is referenced by both enemy-base-frequency and enemy-base-radius. i.e. if this is overridden, enemy base frequency and size will both be affected and do something reasonable. By default, this expression returns a value proportional to distance from any starting point, clamped at about 7.
- enemy-base-frequency - a number representing average number of enemy bases per tile for a region, by default in terms of enemy-base-intensity.
- enemy-base-radius - a number representing the radius of an enemy base, if one were to be placed on the given tile, by default proportional to a constant plus enemy-base-intensity. Climate controls ('Moisture' and 'Terrain type' at the bottom of the Terrain tab in the map generator GUI) don't have their own dedicated structures in MapGenSettings. Instead, their values are stored as property expression overrides with long names:
- control-setting:moisture:frequency:multiplier - frequency (inverse of scale) multiplier for moisture noise. Default is 1.
- control-setting:moisture:bias - global bias for moisture (which normally varies between 0 and 1). Default is 0.
- control-setting:aux:frequency:multiplier - frequency (inverse of scale) multiplier for aux (called 'terrain type' in the GUI) noise. Default is 1.
- control-setting:aux:bias - global bias for aux/terrain type (which normally varies between 0 and 1). Default is 0. All other MapGenSettings feed into named noise expressions, and therefore placement can be overridden by including the name of a property in this dictionary. The probability and richness functions for placing specific tiles, entities, and decoratives can be overridden by including an entry named {tile|entity|decorative}:(prototype name):{probability|richness}.