LuaTransportLine
One line on a transport belt.
LuaTransportLine
Get the number of items on this transport line.
The indexing operator.
Remove all items from this transport line.
Count some or all items on this line.
Remove some items from this line.
Can an item be inserted at a given position?
Can an item be inserted at the back of this line?
Insert items at the back of this line.
Get counts of all items on this line.
Returns whether the associated internal transport line of this line is the same as the others associated internal transport line.
The transport lines that this transport line outputs items to or an empty table if none.
The transport lines that this transport line is fed by or an empty table if none.
The class name of this object.
get_item_count
(item)
→ uint
Count some or all items on this line.
Prototype name of the item to count. If not specified, count all items.
remove_item
(items)
→ uint
Remove some items from this line.
Items to remove.
Number of items actually removed.
can_insert_at
(position)
→ boolean
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.
Where on the line to insert the items.
Items to insert.
Were the items inserted successfully?
insert_at_back
(items)
→ boolean
Insert items at the back of this line.
Were the items inserted successfully?
get_contents
()
→ dictionary[string → uint]
Get counts of all items on this line.
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.
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.
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.