Factorio API Docs

1.1.49 <>
|<

Classes

Events

Concepts

Defines

Builtin types

>|

Class LuaTransportLine

One line on a transport belt.

operator length
:: uint
[R]

Get the number of items on this transport line.


operator index
[R]

The indexing operator.


clear()

Remove all items from this transport line.


uint

Count some or all items on this line.


remove_item(items)
uint

Remove some items from this line.


can_insert_at(position)
boolean

Can an item be inserted at a given position?


boolean

Can an item be inserted at the back of this line?


insert_at(position, items)
boolean

Insert items at a given position.


boolean

Insert items at the back of this line.


→ dictionary[stringuint]

Get counts of all items on this line.


line_equals(other)
boolean

Returns whether the associated internal transport line of this line is the same as the others associated internal transport line.


help()
string

All methods and properties that this object supports.


[R]

The entity this transport line belongs to.


:: array[LuaTransportLine]
[R]

The transport lines that this transport line outputs items to or an empty table if none.


:: array[LuaTransportLine]
[R]

The transport lines that this transport line is fed by or an empty table if none.


:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Operators

length()

Get the number of items on this transport line.


index()

The indexing operator.

Methods

clear()

Remove all items from this transport line.


get_item_count(item) → uint

Count some or all items on this line.

Parameters

item
:: string
Optional

Prototype name of the item to count. If not specified, count all items.


remove_item(items) → uint

Remove some items from this line.

Parameters

items

Items to remove.

Return value

Number of items actually removed.


can_insert_at(position) → boolean

Can an item be inserted at a given position?

Parameters

position
:: float

Where to insert an item.


can_insert_at_back() → boolean

Can an item be inserted at the back of this line?


insert_at(position, items) → boolean

Insert items at a given position.

Parameters

position
:: float

Where on the line to insert the items.


items

Items to insert.

Return value

Were the items inserted successfully?


insert_at_back(items) → boolean

Insert items at the back of this line.

Parameters

Return value

Were the items inserted successfully?


get_contents() → dictionary[stringuint]

Get counts of all items on this line.

Return value

The counts, indexed by item names.


line_equals(other) → boolean

Returns whether the associated internal transport line of this line is the same as the others associated internal transport line.

Parameters

other

Note

This can return true even when the LuaTransportLine::owners are different (so this == other is false), because the internal transport lines can span multiple tiles.


help() → string

All methods and properties that this object supports.

Attributes

owner :: LuaEntity [Read]

The entity this transport line belongs to.


output_lines :: array[LuaTransportLine] [Read]

The transport lines that this transport line outputs items to or an empty table if none.


input_lines :: array[LuaTransportLine] [Read]

The transport lines that this transport line is fed by or an empty table if none.


valid :: boolean [Read]

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.


object_name :: string [Read]

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.