Concepts

LocalisedString

Localised strings are a way to support translation of in-game text. It is an array where the first element is the key and the remaining elements are parameters that will be substituted for placeholders in the template designated by the key.

The key identifies the string template. For example, "gui-alert-tooltip.attack" (for the template "__1__ objects are being damaged"; see the file data/core/locale/en.cfg).

The template can contain placeholders such as __1__ or __2__. These will be replaced by the respective parameter in the LocalisedString. The parameters themselves can be other localised strings, which will be processed recursively in the same fashion. Localised strings cannot be recursed deeper than 20 levels and cannot have more than 20 parameters.

As a special case, when the key is just the empty string, all the parameters will be concatenated (after processing, if any are localised strings). If there is only one parameter, it will be used as is.

Furthermore, when an API function expects a localised string, it will also accept a regular string (i.e. not a table) which will not be translated, or number which will be converted to its textual representation.

Example

In the English translation, this will print "No ammo"; in the Czech translation, it will print "Bez munice":

game.player.print({"description.no-ammo"})

The description.no-ammo template contains no placeholders, so no further parameters are necessary.

Example

In the English translation, this will print "Durability: 5/9"; in the Japanese one, it will print "耐久度: 5/9":

game.player.print({"description.durability", 5, 9})

Example

This will print "hello" in all translations:

game.player.print({"", "hello"})

Example

This will print "Iron plate: 60" in the English translation and "Eisenplatte: 60" in the German translation.

game.print({"", {"item-name.iron-plate"}, ": ", 60})

DisplayResolution

Table with the following fields:

width :: uint
height :: uint

PersonalLogisticParameters

Table with the following fields:

name :: string (optional): The item. nil clears the filter.
min :: uint (optional)
max :: uint (optional)

RealOrientation

The smooth orientation. It is a float in the range [0, 1) that covers a full circle, starting at the top and going clockwise. This means a value of 0 indicates "north", a value of 0.5 indicates "south".

For example then, a value of 0.625 would indicate "south-west", and a value of 0.875 would indicate "north-west".

Position

Coordinates of a tile in a map. Positions may be specified either as a dictionary with x, y as keys, or simply as an array with two elements.

Table with the following fields:

x :: int
y :: int

Example

Explicit definition:

    {x = 50, y = 20}

    {y = 20, x = 50}

Example

Shorthand:

{10, 20}

ChunkPosition

Coordinates of a chunk in a LuaSurface where each integer x/y represents a different chunk. This uses the same format as Position, meaning it can be specified either with or without explicit keys. A Position can be translated to a ChunkPosition by dividing the x/y values by 32.

Table with the following fields:

x :: int
y :: int

TilePosition

Coordinates of a tile in a chunk on a LuaSurface where each integer x/y represents a different tile. This uses the same format as Position except it rounds any x/y down to whole numbers. It can be specified either with or without explicit keys.

Table with the following fields:

x :: int
y :: int

GuiLocation

Screen coordinates of a GUI element in a LuaGui. This uses the same format as Position except it rounds any x/y down to whole numbers. It can be specified either with or without explicit keys.

Table with the following fields:

x :: int
y :: int

ChunkPositionAndArea

A ChunkPosition with an added bounding box for the area of the chunk.

Table with the following fields:

x :: int
y :: int
area :: BoundingBox

EquipmentPoint

A table used to define a manual shape for a piece of equipment.

Table with the following fields:

x :: uint
y :: uint

GuiAnchor

Table with the following fields:

gui :: defines.relative_gui_type
position :: defines.relative_gui_position
type :: string (optional): If provided, only anchors the GUI element when the opened things type matches the type.
name :: string (optional): If provided, only anchors the GUI element when the opened thing matches the name. name takes precedence over names.
names :: array[string] (optional): If provided, only anchors the GUI element when the opened thing matches one of the names. When reading an anchor, names is always populated.

TabAndContent

Table with the following fields:

tab :: LuaGuiElement
content :: LuaGuiElement

OldTileAndPosition

Table with the following fields:

old_tile :: LuaTilePrototype
position :: TilePosition

SmokeSource

Table with the following fields:

name :: string
frequency :: double
offset :: double
position :: Vector (optional)
north_position :: Vector (optional)
east_position :: Vector (optional)
south_position :: Vector (optional)
west_position :: Vector (optional)
deviation :: Position (optional)
starting_frame_speed :: uint16
starting_frame_speed_deviation :: double
starting_frame :: uint16
starting_frame_deviation :: double
slow_down_factor :: uint8
height :: float
height_deviation :: float
starting_vertical_speed :: float
starting_vertical_speed_deviation :: float
vertical_speed_slowdown :: float

Note: The vectors for all 5 position attributes are a table with x and y keys instead of an array.

Vector

A vector is a two-element array containing the x and y components. In some specific cases, the vector is a table with x and y keys instead, which the documentation will point out.

Example

right = {1.0, 0.0}

BoundingBox

Two positions, specifying the top-left and bottom-right corner of the box respectively. Like with Position, the names of the members may be omitted. When read from the game, the third member orientation is present if it is non-zero, however it is ignored when provided to the game.

Table with the following fields:

left_top :: Position
right_bottom :: Position
orientation :: RealOrientation (optional)

Example

Explicit definition:

{left_top = {-2, -3}, right_bottom = {5, 8}}

Example

Shorthand:

{{-2, -3}, {5, 8}}

ScriptArea

An area defined using the map editor.

Table with the following fields:

area :: BoundingBox
name :: string
color :: Color
id :: uint

ScriptPosition

A position defined using the map editor.

Table with the following fields:

position :: Position
name :: string
color :: Color
id :: uint

Color

Red, green, blue and alpha values, all in range [0, 1] or all in range [0, 255] if any value is > 1. All values here are optional. Color channels default to 0, the alpha channel defaults to 1.

Similar to Position, Color allows the short-hand notation of passing an array of exactly 3 or 4 numbers. The game usually expects colors to be in pre-multiplied form (color channels are pre-multiplied by alpha).

Table with the following fields:

r :: float (optional)
g :: float (optional)
b :: float (optional)
a :: float (optional)

Example

    red1 = {r = 0.5, g = 0, b = 0, a = 0.5}  -- Half-opacity red

    red2 = {r = 0.5, a = 0.5}                -- Same color as red1

    black = {}                               -- All channels omitted: black

    red1_short = {0.5, 0, 0, 0.5}            -- Same color as red1 in short-hand notation

ColorModifier

Same as Color, but red, green, blue and alpha values can be any floating point number, without any special handling of the range [1, 255].

Table with the following fields:

r :: float (optional)
g :: float (optional)
b :: float (optional)
a :: float (optional)

CraftingQueueItem

Table with the following fields:

index :: uint: The index of the item in the crafting queue.
recipe :: string: The recipe being crafted.
count :: uint: The amount of items being crafted.

Alert

Table with the following fields:

tick :: uint: The tick this alert was created.
target :: LuaEntity (optional)
prototype :: LuaEntityPrototype (optional)
position :: Position (optional)
icon :: SignalID (optional): The SignalID used for a custom alert. Only present for custom alerts.
message :: LocalisedString (optional): The message for a custom alert. Only present for custom alerts.

ScriptRenderVertexTarget

One vertex of a ScriptRenderPolygon.

Table with the following fields:

target :: Position or LuaEntity
target_offset :: Vector (optional): Only used if target is a LuaEntity.

PathfinderWaypoint

Table with the following fields:

position :: Position: The position of the waypoint on its surface.
needs_destroy_to_reach :: boolean: true if the path from the previous waypoint to this one goes through an entity that must be destroyed.

CutsceneWaypoint

Table with the following fields:

position :: Position (optional): Position to pan the camera to.
target :: LuaEntity or LuaUnitGroup (optional): Entity or unit group to pan the camera to.
transition_time :: uint: How many ticks it will take to reach this waypoint from the previous one.
time_to_wait :: uint: Time in ticks to wait before moving to the next waypoint.
zoom :: double (optional): Zoom level to be set when the waypoint is reached. When not specified, the previous waypoint's zoom is used.

Decorative

Table with the following fields:

name :: string: The name of the decorative prototype.
position :: Position
amount :: uint8

DecorativeResult

Table with the following fields:

position :: TilePosition
decorative :: LuaDecorativePrototype
amount :: uint

ChartTagSpec

Table with the following fields:

position :: Position
icon :: SignalID (optional)
text :: string (optional)
last_user :: PlayerIdentification (optional)

Note: Either icon, text, or both must be provided.

GameViewSettings

Parameters that affect the look and control of the game. Updating any of the member attributes here will immediately take effect in the game engine.

show_controller_gui :: boolean [Read-Write]

Show the controller GUI elements. This includes the toolbar, the selected tool slot, the armour slot, and the gun and ammunition slots.

show_minimap :: boolean [Read-Write]

Show the chart in the upper right-hand corner of the screen.

show_research_info :: boolean [Read-Write]

Show research progress and name in the upper right-hand corner of the screen.

show_entity_info :: boolean [Read-Write]

Show overlay icons on entities. Also known as "alt-mode".

show_alert_gui :: boolean [Read-Write]

Show the flashing alert icons next to the player's toolbar.

update_entity_selection :: boolean [Read-Write]

When true (the default), mousing over an entity will select it. Otherwise, moving the mouse won't update entity selection.

show_rail_block_visualisation :: boolean [Read-Write]

When true (false is default), the rails will always show the rail block visualisation.

show_side_menu :: boolean [Read-Write]

Shows or hides the buttons row.

show_map_view_options :: boolean [Read-Write]

Shows or hides the view options when map is opened.

show_quickbar :: boolean [Read-Write]

Shows or hides quickbar of shortcuts.

show_shortcut_bar :: boolean [Read-Write]

Shows or hides the shortcut bar.

MapViewSettings

What is shown in the map view. If a field is not given, that setting will not be changed.

Table with the following fields:

show-logistic-network :: boolean (optional)
show-electric-network :: boolean (optional)
show-turret-range :: boolean (optional)
show-pollution :: boolean (optional)
show-train-station-names :: boolean (optional)
show-player-names :: boolean (optional)
show-networkless-logistic-members :: boolean (optional)
show-non-standard-map-info :: boolean (optional)

MapSettings

Various game-related settings. See data/base/prototypes/map-settings.lua for a description of all attributes. Updating any of the attributes will immediately take effect in the game engine.

Example

Increase the number of short paths the pathfinder can cache.

game.map_settings.path_finder.short_cache_size = 15

DifficultySettings

Technology and recipe difficulty settings.

Table with the following fields:

recipe_difficulty :: defines.difficulty_settings.recipe_difficulty
technology_difficulty :: defines.difficulty_settings.technology_difficulty
technology_price_multiplier :: double: A value in range [0.001, 1000].
research_queue_setting :: string: Either "after-victory", "always" or "never". Changing this to "always" or "after-victory" does not automatically unlock the research queue. See LuaForce for that.

MapExchangeStringData

The data that can be extracted from a map exchange string, as a plain table.

Table with the following fields:

map_settings :: MapSettings: All the regular map settings plus an additional table called difficulty_settings that contains the DifficultySettings.
map_gen_settings :: MapGenSettings

BlueprintItemIcon

Table with the following fields:

name :: string: Name of the item prototype whose icon should be used.
index :: uint: Index of the icon in the blueprint icons slots. Has to be an integer in the range [1, 4].

BlueprintSignalIcon

Table with the following fields:

signal :: SignalID: The icon to use. It can be any item icon as well as any virtual signal icon.
index :: uint: Index of the icon in the blueprint icons slots. Has to be an integer in the range [1, 4].

BlueprintEntity

The representation of an entity inside of a blueprint. It has at least these fields, but can contain additional ones depending on the kind of entity.

Table with the following fields:

entity_number :: uint: The entity's unique identifier in the blueprint.
name :: string: The prototype name of the entity.
position :: Position: The position of the entity.
direction :: defines.direction (optional): The direction the entity is facing. Only present for entities that can face in different directions and when the entity is not facing north.
tags :: Tags (optional): The entity tags of the entity, if there are any. Only relevant for entity ghosts.
items :: dictionary[string → uint] (optional): 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.
connections :: BlueprintCircuitConnection (optional): The circuit network connections of the entity, if there are any. Only relevant for entities that support circuit connections.
control_behavior :: BlueprintControlBehavior (optional): 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.
schedule :: array[TrainScheduleRecord] (optional): The schedule of the entity, if it has one. Only relevant for locomotives.

Tile

Table with the following fields:

position :: Position: The position of the tile.
name :: string: The prototype name of the tile.

Fluid

Table with the following fields:

name :: string: Fluid prototype name of the fluid.
amount :: double: Amount of the fluid.
temperature :: double (optional): 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.

Ingredient

Table with the following fields:

type :: string: "item" or "fluid".
name :: string: Prototype name of the required item or fluid.
amount :: double: Amount of the item or fluid.
catalyst_amount :: uint or double (optional): How much of this ingredient is a catalyst.
Other attributes may be specified depending on type:
- fluid
  - minimum_temperature :: double (optional): The minimum fluid temperature required.
  - maximum_temperature :: double (optional): The maximum fluid temperature allowed.

Product

Table with the following fields:

type :: string: "item" or "fluid".
name :: string: Prototype name of the result.
amount :: double (optional): Amount of the item or fluid to give. If not specified, amount_min, amount_max and probability must all be specified.
amount_min :: uint or double (optional): Minimal amount of the item or fluid to give. Has no effect when amount is specified.
amount_max :: uint or double (optional): Maximum amount of the item or fluid to give. Has no effect when amount is specified.
probability :: double (optional): A value in range [0, 1]. Item or fluid is only given with this probability; otherwise no product is produced.
catalyst_amount :: uint or double (optional): How much of this product is a catalyst.
Other attributes may be specified depending on type:
- fluid
  - temperature :: double (optional): The fluid temperature of this product.

Example

Products of the "steel-chest" recipe (an array of Product):

{{type="item", name="steel-chest", amount=1}}

Example

Products of the "advanced-oil-processing" recipe:

    {{type="fluid", name="heavy-oil", amount=1},

     {type="fluid", name="light-oil", amount=4.5},

     {type="fluid", name="petroleum-gas", amount=5.5}}

Example

What a custom recipe would look like that had a probability of 0.5 to return a minimum amount of 1 and a maximum amount of 5:

{{type=0, name="custom-item", probability=0.5, amount_min=1, amount_max=5}}

Loot

Table with the following fields:

item :: string: Item prototype name of the result.
probability :: double: Probability that any loot at all will drop, as a number in range [0, 1].
count_min :: double: Minimum amount of loot to drop.
count_max :: double: Maximum amount of loot to drop.

TechnologyModifier

The effect that is applied when a technology is researched. It is a table that contains at least the field type.

Table with the following fields:

type :: string: 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".
Other attributes may be specified depending on type:
- gun-speed
  - ammo_category :: string: Prototype name of the ammunition category that is affected
  - modifier :: double: Modification value. This will be added to the current gun speed modifier upon researching.
- ammo-damage
  - ammo_category :: string: Prototype name of the ammunition category that is affected
  - modifier :: double: Modification value. This will be added to the current ammo damage modifier upon researching.
- give-item
  - item :: string: Item prototype name to give.
  - count :: uint (optional): Number of items to give. Defaults to 1.
- turret-attack
  - turret_id :: string: Turret prototype name this modifier will affect.
  - modifier :: double: Modification value. This will be added to the current turret damage modifier upon researching.
- unlock-recipe
  - recipe :: string: Recipe prototype name to unlock.
- nothing
  - effect_description :: LocalisedString: Description of this nothing modifier.
- Other types
  - modifier :: double: Modification value. This value will be added to the variable it modifies.

Offer

A single offer on a market entity.

Table with the following fields:

price :: array[Ingredient]: List of prices.
offer :: TechnologyModifier: The action that will take place when a player accepts the offer. Usually a "give-item" modifier.

AutoplaceSpecification

Specifies how probability and richness are calculated when placing something on the map. Can be specified either using probability_expression and richness_expression or by using all the other fields.

Table with the following fields:

probability_expression :: NoiseExpression
richness_expression :: NoiseExpression
coverage :: double
sharpness :: double
max_probability :: double
placement_density :: uint
richness_base :: double
richness_multiplier :: double
richness_multiplier_distance_bonus :: double
starting_area_size :: uint
order :: string
default_enabled :: boolean
peaks :: array[AutoplaceSpecificationPeak] (optional)
control :: string (optional): Control prototype name.
tile_restriction :: array[AutoplaceSpecificationRestriction] (optional)
force :: string
random_probability_penalty :: double

NoiseExpression

A fragment of a functional program used to generate coherent noise, probably for purposes related to terrain generation. These can only be meaningfully written/modified during the data load phase. More detailed information is found on the wiki.

Table with the following fields:

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

AutoplaceSpecificationPeak

Table with the following fields:

influence :: double
max_influence :: double
min_influence :: double
richness_influence :: double
noisePersistence :: double
noise_layer :: string (optional): Prototype name of the noise layer.
noise_octaves_difference :: double
water_optimal :: double
water_range :: double
water_max_range :: double
water_top_property_limit :: double
elevation_optimal :: double
elevation_range :: double
elevation_max_range :: double
elevation_top_property_limit :: double
temperature_optimal :: double
temperature_range :: double
temperature_max_range :: double
temperature_top_property_limit :: double
starting_area_weight_optimal :: double
starting_area_weight_range :: double
starting_area_weight_max_range :: double
starting_area_weight_top_property_limit :: double
tier_from_start_optimal :: double
tier_from_start_range :: double
tier_from_start_max_range :: double
tier_from_start_top_property_limit :: double
distance_optimal :: double
distance_range :: double
distance_max_range :: double
distance_top_property_limit :: double
aux_optimal :: double
aux_range :: double
aux_max_range :: double
aux_top_property_limit :: double

AutoplaceSpecificationRestriction

Table with the following fields:

first :: string (optional): Tile prototype name
second :: string (optional): Second prototype name

Resistance

Table with the following fields:

decrease :: float: Absolute damage decrease
percent :: float: Percentual damage decrease

MapGenSize

A floating point number specifying an amount.

For backwards compatibility, MapGenSizes can also be specified as one of the following strings, which will be converted to a number (when queried, a number will always be returned):

"none" - equivalent to 0
"very-low", "very-small", "very-poor" - equivalent to 1/2
"low", "small", "poor" - equivalent to 1/sqrt(2)
"normal", "medium", "regular" - equivalent to 1
"high", "big", "good" - equivalent to sqrt(2)
"very-high", "very-big", "very-good" - equivalent to 2

Note: The map generation algorithm officially supports the range of values the in-game map generation screen shows (specifically 0 and values from 1/6 to 6). Values outside this range are not guaranteed to work as expected.

AutoplaceSetting

Table with the following fields:

frequency :: MapGenSize
size :: MapGenSize
richness :: MapGenSize

AutoplaceSettings

Table with the following fields:

treat_missing_as_default :: boolean: Whether missing autoplace names for this type should be default enabled.
settings :: dictionary[string → AutoplaceSetting]

AutoplaceControl

Table with the following fields:

frequency :: MapGenSize: 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.
size :: MapGenSize: 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.
richness :: MapGenSize: 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.

CliffPlacementSettings

Table with the following fields:

name :: string: Name of the cliff prototype.
cliff_elevation_0 :: float: Elevation at which the first row of cliffs is placed. The default is 10, and this cannot be set from the map generation GUI.
cliff_elevation_interval :: float: 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.
richness :: MapGenSize: 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.

MapGenSettings

Table with the following fields:

terrain_segmentation :: MapGenSize: 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).
water :: MapGenSize: 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).
autoplace_controls :: dictionary[string → AutoplaceControl]: Indexed by autoplace control prototype name.
default_enable_all_autoplace_controls :: boolean: Whether undefined autoplace_controls should fall back to the default controls or not. Defaults to true.
autoplace_settings :: dictionary[string → AutoplaceSettings]: Each setting in this dictionary maps the string type to the settings for that type. Valid types are "entity", "tile" and "decorative".
cliff_settings :: CliffPlacementSettings: Map generation settings for entities of the type "cliff".
seed :: uint: The random seed used to generated this map.
width :: uint: 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 :: uint: Height in tiles. If 0, the map has 'infinite' height, with the actual limitation being one million tiles in each direction from the center.
starting_area :: MapGenSize: Size of the starting area.
starting_points :: array[Position]: Positions of the starting areas.
peaceful_mode :: boolean: Whether peaceful mode is enabled for this map.
property_expression_names :: dictionary[string → string]: 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}.

The 'map type' dropdown in the map generation GUI is actually a selector for elevation generator. The base game sets property_expression_names.elevation to "0_16-elevation" to reproduce terrain from 0.16 or to "0_17-island" for the island preset. If generators are available for other properties, the 'map type' dropdown in the GUI will be renamed to 'elevation' and shown along with selectors for the other selectable properties.

Example

Assuming a NamedNoiseExpression with the name "my-alternate-grass1-probability" is defined

    local surface = game.player.surface

    local mgs = surface.map_gen_settings

    mgs.property_expression_names["tile:grass1:probability"] = "my-alternate-grass1-probability"

    surface.map_gen_settings = mgs

would override the probability of grass1 being placed at any given point on the current surface.

Example

To make there be no deep water on (newly generated chunks) a surface:

    local surface = game.player.surface

    local mgs = surface.map_gen_settings

    mgs.property_expression_names["tile:deepwater:probability"] = -1000

    surface.map_gen_settings = mgs

This does not require a NamedNoiseExpression to be defined, since literal numbers (and strings naming literal numbers, e.g. "123") are understood to stand for constant value expressions.

SignalID

Table with the following fields:

type :: string: "item", "fluid", or "virtual".
name :: string (optional): Name of the item, fluid or virtual signal.

Signal

An actual signal transmitted by the network.

Table with the following fields:

signal :: SignalID: ID of the signal.
count :: int: Value of the signal.

UpgradeFilter

Table with the following fields:

type :: string: "item", or "entity".
name :: string (optional): Name of the item, or entity.

InfinityInventoryFilter

A single filter used by an infinity-filters instance.

Table with the following fields:

name :: string: Name of the item.
count :: uint (optional): The count of the filter.
mode :: string (optional): "at-least", "at-most", or "exactly". Defaults to "at-least".
index :: uint: The index of this filter in the filters list.

InfinityPipeFilter

A single filter used by an infinity-pipe type entity.

Table with the following fields:

name :: string: Name of the fluid.
percentage :: double (optional): The fill percentage the pipe (e.g. 0.5 for 50%). Can't be negative.
temperature :: double (optional): The temperature of the fluid. Defaults to the default/minimum temperature of the fluid.
mode :: string (optional): "at-least", "at-most", "exactly", "add", or "remove". Defaults to "at-least".

FluidBoxFilter

Table with the following fields:

name :: string: Fluid prototype name of the filtered fluid.
minimum_temperature :: double: The minimum temperature allowed into the fluidbox.
maximum_temperature :: double: The maximum temperature allowed into the fluidbox.

FluidBoxFilterSpec

Table with the following fields:

name :: string: Fluid prototype name of the filtered fluid.
minimum_temperature :: double (optional): The minimum temperature allowed into the fluidbox.
maximum_temperature :: double (optional): The maximum temperature allowed into the fluidbox.
force :: boolean (optional): Force the filter to be set, regardless of current fluid content.

HeatSetting

The settings used by a heat-interface type entity.

Table with the following fields:

temperature :: double (optional): The target temperature. Defaults to the minimum temperature of the heat buffer.
mode :: string (optional): "at-least", "at-most", "exactly", "add", or "remove". Defaults to "at-least".

HeatConnection

Table with the following fields:

position :: Vector
direction :: defines.direction

FluidBoxConnection

A definition of a fluidbox connection point.

Table with the following fields:

type :: string: The connection type: "input", "output", or "input-output".
positions :: array[Vector]: The 4 cardinal direction connection points for this pipe. This vector is a table with x and y keys instead of an array.
max_underground_distance :: uint (optional): The maximum tile distance this underground connection can connect at if this is an underground pipe.

ArithmeticCombinatorParameters

Table with the following fields:

first_signal :: SignalID (optional): First signal to use in an operation. If not specified, the second argument will be the value of first_constant.
second_signal :: SignalID (optional): Second signal to use in an operation. If not specified, the second argument will be the value of second_constant.
first_constant :: int (optional): Constant to use as the first argument of the operation. Has no effect when first_signal is set. Defaults to 0.
second_constant :: int (optional): Constant to use as the second argument of the operation. Has no effect when second_signal is set. Defaults to 0.
operation :: string (optional): Must be one of "*", "/", "+", "-", "%", "^", "<<", ">>", "AND", "OR", "XOR". When not specified, defaults to "*".
output_signal :: SignalID (optional): Specifies the signal to output.

ConstantCombinatorParameters

Table with the following fields:

signal :: SignalID: Signal to emit.
count :: int: Value of the signal to emit.
index :: uint: Index of the constant combinator's slot to set this signal to.

ComparatorString

A string that specifies how the inputs should be compared.

"=": "equal to"
">": "greater than"
"<": "lesser than"
"≥": "greater than or equal to"
">=": "greater than or equal to"
"≤": "lesser than or equal to"
"<=": "lesser than or equal to"
"≠": "not equal to"
"!=": "not equal to"

Note: While the API accepts both versions for "less/greater than or equal to" and "not equal", it'll always return "≥", "≤" or "≠" respectively when reading them back.

DeciderCombinatorParameters

Table with the following fields:

first_signal :: SignalID (optional): Defaults to blank.
second_signal :: SignalID (optional): Second signal to use in an operation, if any. If this is not specified, the second argument to a decider combinator's operation is assumed to be the value of constant.
constant :: uint (optional): Constant to use as the second argument of operation. Defaults to 0.
comparator :: ComparatorString (optional): Specifies how the inputs should be compared. If not specified, defaults to "<".
output_signal :: SignalID (optional): Defaults to blank.
copy_count_from_input :: boolean (optional): Defaults to true. When false, will output a value of 1 for the given output_signal.

InserterCircuitConditions

Table with the following fields:

circuit :: CircuitCondition (optional)
logistics :: CircuitCondition (optional)

CircuitCondition

Table with the following fields:

comparator :: ComparatorString (optional): Specifies how the inputs should be compared. If not specified, defaults to "<".
first_signal :: SignalID (optional): Defaults to blank
second_signal :: SignalID (optional): What to compare first_signal to. If not specified, first_signal will be compared to constant.
constant :: int (optional): Constant to compare first_signal to. Has no effect when second_signal is set. When neither second_signal nor constant are specified, the effect is as though constant were specified with the value 0.

CircuitConditionDefinition

Table with the following fields:

condition :: CircuitCondition
fulfilled :: boolean (optional): Whether the condition is currently fulfilled

CircuitConnectionDefinition

Table with the following fields:

wire :: defines.wire_type: Wire color, either defines.wire_type.red or defines.wire_type.green.
target_entity :: LuaEntity
source_circuit_id :: defines.circuit_connector_id
target_circuit_id :: defines.circuit_connector_id

WireConnectionDefinition

Table with the following fields:

wire :: defines.wire_type: Wire color, either defines.wire_type.red or defines.wire_type.green.
target_entity :: LuaEntity: The entity to (dis)connect the source entity with.
source_circuit_id :: defines.circuit_connector_id (optional): Mandatory if the source entity has more than one circuit connection using circuit wire.
target_circuit_id :: defines.circuit_connector_id (optional): Mandatory if the target entity has more than one circuit connection using circuit wire.
source_wire_id :: defines.circuit_connector_id (optional): Mandatory if the source entity has more than one wire connection using copper wire.
target_wire_id :: defines.circuit_connector_id (optional): Mandatory if the target entity has more than one wire connection using copper wire.

InventoryFilter

Table with the following fields:

index :: uint: Position of the corresponding filter slot.
name :: string: Item prototype name of the item to filter.

PlaceAsTileResult

Table with the following fields:

result :: LuaTilePrototype: The tile prototype.
condition_size :: uint
condition :: CollisionMask

Command

Commands can be given to enemies and unit groups.

Table with the following fields:

type :: defines.command: Type of command. The remaining fields depend on the value of this field.
Other attributes may be specified depending on type:
- defines.command.attack
  - target :: LuaEntity
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
- defines.command.go_to_location
  - destination :: Position (optional): The position to path to. Either this or destination_entity need to be specified. If both are, destination_entity is used.
  - destination_entity :: LuaEntity (optional): The entity to path to. Either this or destination need to be specified. If both are, destination_entity is used.
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
  - pathfind_flags :: PathfinderFlags (optional): Flags that affect pathfinder behavior.
  - radius :: double (optional): How close the pathfinder needs to get to its destination (in tiles). Defaults to 3.
- defines.command.compound
  - structure_type :: defines.compound_command: How the commands should be chained together.
  - commands :: array[Command]: The sub-commands.
- defines.command.group
  - group :: LuaUnitGroup: The group whose command to follow.
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
  - use_group_distraction :: boolean (optional): Whether the unit will use the group distraction or the commands distraction. Defaults to true.
- defines.command.attack_area
  - destination :: Position: Center of the attack area.
  - radius :: double: Radius of the attack area.
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
- defines.command.wander
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
  - radius :: double (optional): Defaults to 10. Does not apply when wander_in_group is true.
  - wander_in_group :: boolean (optional): When commanding a group, defines how the group will wander. When true, the units in the group will wander around inside the group's radius, just like gathering biters. When false, the units will wander as a group, ie they will all walk together in the same random direction. Default is true for groups. Passing true for a single unit is an error.
  - ticks_to_wait :: uint (optional): Ticks to wander before successfully completing the command. Default is max uint, which means wander forever.
- defines.command.stop
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
  - ticks_to_wait :: uint (optional): Ticks to wander before successfully completing the command. Default is max uint, which means stop forever.
- defines.command.flee
  - from :: LuaEntity: The entity to flee from
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
- defines.command.build_base
  - destination :: Position: Where to build the base.
  - distraction :: defines.distraction (optional): Defaults to defines.distraction.by_enemy.
  - ignore_planner :: boolean (optional): Whether the units should ignore expansion candidate chunks. When false, they will obey and not build a base in a non-candidate chunk. Defaults to false.

PathfinderFlags

Table with the following fields:

allow_destroy_friendly_entities :: boolean (optional): Allows pathing through friendly entities. Defaults to false.
allow_paths_through_own_entities :: boolean (optional): Allows the pathfinder to path through entities of the same force. Defaults to false.
cache :: boolean (optional): Enables path caching. This can be more efficient, but might fail to respond to changes in the environment. Defaults to true.
prefer_straight_paths :: boolean (optional): Makes the pathfinder try to path in straight lines. Defaults to false.
low_priority :: boolean (optional): Sets lower priority on the path request, meaning it might take longer to find a path at the expense of speeding up others. Defaults to false.
no_break :: boolean (optional): Makes the pathfinder not break in the middle of processing this pathfind, no matter how much work is needed. Defaults to false.

UnitSpawnDefinition

Table with the following fields:

unit :: string: Prototype name of the unit that would be spawned.
spawn_points :: array[SpawnPointDefinition]: The points at which to spawn the unit.

SpawnPointDefinition

Table with the following fields:

evolution_factor :: double: Evolution factor for which this weight applies.
weight :: double: Probability of spawning this unit at this evolution factor.

ItemStackDefinition

Table with the following fields:

name :: string: Prototype name of the item the stack holds.
count :: uint (optional): Number of items the stack holds. If not specified, defaults to 1.
health :: float (optional): Health of the items in the stack. Defaults to 1.0.
durability :: double (optional): Durability of the tool items in the stack.
ammo :: double (optional): Amount of ammo in the ammo items in the stack.
tags :: array[string] (optional): Tags of the items with tags in the stack.

SimpleItemStack

An item stack may be specified in one of two ways:

As a string: The name of the item, which represents a full stack of that item.
As an ItemStackDefinition: The detailed definition of an item stack.

Example

Both of these lines specify an item stack of one iron plate:

{name="iron-plate"}

{name="iron-plate", count=1}

Example

This is a stack of 47 copper plates:

{name="copper-plate", count=47}

Example

These are both full stacks of iron plates (for iron-plate, a full stack is 100 plates):

"iron-plate"

{name="iron-plate", count=100}

FluidIdentification

A fluid may be specified in one of three ways:

As a string: The fluid name.
As a LuaFluidPrototype: The fluid prototype.
As a Fluid: The fluid.

ForceIdentification

A force may be specified in one of two ways:

As a string: The force name.
As a LuaForce: A reference to LuaForce may be passed directly.

TechnologyIdentification

A technology may be specified in one of three ways:

As a string: The technology name.
As a LuaTechnology: A reference to LuaTechnology may be passed directly.
As a LuaTechnologyPrototype: A reference to LuaTechnologyPrototype may be passed directly.

SurfaceIdentification

A surface may be specified in one of three ways:

As an uint: It will be the index of the surface. nauvis has index 1, the first surface-created surface will have index 2 and so on.
As a string: It will be the surface name. E.g. "nauvis".
As a LuaSurface: A reference to LuaSurface may be passed directly.

PlayerIdentification

A player may be specified in one of three ways:

As a uint: The player index.
As a string: The player name.
As a LuaPlayer: A reference to LuaPlayer may be passed directly.

ItemStackIdentification

An item may be specified in one of two ways:

As a SimpleItemStack
As a LuaItemStack

EntityPrototypeIdentification

An entity prototype may be specified in one of three ways:

As a LuaEntity: The entity.
As a LuaEntityPrototype: The entity prototype.
As a string: The prototype name.

ItemPrototypeIdentification

An item prototype may be specified in one of three ways:

As a LuaItemStack: The item.
As a LuaItemPrototype: The item prototype.
As a string: The prototype name.

WaitCondition

Table with the following fields:

type :: string: One of "time", "inactivity", "full", "empty", "item_count", "circuit", "robots_inactive", "fluid_count", "passenger_present", "passenger_not_present".
compare_type :: string: Either "and", or "or". Tells how this condition is to be compared with the preceding conditions in the corresponding wait_conditions array.
ticks :: uint (optional): Number of ticks to wait or of inactivity. Only present when type is "time" or "inactivity".
condition :: CircuitCondition (optional): Only present when type is "item_count", "circuit" or "fluid_count".

TrainScheduleRecord

Table with the following fields:

station :: string (optional): Name of the station.
rail :: LuaEntity (optional): Rail to path to. Ignored if station is present.
wait_conditions :: array[WaitCondition] (optional)
temporary :: boolean (optional): Only present when the station is temporary, the value is then always true.

TrainSchedule

Table with the following fields:

current :: uint: Index of the currently active record
records :: array[TrainScheduleRecord]

GuiArrowSpecification

Used for specifying where a GUI arrow should point to.

Table with the following fields:

type :: string: This determines which of the following fields will be required. Must be one of "nowhere" (will remove the arrow entirely), "goal" (will point to the current goal), "entity_info", "active_window", "entity", "position", "crafting_queue" or "item_stack" (will point to a given item stack in an inventory). Depending on this value, other fields may have to be specified.
Other attributes may be specified depending on type:
- entity
  - entity :: LuaEntity
- position
  - position :: Position
- crafting_queue
  - crafting_queueindex :: uint: Index in the crafting queue to point to.
- item_stack
  - inventory_index :: defines.inventory: Which inventory the stack is in.
  - item_stack_index :: uint: Which stack to point to.
  - source :: string: Must be either "player", "target", "player-quickbar" or "player-equipment-bar".

AmmoType

Table with the following fields:

action :: array[TriggerItem] (optional)
target_type :: string: One of "entity" (fires at an entity), "position" (fires directly at a position), or "direction" (fires in a direction).
clamp_position :: boolean (optional): When true, the gun will be able to shoot even when the target is out of range. Only applies when target_type is position. The gun will fire at the maximum range in the direction of the target position. Defaults to false.
category :: string: Ammo category of this ammo.
energy_consumption :: double (optional): Energy consumption of a single shot, if applicable. Defaults to 0.

BeamTarget

Table with the following fields:

entity :: LuaEntity (optional): The target entity.
position :: Position (optional): The target position.

RidingState

Table with the following fields:

acceleration :: defines.riding.acceleration
direction :: defines.riding.direction

SpritePath

It is specified by string. It can be either the name of a sprite prototype defined in the data stage or a path in form "type/name".

The supported types are:

"item" - for example "item/iron-plate" is the icon sprite of iron plate
"entity" - for example "entity/small-biter" is the icon sprite of the small biter
"technology"
"recipe"
"item-group"
"fluid"
"tile"
"virtual-signal"
"achievement"
"equipment"
"file" - path to an image file located inside the current scenario. This file is not preloaded so it will be slower; for frequently used sprites, it is better to define sprite prototype and use it instead.
"utility" - sprite defined in the utility-sprites object, these are the pictures used by the game internally for the UI.

SoundPath

A sound defined by a string. It can be either the name of a sound prototype defined in the data stage or a path in the form "type/name". The latter option can be sorted into three categories.

The utility and ambient types each contain general use sound prototypes defined by the game itself.

"utility" - Uses the UtilitySounds prototype. Example: "utility/wire_connect_pole"
"ambient" - Uses AmbientSound prototypes. Example: "ambient/resource-deficiency"

The following types can be combined with any tile name as long as its prototype defines the corresponding sound.

"tile-walking" - Uses Tile::walking_sound. Example: "tile-walking/concrete"
"tile-mined" - Uses Tile::mined_sound
"tile-build-small" - Uses Tile::build_sound. Example: "tile-build-small/concrete"
"tile-build-medium" - Uses Tile::build_sound
"tile-build-large" - Uses Tile::build_sound

The following types can be combined with any entity name as long as its prototype defines the corresponding sound.

"entity-build" - Uses Entity::build_sound. Example: "entity-build/wooden-chest"
"entity-mined" - Uses Entity::mined_sound
"entity-mining" - Uses Entity::mining_sound
"entity-vehicle_impact" - Uses Entity::vehicle_impact_sound
"entity-rotated" - Uses Entity::rotated_sound
"entity-open" - Uses Entity::open_sound
"entity-close" - Uses Entity::close_sound

ModuleEffectValue

Table with the following fields:

bonus :: float: The percentual increase of the attribute. A value of 0.6 means a 60% increase.

ModuleEffects

Table with the following fields:

consumption :: ModuleEffectValue (optional)
speed :: ModuleEffectValue (optional)
productivity :: ModuleEffectValue (optional)
pollution :: ModuleEffectValue (optional)

Example

These are the effects of the vanilla Productivity Module 3 (up to floating point imprecisions):

    {consumption={bonus=0.6},

     speed={bonus=-0.15},

     productivity={bonus=0.06},

     pollution={bonus=0.075}}

EntityPrototypeFlags

This is a set of flags given as a dictionary[string → boolean]. When a flag is set, it is present in the dictionary with the value true. Unset flags aren't present in the dictionary at all. So, the boolean value is meaningless and exists just for easy table lookup if a flag is set.

Possible flags are:

"not-rotatable"
"placeable-neutral"
"placeable-player"
"placeable-enemy"
"placeable-off-grid"
"player-creation"
"building-direction-8-way"
"filter-directions"
"fast-replaceable-no-build-while-moving"
"breaths-air"
"not-repairable"
"not-on-map"
"not-deconstructable"
"not-blueprintable"
"hidden"
"hide-alt-info"
"fast-replaceable-no-cross-type-while-moving"
"no-gap-fill-while-building"
"not-flammable"
"no-automated-item-removal"
"no-automated-item-insertion"
"no-copy-paste"
"not-selectable-in-game"
"not-upgradable"

ItemPrototypeFlags

This is a set of flags given as dictionary[string → boolean]. When a flag is set, it is present in the dictionary with the value true. Unset flags aren't present in the dictionary at all. So, the boolean value is meaningless and exists just for easy table lookup if a flag is set.

Possible flags are:

"draw-logistic-overlay"
"hidden"
"always-show"
"hide-from-bonus-gui"
"hide-from-fuel-tooltip"
"not-stackable"
"can-extend-inventory"
"primary-place-result"
"mod-openable"
"only-in-cursor"

CollisionMaskLayer

A string specifying a collision mask layer.

Possible values for the string are:

"ground-tile"
"water-tile"
"resource-layer"
"doodad-layer"
"floor-layer"
"item-layer"
"ghost-layer"
"object-layer"
"player-layer"
"train-layer"
"rail-layer"
"transport-belt-layer"
"not-setup"

Additionally the values "layer-13" through "layer-55". These layers are currently unused by the game but may change. If a mod is going to use one of the unused layers it's recommended to start at the higher layers because the base game will take from the lower ones.

CollisionMask

This is a set of masks given as a dictionary[CollisionMaskLayer → boolean]. Only set masks are present in the dictionary and they have the value true. Unset flags aren't present at all.

CollisionMaskWithFlags

A CollisionMask but also includes any flags this mask has.

Flags such as:

"not-colliding-with-itself"
"consider-tile-transitions"
"colliding-with-tiles-only"

TriggerTargetMask

This is a set of trigger target masks given as a dictionary[string → boolean].

TriggerEffectItem

Table with the following fields:

type :: string: One of"damage", "create-entity", "create-explosion", "create-fire", "create-smoke", "create-trivial-smoke", "create-particle", "create-sticker", "nested-result", "play-sound", "push-back", "destroy-cliffs", "show-explosion-on-chart", "insert-item", "script".
repeat_count :: uint
affects_target :: boolean
show_in_tooltip :: boolean

TriggerDelivery

Table with the following fields:

type :: string: One of "instant", "projectile", "flame-thrower", "beam", "stream", "artillery".
source_effects :: array[TriggerEffectItem]
target_effects :: array[TriggerEffectItem]

TriggerItem

Table with the following fields:

type :: string: One of "direct", "area", "line", "cluster".
action_delivery :: array[TriggerDelivery] (optional)
entity_flags :: EntityPrototypeFlags (optional): The trigger will only affect entities that contain any of these flags.
ignore_collision_condition :: boolean
collision_mask :: CollisionMask: The trigger will only affect entities that would collide with given collision mask.
trigger_target_mask :: TriggerTargetMask
force :: ForceCondition: If "enemy", the trigger will only affect entities whose force is different from the attacker's and for which there is no cease-fire set. "ally" is the opposite of "enemy".
repeat_count :: uint

CircularParticleCreationSpecification

Table with the following fields:

name :: string: Name of the LuaEntityPrototype
direction :: float
direction_deviation :: float
speed :: float
speed_deviation :: float
starting_frame_speed :: float
starting_frame_speed_deviation :: float
height :: float
height_deviation :: float
vertical_speed :: float
vertical_speed_deviation :: float
center :: Vector: This vector is a table with x and y keys instead of an array.
creation_distance :: double
creation_distance_orientation :: double
use_source_position :: boolean

CircularProjectileCreationSpecification

An array with the following members:

A RealOrientation
A Vector

AttackParameterFluid

Table with the following fields:

type :: string: Name of the LuaFluidPrototype.
damage_modifier :: double: Multiplier applied to the damage of an attack.

AttackParameters

Table with the following fields:

type :: string: The type of AttackParameter. One of 'projectile', 'stream' or 'beam'.
range :: float: Maximum range of attack.
min_range :: float: Minimum range of attack. Used with flamethrower turrets to prevent self-immolation.
range_mode :: string: Defines how the range is determined. Either 'center-to-center' or 'bounding-box-to-bounding-box'.
fire_penalty :: float: When searching for the nearest enemy to attack, fire_penalty is added to the enemy's distance if they are on fire.
rotate_penalty :: float: When searching for an enemy to attack, a higher rotate_penalty will discourage targeting enemies that would take longer to turn to face.
health_penalty :: float: When searching for an enemy to attack, a higher health_penalty will discourage targeting enemies with high health. A negative penalty will do the opposite.
min_attack_distance :: float: If less than range, the entity will choose a random distance between range and min_attack_distance and attack from that distance. Used for spitters.
turn_range :: float: The arc that the entity can attack in as a fraction of a circle. A value of 1 means the full 360 degrees.
damage_modifier :: float: Multiplier applied to the damage of an attack.
ammo_consumption_modifier :: float: Multiplier applied to the ammo consumption of an attack.
cooldown :: float: Minimum amount of ticks between shots. If this is less than 1, multiple shots can be performed per tick.
warmup :: uint: Number of ticks it takes for the weapon to actually shoot after it has been ordered to do so.
movement_slow_down_factor :: double
movement_slow_down_cooldown :: float
ammo_type :: AmmoType (optional)
ammo_categories :: array[string] (optional): List of the names of compatible LuaAmmoCategoryPrototypes.
Other attributes may be specified depending on type:
- projectile
  - projectile_center :: Vector
  - projectile_creation_distance :: float
  - projectile_orientation_offset :: float
  - shell_particle :: CircularParticleCreationSpecification (optional)
  - projectile_creation_parameters :: array[CircularProjectileCreationSpecification] (optional)
- stream
  - gun_barrel_length :: float
  - gun_center_shift :: dictionary[string → Vector]
  - fluid_consumption :: float
  - fluids :: array[AttackParameterFluid] (optional)
  - projectile_creation_parameters :: array[CircularProjectileCreationSpecification] (optional)

CapsuleAction

Table with the following fields:

type :: string: One of "throw", "equipment-remote", "use-on-self".
attack_parameters :: AttackParameters (optional): Only present when type is "throw" or "use-on-self".
equipment :: string (optional): Only present when type is "equipment-remote". It is the equipment prototype name.

SelectionModeFlags

This is a set of flags given as a dictionary[string → boolean]. Set flags are present in the dictionary with the value true; unset flags aren't present at all.

Possible flags are:

"blueprint": Entities that can be selected for blueprint.
"deconstruct": Entities that can be marked for deconstruction.
"cancel-deconstruct": Entities that can be marked for deconstruction cancelling.
"items"
"trees"
"buildable-type": Buildable entities.
"nothing": Only select an area.
"items-to-place": Entities that can be placed using an item.
"any-entity"
"any-tile"
"same-force": Entities with the same force as the selector.
"not-same-force"
"friend"
"enemy"
"upgrade"
"cancel-upgrade"
"entity-with-health"
"entity-with-force"
"entity-with-owner"

LogisticFilter

Table with the following fields:

index :: uint: The index this filter applies to.
name :: string: The item name for this filter.
count :: uint: The count for this filter.

ModSetting

Table with the following fields:

value :: uint or double or boolean or string: The value of the mod setting. The type depends on the setting.

Note: Runtime settings can be changed through console commands and by the mod that owns the settings by writing a new table to the ModSetting.

AnyBasic

Any basic type (string, number, boolean) or table.

Any

Any basic type (string, number, boolean), table, or LuaObject.

ProgrammableSpeakerParameters

Table with the following fields:

playback_volume :: double
playback_globally :: boolean
allow_polyphony :: boolean

ProgrammableSpeakerAlertParameters

Table with the following fields:

show_alert :: boolean
show_on_map :: boolean
icon_signal_id :: SignalID
alert_message :: string

ProgrammableSpeakerCircuitParameters

Table with the following fields:

signal_value_is_pitch :: boolean
instrument_id :: uint
note_id :: uint

ProgrammableSpeakerInstrument

Table with the following fields:

name :: string
notes :: array[string]

Alignment

A string that specifies where a gui element should be.

Possible values are:

"top-left"
"middle-left"
"left": The same as "middle-left"
"bottom-left"
"top-center"
"middle-center"
"center": The same as "middle-center"
"bottom-center"
"top-right"
"right": The same as "middle-right"
"bottom-right"

EventData

Information about the event that has been raised. The table can also contain other fields depending on the type of event. See the list of Factorio events for more information on these.

Table with the following fields:

name :: defines.events: The identifier of the event this handler was registered to.
tick :: uint: The tick during which the event happened.
mod_name :: string (optional): The name of the mod that raised the event if it was raised using LuaBootstrap::raise_event.

NthTickEventData

Table with the following fields:

tick :: uint: The tick during which the event happened.
nth_tick :: uint: The nth tick this handler was registered to.

ModChangeData

Table with the following fields:

old_version :: string: Old version of the mod. May be nil if the mod wasn't previously present (i.e. it was just added).
new_version :: string: New version of the mod. May be nil if the mod is no longer present (i.e. it was just removed).

ConfigurationChangedData

Table with the following fields:

old_version :: string (optional): Old version of the map. Present only when loading map version other than the current version.
new_version :: string (optional): New version of the map. Present only when loading map version other than the current version.
mod_changes :: dictionary[string → ModChangeData]: Dictionary of mod changes. It is indexed by mod name.
mod_startup_settings_changed :: boolean: true when mod startup settings have changed since the last time this save was loaded.
migration_applied :: boolean: true when mod prototype migrations have been applied since the last time this save was loaded.

CustomCommandData

Table with the following fields:

name :: string: The name of the command.
tick :: uint: The tick the command was used in.
player_index :: uint (optional): The player who issued the command, or nil if it was issued from the server console.
parameter :: string (optional): The parameter passed after the command, if there is one.

SelectedPrototypeData

Table with the following fields:

base_type :: string: E.g. "entity".
derived_type :: string: E.g. "tree".
name :: string: E.g. "tree-05".

ScriptRenderTarget

Table with the following fields:

entity :: LuaEntity (optional)
entity_offset :: Vector (optional)
position :: Position (optional)

MouseButtonFlags

This is a set of flags given as a dictionary[string → boolean]. When a flag is set, it is present in the dictionary with the value true. Unset flags aren't present in the dictionary at all.

To write to this, use an array[string] of the mouse buttons that should be possible to use with on button.

When setting flags, the flag "left-and-right" can also be set which will set "left" and "right" true.

Possible flags when reading are:

"left"
"right"
"middle"
"button-4"
"button-5"
"button-6"
"button-7"
"button-8"
"button-9"

CursorBoxRenderType

It is specified by string.

"entity": Yellow box.
"not-allowed": Red box.
"electricity": Light blue box.
"pair": Light blue box.
"copy": Green box.
"train-visualization": White box.
"logistics": Light blue box.
"blueprint-snap-rectangle": Green box.

ForceCondition

It is specified by string.

"all": All forces pass.
"enemy": Forces which will attack pass.
"ally": Forces which won't attack pass.
"friend": Forces which are friends pass.
"not-friend": Forces which are not friends pass.
"same": The same force pass.
"not-same": The non-same forces pass.

RenderLayer

A value between 0 and 255 inclusive represented by one of the following named string or string version of the value (for example "27" and "decals" are both valid). Higher values are rendered on top of lower values.

"water-tile": 15
"ground-tile": 25
"tile-transition": 26
"decals": 27
"lower-radius-visualization": 29
"radius-visualization": 30
"transport-belt-integration": 65
"resource":66
"building-smoke":67
"decorative": 92
"ground-patch": 93
"ground-patch-higher": 94
"ground-patch-higher2": 95
"remnants": 112
"floor": 113
"transport-belt": 114
"transport-belt-endings": 115
"floor-mechanics-under-corpse": 120
"corpse": 121
"floor-mechanics": 122
"item": 123
"lower-object": 124
"transport-belt-circuit-connector": 126
"lower-object-above-shadow": 127
"object": 129
"higher-object-under": 131
"higher-object-above": 132
"item-in-inserter-hand": 134
"wires": 135
"wires-above": 136
"entity-info-icon": 138
"entity-info-icon-above": 139
"explosion": 142
"projectile": 143
"smoke": 144
"air-object": 145
"air-entity-info-icon": 147
"light-effect": 148
"selection-box": 187
"higher-selection-box": 188
"collision-selection-box": 189
"arrow": 190
"cursor": 210

CliffOrientation

"west-to-east"
"north-to-south"
"east-to-west"
"south-to-north"
"west-to-north"
"north-to-east"
"east-to-south"
"south-to-west"
"west-to-south"
"north-to-west"
"east-to-north"
"south-to-east"
"west-to-none"
"none-to-east"
"east-to-none"
"none-to-west"
"north-to-none"
"none-to-south"
"south-to-none"
"none-to-north"

ItemStackLocation

Table with the following fields:

inventory :: defines.inventory
slot :: uint

VehicleAutomaticTargetingParameters

Table with the following fields:

auto_target_without_gunner :: boolean
auto_target_with_gunner :: boolean

SoundType

"game-effect"
"gui-effect"
"ambient"
"environment"
"walking"
"alert"
"wind"

ItemPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"tool"
"mergeable"
"item-with-inventory"
"selection-tool"
"item-with-label"
"has-rocket-launch-products"
"fuel"
"place-result": Additional fields:
- elem_filters :: array[EntityPrototypeFilter] (optional): Filters for the place result.
"burnt-result": Additional fields:
- elem_filters :: array[ItemPrototypeFilter] (optional): Filters for the burnt result.
"place-as-tile": Additional fields:
- elem_filters :: array[TilePrototypeFilter] (optional): Filters for the placed tile.
"placed-as-equipment-result": Additional fields:
- elem_filters :: array[EquipmentPrototypeFilter] (optional): Filters for the placed equipment.
"name": Additional fields:
- name :: string or array[string]: The prototype name, or list of acceptable names.
For use within nested filters such as the has-product-item filter of array[RecipePrototypeFilter]. To get a specific prototype by name, see LuaGameScript::item_prototypes.
"type": Additional fields:
- type :: string: The prototype type
Usage example:
game.get_filtered_item_prototypes({{filter = "type", type = "armor"}})
"flag": Additional fields:
- flag :: string: One of the values in ItemPrototypeFlags.
"subgroup": Additional fields:
- subgroup :: string: A LuaGroup (subgroup) name
"fuel-category": Additional fields:
- fuel-category :: string: A LuaFuelCategoryPrototype name
"stack-size": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.
Usage example:
game.get_filtered_item_prototypes({{filter = "stack-size", comparison = ">", value = 20}, {filter = "stack-size", comparison = "<", value = 100, mode = "and"}})
"default-request-amount": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.
"wire-count": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.
"fuel-value": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"fuel-acceleration-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"fuel-top-speed-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"fuel-emissions-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.

ModSettingPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"type": Additional fields:
- type :: string: The prototype type
"mod": Additional fields:
- mod :: string: The mod name
"setting-type": Additional fields:
- type :: string: The setting scope type (startup, runtime-global, or runtime-per-user)

TechnologyPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"enabled"
"hidden"
"upgrade"
"visible-when-disabled"
"has-effects"
"has-prerequisites"
"research-unit-ingredient": Additional fields:
- ingredient :: string: The research ingredient to check.
"level": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.
"max-level": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.
"time": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.

DecorativePrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"decal"
"autoplace"
"collision-mask": Additional fields:
- mask :: CollisionMask or CollisionMaskWithFlags
- mask_mode :: string: How to filter: "collides" or "layers-equals"

AchievementPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"allowed-without-fight"
"type": Additional fields:
- type :: string: The prototype type

FluidPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"hidden"
"name": Additional fields:
- name :: string or array[string]: The prototype name, or list of acceptable names.
For use within nested filters such as the has-product-fluid filter of array[RecipePrototypeFilter]. To get a specific prototype by name, see LuaGameScript::fluid_prototypes.
"subgroup": Additional fields:
- subgroup :: string: A LuaGroup (subgroup) name
"default-temperature": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"max-temperature": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"heat-capacity": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"fuel-value": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"emissions-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"gas-temperature": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.

EquipmentPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"item-to-place"
"type": Additional fields:
- type :: string: The prototype type

TilePrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"minable"
"autoplace"
"blueprintable"
"item-to-place"
"collision-mask": Additional fields:
- mask :: CollisionMask or CollisionMaskWithFlags
- mask_mode :: string: How to filter: "collides" or "layers-equals"
"walking-speed-modifier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"vehicle-friction-modifier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"decorative-removal-probability": Additional fields:
- comparison :: ComparatorString
- value :: float: The value to compare against.
"emissions": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.

RecipePrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"enabled"
"hidden"
"hidden-from-flow-stats"
"hidden-from-player-crafting"
"allow-as-intermediate"
"allow-intermediates"
"allow-decomposition"
"always-show-made-in"
"always-show-products"
"show-amount-in-title"
"has-ingredients"
"has-products"
"has-ingredient-item": Additional fields:
- elem_filters :: array[ItemPrototypeFilter] (optional): Matches if at least 1 ingredient is an item that matches these filters.
"has-ingredient-fluid": Additional fields:
- elem_filters :: array[FluidPrototypeFilter] (optional): Matches if at least 1 ingredient is a fluid that matches these filters.
Usage example:
-- selects recipes that consume sulfuric acid {{filter = "has-ingredient-fluid", elem_filters = {{filter = "name", name = "sulfuric-acid"}}}}
"has-product-item": Additional fields:
- elem_filters :: array[ItemPrototypeFilter] (optional): Matches if at least 1 product is an item that matches these filters.
Usage example:
-- selects recipes that produce an item {{filter = "has-product-item"}} -- selects recipes that produce iron plates {{filter = "has-product-item", elem_filters = {{filter = "name", name = "iron-plate"}}}} -- selects recipes that produce items that place furnaces {{filter = "has-product-item", elem_filters = {{filter = "place-result", elem_filters = {{filter = "type", type = "furnace"}}}}}}
"has-product-fluid": Additional fields:
- elem_filters :: array[FluidPrototypeFilter] (optional): Matches if at least 1 product is a fluid that matches these filters.
"subgroup": Additional fields:
- subgroup :: string: A LuaGroup (subgroup) name
"category": Additional fields:
- category :: string: A LuaRecipeCategoryPrototype name
"energy": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"emissions-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"request-paste-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.
"overload-multiplier": Additional fields:
- comparison :: ComparatorString
- value :: uint: The value to compare against.

EntityPrototypeFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"flying-robot"
"robot-with-logistics-interface"
"rail"
"ghost"
"explosion"
"vehicle"
"crafting-machine"
"rolling-stock"
"turret"
"transport-belt-connectable"
"wall-connectable"
"buildable"
"placable-in-editor"
"clonable"
"selectable"
"hidden"
"entity-with-health"
"building"
"fast-replaceable"
"uses-direction"
"minable"
"circuit-connectable"
"autoplace"
"blueprintable"
"item-to-place"
"name": Additional fields:
- name :: string or array[string]: The prototype name, or list of acceptable names.
For use within nested filters such as the place-result filter of array[ItemPrototypeFilter]. To get a specific prototype by name, see LuaGameScript::entity_prototypes.
"type": Additional fields:
- type :: string: The prototype type
Usage example:
game.get_filtered_entity_prototypes({{filter = "type", type = "unit"}})
"collision-mask": Additional fields:
- mask :: CollisionMask or CollisionMaskWithFlags
- mask_mode :: string: How to filter: "collides" or "layers-equals"
Usage example:
game.get_filtered_entity_prototypes({{filter = "collision-mask", mask = "player-layer", mask_mode = "collides"}})
"flag": Additional fields:
- flag :: string: One of the values in EntityPrototypeFlags.
Usage example:
game.get_filtered_entity_prototypes({{filter = "flag", flag = "placeable-player"}, {filter = "flag", flag = "placeable-enemy", mode = "and"}})
"build-base-evolution-requirement": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"selection-priority": Additional fields:
- comparison :: ComparatorString
- value :: uint8: The value to compare against.
"emissions": Additional fields:
- comparison :: ComparatorString
- value :: double: The value to compare against.
"crafting-category": Additional fields:
- crafting_category :: string: Matches if the prototype is for a crafting machine with this crafting category.

EventFilter

Used to filter out irrelevant event callbacks in a performant way.

Available filters:

Note: Filters are always used as an array of filters of a specific type. Every filter can only be used with its corresponding event, and different types of event filters can not be mixed.

LuaScriptRaisedReviveEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaEntityDiedEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaEntityMarkedForDeconstructionEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaPreGhostDeconstructedEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaScriptRaisedDestroyEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaUpgradeCancelledEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaPlayerRepairedEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaEntityMarkedForUpgradeEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaPostEntityDiedEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"type": Additional fields:
- type :: string: The prototype type

LuaPreRobotMinedEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaEntityClonedEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaScriptRaisedBuiltEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaRobotMinedEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaPrePlayerMinedEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaRobotBuiltEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name
"force": Additional fields:
- force :: string: The entity force

LuaEntityDeconstructionCancelledEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaPlayerBuiltEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name
"force": Additional fields:
- force :: string: The entity force

LuaPlayerMinedEntityEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

LuaEntityDamagedEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name
"original-damage-amount": Additional fields:
- comparison :: ComparatorString
- value :: float: The value to compare against.
"final-damage-amount": Additional fields:
- comparison :: ComparatorString
- value :: float: The value to compare against.
"damage-type": Additional fields:
- type :: string: A LuaDamagePrototype name
"final-health": Additional fields:
- comparison :: ComparatorString
- value :: float: The value to compare against.

LuaSectorScannedEventFilter

Table with the following fields:

filter :: string: The condition to filter on.
mode :: string (optional): How to combine this with the previous filter. Must be "or" or "and". Defaults to "or". When evaluating the filters, "and" has higher precedence than "or".
invert :: boolean (optional): Inverts the condition. Default is false.

Depending on the value of filter, the table may take additional fields. filter may be one of the following:

"ghost"
"rail"
"rail-signal"
"rolling-stock"
"robot-with-logistics-interface"
"vehicle"
"turret"
"crafting-machine"
"wall-connectable"
"transport-belt-connectable"
"circuit-network-connectable"
"type": Additional fields:
- type :: string: The prototype type
"name": Additional fields:
- name :: string: The prototype name
"ghost_type": Additional fields:
- type :: string: The ghost prototype type
"ghost_name": Additional fields:
- name :: string: The ghost prototype name

show_controller_gui :: boolean [RW]	Show the controller GUI elements.
show_minimap :: boolean [RW]	Show the chart in the upper right-hand corner of the screen.
show_research_info :: boolean [RW]	Show research progress and name in the upper right-hand corner of the screen.
show_entity_info :: boolean [RW]	Show overlay icons on entities.
show_alert_gui :: boolean [RW]	Show the flashing alert icons next to the player's toolbar.
update_entity_selection :: boolean [RW]	When `true` (the default), mousing over an entity will select it.
show_rail_block_visualisation :: boolean [RW]	When `true` (`false` is default), the rails will always show the rail block visualisation.
show_side_menu :: boolean [RW]	Shows or hides the buttons row.
show_map_view_options :: boolean [RW]	Shows or hides the view options when map is opened.
show_quickbar :: boolean [RW]	Shows or hides quickbar of shortcuts.
show_shortcut_bar :: boolean [RW]	Shows or hides the shortcut bar.

Concepts

LocalisedString

DisplayResolution

PersonalLogisticParameters

RealOrientation

Position

ChunkPosition

TilePosition

GuiLocation

ChunkPositionAndArea

EquipmentPoint

GuiAnchor

TabAndContent

OldTileAndPosition

Tags

SmokeSource

Vector

BoundingBox

ScriptArea

ScriptPosition

Color

ColorModifier

CraftingQueueItem

Alert

ScriptRenderVertexTarget

PathfinderWaypoint

CutsceneWaypoint

Decorative

DecorativeResult

ChartTagSpec

GameViewSettings

MapViewSettings

MapSettings

DifficultySettings

MapExchangeStringData

BlueprintItemIcon

BlueprintSignalIcon

BlueprintEntity

Tile

Fluid

Ingredient

Product

Loot

TechnologyModifier

Offer

AutoplaceSpecification

NoiseExpression

AutoplaceSpecificationPeak

AutoplaceSpecificationRestriction

Resistance

MapGenSize

AutoplaceSetting

AutoplaceSettings

AutoplaceControl

CliffPlacementSettings

MapGenSettings

SignalID

Signal

UpgradeFilter

InfinityInventoryFilter

InfinityPipeFilter

FluidBoxFilter

FluidBoxFilterSpec

HeatSetting

HeatConnection

FluidBoxConnection

ArithmeticCombinatorParameters

ConstantCombinatorParameters

ComparatorString

DeciderCombinatorParameters

InserterCircuitConditions

CircuitCondition

CircuitConditionDefinition

CircuitConnectionDefinition

WireConnectionDefinition

InventoryFilter

PlaceAsTileResult

Command

PathfinderFlags

UnitSpawnDefinition