Factorio Lua API

https://lua-api.factorio.com/latest
Admin
This site contains reference documentation for creating Factorio mods, covering settings, prototype,...
Tokens:1,996,915
Snippets:27,674
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### EquipmentGridID Examples

Source: https://lua-api.factorio.com/latest/prototype-api.json

Examples of EquipmentGridID strings.

```lua
"small-equipment-grid"
```

```lua
"spidertron-equipment-grid"
```

--------------------------------

### BoundingBox Definition Examples

Source: https://lua-api.factorio.com/latest/runtime-api.json

Shows the explicit and shorthand syntax for defining a BoundingBox.

```lua
-- Explicit definition
{left_top = {x = -2, y = -3}, right_bottom = {x = 5, y = 8}}
```

```lua
-- Shorthand
{{-2, -3}, {5, 8}}
```

--------------------------------

### Filter entities by flag

Source: https://lua-api.factorio.com/latest/runtime-api.json

Example of using the flag filter with an 'and' mode to find entities that are both placeable-player and placeable-enemy.

```lua
prototypes.get_entity_filtered({{filter = "flag", flag = "placeable-player"}, {filter = "flag", flag = "placeable-enemy", mode = "and"}})
```

--------------------------------

### Filter entities by type

Source: https://lua-api.factorio.com/latest/runtime-api.json

Example of using the type filter to retrieve entities of the 'unit' type.

```lua
prototypes.get_entity_filtered({{filter = "type", type = "unit"}})
```

--------------------------------

### distance_from_nearest_point usage

Source: https://lua-api.factorio.com/latest/auxiliary/noise-expressions.html

Examples of calculating the distance from the nearest point for starting positions and starting lake positions.

```lua
distance_from_nearest_point{x = x, y = y, points = starting_positions}
```

```lua
distance_from_nearest_point{x = x, y = y, points = starting_lake_positions}
```

--------------------------------

### apply_starter_pack(silent?)

Source: https://lua-api.factorio.com/latest/classes/LuaSpacePlatform.html

Applies the starter pack for this platform if it hasn't already been applied.

```APIDOC
## apply_starter_pack(silent?)

### Description
Applies the starter pack for this platform if it hasn't already been applied.

### Returns
- **LuaEntity** (optional) - The entity created by the starter pack.
```

--------------------------------

### apply_starter_pack(silent?)

Source: https://lua-api.factorio.com/latest/classes/LuaSpacePlatform.html

Applies the starter pack for this platform if it hasn't already been applied.

```APIDOC
## apply_starter_pack(silent?)

### Description
Applies the starter pack for this platform if it hasn't already been applied.

### Parameters
- **silent** (boolean?) - Optional - If the platform creation is announced to players on the force. Defaults to false.

### Return values
- **LuaEntity?** - The platform hub.
```

--------------------------------

### Constant folding examples

Source: https://lua-api.factorio.com/latest/auxiliary/noise-expressions.html

Examples demonstrating how the compiler folds constant expressions when they appear at the start of an operation sequence.

```text
x + 1 + 2 -> (x + 1) + 2 (no folding)
1 + 2 + x -> (1 + 2) + x -> 3 + x (1 + 2 was folded into 3)
x ^ 2 ^ 3 -> x ^ (2 ^ 3) -> x ^ 8 (2 ^ 3 was folded into 8)
2 ^ 3 ^ x -> 2 ^ (3 ^ x) (no folding)
2 * map_width * map_height * x -> <constant> * x (folded at compile time because map_width and map_height are known constants)
2 + clamp(map_seed, -50, 50) - x -> <constant> - x (folded at compile time because map_seed is a known constant)
```

--------------------------------

### get_starting_area_radius()

Source: https://lua-api.factorio.com/latest/classes/LuaSurface.html

Gets the starting area radius of this surface.

```APIDOC
## get_starting_area_radius() -> double

### Description
Gets the starting area radius of this surface.
```

--------------------------------

### LuaSpacePlatform.apply_starter_pack

Source: https://lua-api.factorio.com/latest/runtime-api.json

Applies the starter pack for this platform if it hasn't already been applied.

```APIDOC
## LuaSpacePlatform.apply_starter_pack

### Description
Applies the starter pack for this platform if it hasn't already been applied.

### Parameters
- **silent** (boolean) - Optional - If the platform creation is announced to players on the force.
```

--------------------------------

### get_rail_segment_stop

Source: https://lua-api.factorio.com/latest/classes/LuaEntity.html

Gets the train stop at the start or end of the current rail segment.

```APIDOC
## get_rail_segment_stop(direction)

### Description
Get train stop at the start/end of the rail segment this rail is in. Can only be used if this is a Rail.

### Parameters
- **direction** (defines.rail_direction) - The direction of travel relative to this rail.

### Return values
- **LuaEntity?** - nil if the rail segment doesn't start/end with a train stop.
```

--------------------------------

### TileTransitionSpritesheetLayout configuration example

Source: https://lua-api.factorio.com/latest/types/TileTransitionSpritesheetLayout.html

Example showing how to define a layout for tile transitions, specifying scale, corner counts, and layer offsets.

```lua
-- all the layers use the same layout, at different offsets inside the spritesheet
layout =
{
  scale = 0.5,
  inner_corner_count = 8,
  outer_corner_count = 8,
  o_transition_count = 1,
  outer_corner_x = 576,
  u_transition_x = 1728,

  overlay = { y_offset = 0 },  -- 0 is default, but by defining overlay property, we enable the layer
  mask = { y_offset = 512 },
  background = { y_offset = 1024 }
}
```

--------------------------------

### get_rail_segment_signal

Source: https://lua-api.factorio.com/latest/classes/LuaEntity.html

Gets the rail signal at the start or end of the current rail segment.

```APIDOC
## get_rail_segment_signal(direction, in_else_out)

### Description
Get the rail signal at the start/end of the rail segment this rail is in. Can only be used if this is a Rail.

### Parameters
- **direction** (defines.rail_direction) - The direction of travel relative to this rail.
- **in_else_out** (boolean) - If true, gets the signal at the entrance of the rail segment, otherwise gets the signal at the exit of the rail segment.

### Return values
- **LuaEntity?** - nil if the rail segment doesn't start/end with a signal.
```

--------------------------------

### MinableProperties configuration examples

Source: https://lua-api.factorio.com/latest/prototype-api.json

Examples showing how to define minable properties for objects, including simple results and complex fluid results.

```lua
minable = { mining_time = 0.55, result = "wood", count = 4, mining_particle = "wooden-particle" }
```

```lua
minable =
{
  mining_time = 1,
  results =
  {
    {
      type = "fluid",
      name = "crude-oil",
      amount = 10
    }
  }
}
```

--------------------------------

### PodMovementProcessionLayer configuration example

Source: https://lua-api.factorio.com/latest/types/PodMovementProcessionLayer.html

A configuration example showing how to define a pod-movement type with multiple keyframes for tilt, offset, and opacity transitions.

```lua
{
  type = "pod-movement",
  frames =
  {
    { timestamp = 700 , tilt = 0.0               , tilt_t = 0 },
    { timestamp = 700 , offset = {0, 0 - 500}    , offset_t = {0, -40} },
    { timestamp = 900 , offset = {15, -60 - 500} , offset_t = {-10, -10} },
    { timestamp = 900 , opacity = 1.0 },
    { timestamp = 960 , tilt = 0.05              , tilt_t = -0.03 },
    { timestamp = 1050, tilt = 0.25              , tilt_t = 0 },
    { timestamp = 1050, offset = {40, -70 - 500} , offset_t = {-1, 0} },
    { timestamp = 1050, opacity = 0.0 },
    { timestamp = 700 , offset_rate = 0 },
    { timestamp = 1050, offset_rate = 1.0 }
  }
}
```

--------------------------------

### Get technology prototypes with get_technology_filtered

Source: https://lua-api.factorio.com/latest/classes/LuaPrototypes.html

Retrieves technology prototypes that can be researched at the start of the game.

```lua
-- Get every technology prototype that can be researched at the start of the game.
local prototypes = prototypes.get_technology_filtered{{filter="has-prerequisites", invert=true}}
```

--------------------------------

### EquipmentID Examples

Source: https://lua-api.factorio.com/latest/prototype-api.json

Examples of EquipmentID strings.

```lua
"fusion-reactor-equipment"
```

```lua
"exoskeleton-equipment"
```

--------------------------------

### Allow all module types

Source: https://lua-api.factorio.com/latest/types/EffectTypeLimitation.html

Example showing how to enable all available module effects for a machine.

```lua
-- Allow all module types
allowed_effects = {"speed", "productivity", "consumption", "pollution", "quality"}
```

--------------------------------

### EquipmentCategoryID example

Source: https://lua-api.factorio.com/latest/types/EquipmentCategoryID.html

A simple example showing the string format of an EquipmentCategoryID.

```lua
"armor"
```

--------------------------------

### Lamp Prototype Configuration

Source: https://lua-api.factorio.com/latest/prototype-api.json

Example configuration for a lamp entity, defining visual properties, signal-to-color mappings, and circuit connector settings.

```lua
     shift = util.by_pixel(4, 4.75),
        draw_as_shadow = true,
        scale = 0.5
      }
    }
  },
  picture_on =
  {
    filename = "__base__/graphics/entity/small-lamp/lamp-light.png",
    priority = "high",
    width = 90,
    height = 78,
    shift = util.by_pixel(0, -7),
    scale = 0.5
  },
  signal_to_color_mapping =
  {
    {type = "virtual", name = "signal-red",    color = {1, 0, 0}},
    {type = "virtual", name = "signal-green",  color = {0, 1, 0}},
    {type = "virtual", name = "signal-blue",   color = {0, 0, 1}},
    {type = "virtual", name = "signal-yellow", color = {1, 1, 0}},
    {type = "virtual", name = "signal-pink",   color = {1, 0, 1}},
    {type = "virtual", name = "signal-cyan",   color = {0, 1, 1}},
    {type = "virtual", name = "signal-white",  color = {1, 1, 1}},
    {type = "virtual", name = "signal-grey",   color = {0.5, 0.5, 0.5}},
    {type = "virtual", name = "signal-black",  color = {0, 0, 0}}
  },
  default_red_signal = { type = "virtual", name = "signal-red" },
  default_green_signal = { type = "virtual", name = "signal-green" },
  default_blue_signal = { type = "virtual", name = "signal-blue" },
  default_rgb_signal = { type = "virtual", name = "signal-white" },

  circuit_connector = circuit_connector_definitions["lamp"],
  circuit_wire_max_distance = default_circuit_wire_max_distance
}
```
Tokens:
Raw