Official Factorio Wiki - User contributions [en]

User:Bitbyte/Tutorial:Combinator tutorial

2023-12-28T01:25:02Z

Bitbyte: wip

''This is an '''advanced''' tutorial. Beginners should refer to the [[Tutorial:Circuit network cookbook]] for examples and the [[Circuit network]] page for an overview over the circuit network. This tutorial assumes a basic understanding of circuits and covers more advanced topics like SR latches, memory cells and clocks.''

{{Languages}}
== Introduction ==
Combinator logic is achieved by cross-connecting outputs to inputs in such a way to achieve the desired logic. While advanced logic requires a multitude of combinators, some very useful basic logic can be achieved using only a handful of combinators. Combinator logic works because Factorio only updates at '''60 times per second''', such that combinators analyze their logic in a step, and then sum and/or decide the resulting output values on the next step.

When logic values are computed by combinators, the outputs are not recognized by the circuit network until the following step. So when a [[decider combinator]] is used to detect a certain input condition, it's output value will not take effect on the circuit network until the next step. '''This behavior is important to remember and can result in sequencing errors and significant delays when multiple combinators are connected in series.'''

Circuit wires act like a wire bus in electronics; it carries information in the connected wires, meaning that if there are similar signals on a wire it will add them automatically. If the signal is different, it will be carried in that wire as well, but as a different signal.

When cross-connecting combinators, it is good practice to use the unused color to cross-connect, this will split the input and output networks and prevent unwanted inputs from accidentally connecting to a larger circuit network. Combinators will sum the red and green inputs prior to calculation, so either color can be used when wiring the output back to the input. In in most cases however, it is more useful to use the opposing color of the wire so that it will not interfere with the resulting output and input.

== Virtual signals ==

[[File:Virtual Signals dialog box.png|thumb|right|Virtual Signals available for use in the circuit network]]

In addition to the standard item signals, Factorio's circuit network also includes a set of signals that do not represent any particular game item. Instead, these virtual signals serve as user-definable channels for the circuit network; they hold whatever meaning the user wants them to. There are currently 48 virtual signals that can be sent over the circuit network:

* The 36 alphanumeric characters (A-Z, 0-9)
* Nine colors: red, green, blue, yellow, magenta, cyan, white, grey, and black
* Three icons: a check mark, an informational letter 'i', and a small, white dot

=== Logic signals ===

There are three additional virtual signals known as ''logic signals''. Unlike other signals, they cannot be sent over the circuit network; instead, they apply additional logic to combinators that modify their behavior. Specifically, these logic symbols act as wildcards, which are special signals that represent '''zero or more''' arbitrary signals instead of representing a single discrete signal. Factorio's circuit network implements three types of wildcards.

==== Everything wildcard [[File:Signal_everything.png|left|20px]] ====

The ''Everything'' wildcard is used with decider combinators. Its exact behavior depends on whether it is used as an input or an output:
* '''Input''': Returns true if ''all'' input signals pass the condition, or if there are ''no'' input signals, otherwise it returns false.
* '''Output''': Returns ''all'' non-zero input signals.

When used as an input, the ''everything'' wildcard can be thought of as a logical AND, or a [[:Wikipedia:universal quantification|universal quantifier]]. When used as an output, it acts as an 'echo' or 'dump' of input signals.

'''Note''': Can be used as an output as long as the input is not an ''each'' wildcard.

==== Anything wildcard [[File:Signal_anything.png|left|20px]] ====

The ''Anything'' wildcard is also used with decider combinators.

Given '''at least one''' input signal, it returns true if ''any'' input signal passes the condition. If no signal passes the condition, or there are no input signals, then it returns false. From this behavior, the ''anything'' wildcard can be thought of as a logical OR, or an [[:Wikipedia:existential quantification|existential quantifier]].

When used in both the input and output of a decider combinator, ''anything'' will return one of the signals that matched.

==== Each wildcard [[File:Signal_each.png|left|20px]] ====

The ''Each'' wildcard is used with both decider combinators and [[arithmetic combinator]]s, and behaves somewhat uniquely compared to the previous two. Generally speaking, it performs a combinator action on each signal '''individually''', with the exact action depending on how it is used, and the type of combinator it is used in. It can be used as an input, and it can be used as an output, but ''only when it is used as input as well''.

In a '''decider combinator''', when used as an input, the ''each'' wildcard individually compares each input signal against the combinator condition, returning each signal that passes the condition. The manner that the ''each'' wildcard returns signals when used as input depends on whether or not it is also used as output:
* '''Input only''': Sums each input signal that passed the condition, and depending on output settings returns either a count of the passed signals or a summation of their values as the desired output signal.
* '''Input and Output''': Returns each signal that passed the condition, their values depending on the output settings.

In an '''arithmetic combinator''', the designated arithmetic operation is applied individually to each input signal, and similar to the decider combinator, the signal that is returned depends on whether or not the ''each'' wildcard is used as output:
* '''Input only''': The result of each operation on the input signals is summed and returned as the desired output signal.
* '''Input and Output''': Each input signal is returned with the result of the specified operation applied to it.

The ''Each'' wildcard is therefore notably more complex than the other two wildcards, but offers a good deal of power in exchange for its complexity.

== Input insulator & gate ==
An arithmetic combinator set to (In: Each + 0, Out: Each) can be used to swap wire colors and as an insulator to prevent downstream logic from backfeeding into the circuit network's inputs.

A decider combinator set to (Out: Everything, Input-> Output) will also function as an insulator as long as the set logic condition is true. This can also selectively pass or 'gate' inputs only when desired. This could be used to sequentially poll remote train stations for their chest contents, and include only desired stations.

== Set/Reset latching switch ==
You want something to SET a trigger at some quantity, but then STAY on until that quantity hits some other value, the RESET value. You'll need one decider combinator and one arithmetic combinator. (Two decider combinators and a [[constant combinator]] can also be used for more complex multi-channel conditions.)

Setup the first decider combinator to the desired set conditional and to output a 1. Then connect the output to the input of an arithmetic combinator, and configure it to multiply by the bias value, which is the difference between the set and reset values, and wire the arithmetic output to the input of the decider. The arithmetic output channel must be set the same as the decider's input channel. 
Whenever the set conditional is reached, the decider will output a '1', and the bias of the arithmetic combinator will be applied. This will 'hold' the output true until the value goes back below the reset point.

In this specific example, the pump runs when light oil reaches 20000, and turns off when it reaches 5000:

[[File:SR_latch.png|600px]]

A similar backup steam power example with detailed configuration and explanation can be found here: [[Tutorial:Circuit_network_cookbook#RS_latch_-_single_decider_version|RS latch - single decider version]]

== Memory ==
How to store a constant value for later use, either for a basic counter or for more advanced logic. A decider combinator wired output tied to input and configured greater than zero (for positive values), input -> output will 'hold' a value, as long as all other inputs on the network are zero.

Any non-zero input condition will create a basic clock; incrementing the stored value by the sum of all connected input values every cycle. A single pulse of an input will cause a single increment by the pulsed value. Reset to zero occurs whenever the set condition is no longer met, or if a negative pulse equal to the input occurs.

== Basic clocks ==
[[File:Timer.png|thumb|right|377px|A basic clock. 30 ticks is the ceiling for Signal 1; which is continuously added.]]
Clocks are constructed by having the output of a combinator tied back to its own input, such that every cycle advances its own count. Either the arithmetic combinator or the decider combinator can be used.

An arithmetic combinator tied to itself is fun to watch and will happily run-away, but requires additional control logic to reset.

A self-resetting clock requires just a single decider combinator with output wired to input and configured with Less Than (<) and Input -> Output. When a constant combinator is then connected to the input, every cycle it will count up by the value of the Constant Combinator until the set conditional value is reached, then output a zero which will be summed with the constant combinator, and reset the process.

The clock sequence will not include zero, will begin at the value set by the constant combinator, and will include whatever value eventually causes the conditional to be false. An arithmetic combinator can modify the clock sequence but remember its outputs will occur one cycle later than the clock cycle values.

A clock that only counts once can be built using the following setup:

[[File:Onetime_Clock.png|thumb|none|360px|One-time clock. Runs until T=Z+1. Reset via R>0.]]

== Pulse generators ==

Connecting an additional (=) decider combinator to the output of a basic clock will create a pulse generator, and will pulse a single output every time the clock cycles through the set condition. Any output value can be used, either directly from the clock sequence (input->output), a 1, or some value on a separate logic channel on the circuit network, such as set by a constant combinator. or by the circuit network. 
[[File:PulseGen.png|500px]]
*''The value 1 can be written as any positive integer, so long as it is within the cap or ceiling of your timer.''
*''As an example from the above timer, this light will pulse every 1st tick after the timer reaches 30 ticks, making it pulse 1/30th of a second, as Factorio updates at 60 times per second.''

== Counter ==
A counter is used to count the number of input events, and output the sum of that count. Any pulsing input into a decider combinator configured input -> output and wired between output and input will create a counter, but this input must be zero at all other times or else the combinator will run away like a clock. A pulse generator is normally used to accomplish this. Combining several gating decider isolators set with sequential conditionals, a clock, and a pulse generator to the input of a counter will allow remote polling and counting of each isolator's contents.

== Memory cells ==

=== Simple latch ===

When looping the combinator to itself, use a different color of wire from your main inputs or outputs.

[[File:SimpleLatchv2.png|415px]]

Truth Table:

{| class="wikitable"
|-
!Output 1!!Input 1!!Input 2!! Output 1 (t+1)
|-
| 0 || 0 || 0 || 0
|-
| 0 || 1 || 0 || 1
|-
| 0 || 0 || 1 || 0
|-
| 0 || 1 || 1 || 0
|-
| 1 || 0 || 0 || 1
|-
| 1 || 1 || 0 || 1 ''(2)''
|-
| 1 || 0 || 1 || 0
|-
| 1 || 1 || 1 || 1 ''(2)''
|-
|}
''Output 1 is the green wire loop seen in the picture, it carries the value to latch.''

''Input 1 is Set, while Input 2 is Reset.''

=== Positive cell ===

Cell for storing a positive value, with reset support:

[[File:AdvancedMemoryCell.png|500px]]

Connect the desired value as signal I on the right side to set the memory cell and connect a negative value as signal I to reset the cell.

* The output of the memory cell is 2 mutually exclusive signals.
** In case input signal I > 0 then signal I is passed to the other side.
** In case input signal I is interrupted, then signal M is passed instead as a memory of previous input value.
* When input signal I is interrupted, it takes 2 ticks to switch to memory signal M.
* In case input I signal lasts only one tick then memory cell starts to cycle between the 2 previous values, tick by tick. Indefinitely.
* Switching is seamless, e.g. there are no ticks with empty signal.

=== Positives and negatives cell ===

This cell can store negatives or positives. Reset is done on a dedicated line. Additionally, a 1-tick burst is handled properly. [https://forums.factorio.com/viewtopic.php?f=193&t=60330&p=362377#p362377 Forum post].

* The output M (memory) is the last non-zero input I (Input).
* A non zero R (reset) signal sets the output to zero.
* 1-tick bursts of R or I are handled properly.
* Negatives are handled properly.

[[File:Memory_cell_with_negatives.png|500px]]

== Multiplier and Dictionaries/Arrays ==
[[File:combinatorMultiplierDetailed.png|left|500px]]
* Multiplying two signals together is simple and requires only a single combinator, however multiplying a set of signals is more complicated.
* A proof is shown below for the equation and why it works.
* A dictionary is a system that allows a value on a specific signal to be accessed. For example, A can contain many signals (either from a constant combinator or memory cell) and B can contain 1 of a specific signal (such as blue signal). What remains is the blue-signal value from A. This is because all the other signals are multiplied by 0.
* Arrays are similar to dictionaries, but instead of using a signal as a key, we use a number. Constant combinators are placed mapping each signal to a unique number (such as 1 yellow belt, 2 red belt, 3 blue belt, 4 burner inserter, etc). Then, use a combinator of "each = index OUTPUT 1 of each" and plug that in as the input to a dictionary.{{clear}}
[[File:combinatorMultiplierMath.png|left|500px]]

((A+B)^2 - (A-B)^2)/4 = AB
(A+B)^2 - (A-B)^2 = 4AB
(A^2 + 2AB + B^2) - (A^2 - 2AB + B^2) = 4AB
4AB = 4AB

{{clear}}

== Bitpacking ==

{| class="wikitable sortable right"
|+ Caption text
|-
! Bit size !! Min value !! Max value !! Min unsigned !! Max unsigned
|-
| 32-bit || -2147483648 || 2147483647 || 0 || 4294967295
|-
| 16-bit || -32768 || 32767 || 0 || 65535
|-
| 8-bit || -128 || 127 || 0 || 255
|-
| 4-bit || -8 || 7 || 0 || 15
|}

Bitpacking is a way to cram multiple small numbers into a single signal. Since [[Circuit_network#Send_information|signals are 32-bit integers]], we can store up to 32 bits of data per signal: that is either a single 32-bit number, two 16-bit numbers, four 8-bit numbers, eight 4-bit numbers, etc.

For instance, say we want to cram the following four 8-bit numbers onto a single signal in a constant combinator: 8 33 -15 100. If we store the first number 8 by itself, the bits from 9 to 32 are completely unused and are all zeros. By using the [[:wikipedia:Bitwise_operation#Logical_shift|bitshift operation]], we can "move" a number over to use a different range of bits. So if we shift 33 over by 8 it becomes 8448, which happens to only occupy bits 9 thru 16. Similarly, we can shift -5 over by 16 to get 15794176 and we shift 100 by 24 to get 1677721600. Now, with these four numbers, since none of them have bit ranges that overlap, we can simply squash them all into one number: either by using the [[:wikipedia:Bitwise_operation#OR|bitwise or operation]] on all numbers, or alternatively by simply adding up all the numbers: 1693524232. This single number now stores four, and we can index them in-game with a arithmetic combinator.

todo: insert video and image of bits

{{clear}}

== Vectors/Dictionaries ==
Working with signal vectors can sometimes require a lookup dictionary that maps integers indexes to signals.

=== Vector Filterer ===
A indexer is a design that accepts as input a vector of signals and a second vector of signals to filter by.
For non-negative input vectors only, the design uses a quirk with combinators:

=== Vector Indexer ===

If we're only considering non-negative input vectors where every signal in the vector is positive or 0, then a indexer is a relatively simple.

A indexer is a design that accepts as input a vector of signals, a lookup dictionary, and an index signal.

However, if

== See Also ==
* [http://www.factorioforums.com/forum/viewtopic.php?f=18&t=14556 Combinators 101 (Tutorial)]
* [[Tutorial:Circuit network cookbook]]
* [[Circuit network]]
* [[Arithmetic combinator]]
* [[Constant combinator]]
* [[Decider combinator]]

User:Bitbyte/Tutorial:Combinator tutorial

2023-12-28T00:40:21Z

Bitbyte: copy Tutorial:Combinator_tutorial

''This is an '''advanced''' tutorial. Beginners should refer to the [[Tutorial:Circuit network cookbook]] for examples and the [[Circuit network]] page for an overview over the circuit network. This tutorial assumes a basic understanding of circuits and covers more advanced topics like SR latches, memory cells and clocks.''

{{Languages}}
== Introduction ==
Combinator logic is achieved by cross-connecting outputs to inputs in such a way to achieve the desired logic. While advanced logic requires a multitude of combinators, some very useful basic logic can be achieved using only a handful of combinators. Combinator logic works because Factorio only updates at '''60 times per second''', such that combinators analyze their logic in a step, and then sum and/or decide the resulting output values on the next step.

When logic values are computed by combinators, the outputs are not recognized by the circuit network until the following step. So when a [[decider combinator]] is used to detect a certain input condition, it's output value will not take effect on the circuit network until the next step. '''This behavior is important to remember and can result in sequencing errors and significant delays when multiple combinators are connected in series.'''

Circuit wires act like a wire bus in electronics; it carries information in the connected wires, meaning that if there are similar signals on a wire it will add them automatically. If the signal is different, it will be carried in that wire as well, but as a different signal.

When cross-connecting combinators, it is good practice to use the unused color to cross-connect, this will split the input and output networks and prevent unwanted inputs from accidentally connecting to a larger circuit network. Combinators will sum the red and green inputs prior to calculation, so either color can be used when wiring the output back to the input. In in most cases however, it is more useful to use the opposing color of the wire so that it will not interfere with the resulting output and input.

== Virtual signals ==

[[File:Virtual Signals dialog box.png|thumb|right|Virtual Signals available for use in the circuit network]]

In addition to the standard item signals, Factorio's circuit network also includes a set of signals that do not represent any particular game item. Instead, these virtual signals serve as user-definable channels for the circuit network; they hold whatever meaning the user wants them to. There are currently 48 virtual signals that can be sent over the circuit network:

* The 36 alphanumeric characters (A-Z, 0-9)
* Nine colors: red, green, blue, yellow, magenta, cyan, white, grey, and black
* Three icons: a check mark, an informational letter 'i', and a small, white dot

=== Logic signals ===

There are three additional virtual signals known as ''logic signals''. Unlike other signals, they cannot be sent over the circuit network; instead, they apply additional logic to combinators that modify their behavior. Specifically, these logic symbols act as wildcards, which are special signals that represent '''zero or more''' arbitrary signals instead of representing a single discrete signal. Factorio's circuit network implements three types of wildcards.

==== Everything wildcard [[File:Signal_everything.png|left|20px]] ====

The ''Everything'' wildcard is used with decider combinators. Its exact behavior depends on whether it is used as an input or an output:
* '''Input''': Returns true if ''all'' input signals pass the condition, or if there are ''no'' input signals, otherwise it returns false.
* '''Output''': Returns ''all'' non-zero input signals.

When used as an input, the ''everything'' wildcard can be thought of as a logical AND, or a [[:Wikipedia:universal quantification|universal quantifier]]. When used as an output, it acts as an 'echo' or 'dump' of input signals.

'''Note''': Can be used as an output as long as the input is not an ''each'' wildcard.

==== Anything wildcard [[File:Signal_anything.png|left|20px]] ====

The ''Anything'' wildcard is also used with decider combinators.

Given '''at least one''' input signal, it returns true if ''any'' input signal passes the condition. If no signal passes the condition, or there are no input signals, then it returns false. From this behavior, the ''anything'' wildcard can be thought of as a logical OR, or an [[:Wikipedia:existential quantification|existential quantifier]].

When used in both the input and output of a decider combinator, ''anything'' will return one of the signals that matched.

==== Each wildcard [[File:Signal_each.png|left|20px]] ====

The ''Each'' wildcard is used with both decider combinators and [[arithmetic combinator]]s, and behaves somewhat uniquely compared to the previous two. Generally speaking, it performs a combinator action on each signal '''individually''', with the exact action depending on how it is used, and the type of combinator it is used in. It can be used as an input, and it can be used as an output, but ''only when it is used as input as well''.

In a '''decider combinator''', when used as an input, the ''each'' wildcard individually compares each input signal against the combinator condition, returning each signal that passes the condition. The manner that the ''each'' wildcard returns signals when used as input depends on whether or not it is also used as output:
* '''Input only''': Sums each input signal that passed the condition, and depending on output settings returns either a count of the passed signals or a summation of their values as the desired output signal.
* '''Input and Output''': Returns each signal that passed the condition, their values depending on the output settings.

In an '''arithmetic combinator''', the designated arithmetic operation is applied individually to each input signal, and similar to the decider combinator, the signal that is returned depends on whether or not the ''each'' wildcard is used as output:
* '''Input only''': The result of each operation on the input signals is summed and returned as the desired output signal.
* '''Input and Output''': Each input signal is returned with the result of the specified operation applied to it.

The ''Each'' wildcard is therefore notably more complex than the other two wildcards, but offers a good deal of power in exchange for its complexity.

== Input insulator & gate ==
An arithmetic combinator set to (In: Each + 0, Out: Each) can be used to swap wire colors and as an insulator to prevent downstream logic from backfeeding into the circuit network's inputs.

A decider combinator set to (Out: Everything, Input-> Output) will also function as an insulator as long as the set logic condition is true. This can also selectively pass or 'gate' inputs only when desired. This could be used to sequentially poll remote train stations for their chest contents, and include only desired stations.

== Set/Reset latching switch ==
You want something to SET a trigger at some quantity, but then STAY on until that quantity hits some other value, the RESET value. You'll need one decider combinator and one arithmetic combinator. (Two decider combinators and a [[constant combinator]] can also be used for more complex multi-channel conditions.)

Setup the first decider combinator to the desired set conditional and to output a 1. Then connect the output to the input of an arithmetic combinator, and configure it to multiply by the bias value, which is the difference between the set and reset values, and wire the arithmetic output to the input of the decider. The arithmetic output channel must be set the same as the decider's input channel. 
Whenever the set conditional is reached, the decider will output a '1', and the bias of the arithmetic combinator will be applied. This will 'hold' the output true until the value goes back below the reset point.

In this specific example, the pump runs when light oil reaches 20000, and turns off when it reaches 5000:

[[File:SR_latch.png|600px]]

A similar backup steam power example with detailed configuration and explanation can be found here: [[Tutorial:Circuit_network_cookbook#RS_latch_-_single_decider_version|RS latch - single decider version]]

== Memory ==
How to store a constant value for later use, either for a basic counter or for more advanced logic. A decider combinator wired output tied to input and configured greater than zero (for positive values), input -> output will 'hold' a value, as long as all other inputs on the network are zero.

Any non-zero input condition will create a basic clock; incrementing the stored value by the sum of all connected input values every cycle. A single pulse of an input will cause a single increment by the pulsed value. Reset to zero occurs whenever the set condition is no longer met, or if a negative pulse equal to the input occurs.

== Basic clocks ==
[[File:Timer.png|thumb|right|377px|A basic clock. 30 ticks is the ceiling for Signal 1; which is continuously added.]]
Clocks are constructed by having the output of a combinator tied back to its own input, such that every cycle advances its own count. Either the arithmetic combinator or the decider combinator can be used.

An arithmetic combinator tied to itself is fun to watch and will happily run-away, but requires additional control logic to reset.

A self-resetting clock requires just a single decider combinator with output wired to input and configured with Less Than (<) and Input -> Output. When a constant combinator is then connected to the input, every cycle it will count up by the value of the Constant Combinator until the set conditional value is reached, then output a zero which will be summed with the constant combinator, and reset the process.

The clock sequence will not include zero, will begin at the value set by the constant combinator, and will include whatever value eventually causes the conditional to be false. An arithmetic combinator can modify the clock sequence but remember its outputs will occur one cycle later than the clock cycle values.

A clock that only counts once can be built using the following setup:

[[File:Onetime_Clock.png|thumb|none|360px|One-time clock. Runs until T=Z+1. Reset via R>0.]]

== Pulse generators ==

Connecting an additional (=) decider combinator to the output of a basic clock will create a pulse generator, and will pulse a single output every time the clock cycles through the set condition. Any output value can be used, either directly from the clock sequence (input->output), a 1, or some value on a separate logic channel on the circuit network, such as set by a constant combinator. or by the circuit network. 
[[File:PulseGen.png|500px]]
*''The value 1 can be written as any positive integer, so long as it is within the cap or ceiling of your timer.''
*''As an example from the above timer, this light will pulse every 1st tick after the timer reaches 30 ticks, making it pulse 1/30th of a second, as Factorio updates at 60 times per second.''

== Counter ==
A counter is used to count the number of input events, and output the sum of that count. Any pulsing input into a decider combinator configured input -> output and wired between output and input will create a counter, but this input must be zero at all other times or else the combinator will run away like a clock. A pulse generator is normally used to accomplish this. Combining several gating decider isolators set with sequential conditionals, a clock, and a pulse generator to the input of a counter will allow remote polling and counting of each isolator's contents.

== Memory cells ==

=== Simple latch ===

When looping the combinator to itself, use a different color of wire from your main inputs or outputs.

[[File:SimpleLatchv2.png|415px]]

Truth Table:

{| class="wikitable"
|-
!Output 1!!Input 1!!Input 2!! Output 1 (t+1)
|-
| 0 || 0 || 0 || 0
|-
| 0 || 1 || 0 || 1
|-
| 0 || 0 || 1 || 0
|-
| 0 || 1 || 1 || 0
|-
| 1 || 0 || 0 || 1
|-
| 1 || 1 || 0 || 1 ''(2)''
|-
| 1 || 0 || 1 || 0
|-
| 1 || 1 || 1 || 1 ''(2)''
|-
|}
''Output 1 is the green wire loop seen in the picture, it carries the value to latch.''

''Input 1 is Set, while Input 2 is Reset.''

=== Positive cell ===

Cell for storing a positive value, with reset support:

[[File:AdvancedMemoryCell.png|500px]]

Connect the desired value as signal I on the right side to set the memory cell and connect a negative value as signal I to reset the cell.

* The output of the memory cell is 2 mutually exclusive signals.
** In case input signal I > 0 then signal I is passed to the other side.
** In case input signal I is interrupted, then signal M is passed instead as a memory of previous input value.
* When input signal I is interrupted, it takes 2 ticks to switch to memory signal M.
* In case input I signal lasts only one tick then memory cell starts to cycle between the 2 previous values, tick by tick. Indefinitely.
* Switching is seamless, e.g. there are no ticks with empty signal.

=== Positives and negatives cell ===

This cell can store negatives or positives. Reset is done on a dedicated line. Additionally, a 1-tick burst is handled properly. [https://forums.factorio.com/viewtopic.php?f=193&t=60330&p=362377#p362377 Forum post].

* The output M (memory) is the last non-zero input I (Input).
* A non zero R (reset) signal sets the output to zero.
* 1-tick bursts of R or I are handled properly.
* Negatives are handled properly.

[[File:Memory_cell_with_negatives.png|500px]]

== Multiplier and Dictionaries/Arrays ==
[[File:combinatorMultiplierDetailed.png|left|500px]]
* Multiplying two signals together is simple and requires only a single combinator, however multiplying a set of signals is more complicated.
* A proof is shown below for the equation and why it works.
* A dictionary is a system that allows a value on a specific signal to be accessed. For example, A can contain many signals (either from a constant combinator or memory cell) and B can contain 1 of a specific signal (such as blue signal). What remains is the blue-signal value from A. This is because all the other signals are multiplied by 0.
* Arrays are similar to dictionaries, but instead of using a signal as a key, we use a number. Constant combinators are placed mapping each signal to a unique number (such as 1 yellow belt, 2 red belt, 3 blue belt, 4 burner inserter, etc). Then, use a combinator of "each = index OUTPUT 1 of each" and plug that in as the input to a dictionary.{{clear}}
[[File:combinatorMultiplierMath.png|left|500px]]

((A+B)^2 - (A-B)^2)/4 = AB
(A+B)^2 - (A-B)^2 = 4AB
(A^2 + 2AB + B^2) - (A^2 - 2AB + B^2) = 4AB
4AB = 4AB

{{clear}}

== See Also ==
* [http://www.factorioforums.com/forum/viewtopic.php?f=18&t=14556 Combinators 101 (Tutorial)]
* [[Tutorial:Circuit network cookbook]]
* [[Circuit network]]
* [[Arithmetic combinator]]
* [[Constant combinator]]
* [[Decider combinator]]

Blueprint string format

2023-12-28T00:38:47Z

Bitbyte: fix missing table headers

[[File:blueprint_string_preview.png|thumb|340px|right|Preview of a blueprint string.]]This is a technical description of the blueprint string format, used to share blueprints with other users.

A blueprint string is a JSON representation of the blueprint, compressed with zlib deflate using compression level 9 and then encoded using base64 with a version byte in front of the encoded string. The version byte is currently 0 (for all Factorio versions through 1.1).
So to get the JSON representation of a blueprint from a blueprint string, skip the first byte, base64 decode the string, and finally decompress using zlib inflate.

== Json representation of a blueprint/blueprint book ==

The json representation of a blueprint or blueprint book is one large object inside another "wrapping" object, its key inside that object is either blueprint or blueprint-book.

=== Blueprint book object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| item
| String, the name of the item that was saved ("blueprint-book" in vanilla).
| String
|-
| label
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
| blueprints
| The actual content of the blueprint book, array of objects containing an "index" key and 0-based value and a "blueprint" key with a [[#Blueprint object]] as the value.
| Array
|-
| active_index
| Index of the currently selected blueprint, 0-based.
| Integer
|-
| version
| The map version of the map the blueprint was created in, see [[Version string format]].
| Integer (long)
|}

=== Blueprint object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| item
| String, the name of the item that was saved ("blueprint" in vanilla).
| String
|-
| label
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
| entities
| The actual content of the blueprint, array of [[#Entity object]]s.
| Array
|-
| tiles
| The tiles included in the blueprint, array of [[#Tile object]]s.
| Array
|-
| icons
| The icons of the blueprint set by the user, array of [[#Icon object]]s.
| Array
|-
| schedules
| The schedules for trains in this blueprint, array of [[#Schedule object]]s.
| Array
|-
| description
| The description of the blueprint. Optional.
| String
|-
| snap-to-grid
| The dimensions of the grid to use for snapping. Optional. [[#Position object]].
| Object
|-
| absolute-snapping
| Whether the blueprint uses absolute or relative snapping. Optional.
| Boolean
|-
| position-relative-to-grid
| Offset relative to the global absolute snapping grid. Optional. [[#Position object]].
| Object
|-
| version
| The map version of the map the blueprint was created in.
| Integer (long)
|}

=== Icon object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| index
| Index of the icon, 1-based.
| Integer
|-
| signal
| The icon that is displayed, [[#SignalID object]].
| Object
|}

=== SignalID object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the signal prototype this signal is set to.
| String
|-
| type
| Type of the signal. Either "item", "fluid" or "virtual".
| String
|}

=== Entity object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_number
| Index of the entity, 1-based.
| Integer
|-
| name
| Prototype name of the entity (e.g. "offshore-pump").
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|-
| direction
| Direction of the entity, uint (optional).
| Integer
|-
| orientation
| Orientation of cargo wagon or locomotive, value 0 to 1 (optional).
| Floating Point
|-
| connections
| Circuit connection, object with keys starting from 1, values are [[#Connection object]]s (optional).
| Object
|-
| neighbours
| Copper wire connections, array of entity_numbers (optional).
| Array
|-
| control_behavior
| [[#Control behavior object]] of this entity (optional).
| Object
|-
| items
| Item requests by this entity, this is what defines the item-request-proxy when the blueprint is placed, optional. [[#Item request object]]
| Object
|-
| recipe
| Name of the recipe prototype this assembling machine is set to, optional, string.
| String
|-
| bar
| Used by [[Prototype/Container]], optional. The index of the first inaccessible item slot due to limiting with the red "bar". 0-based [[Types/ItemStackIndex]].
| Integer
|-
| inventory
| Cargo wagon inventory configuration, optional. [[#Inventory object]]
| Object
|-
| infinity_settings
| Used by [[Prototype/InfinityContainer]], optional. [[#Infinity settings object]]
| Object
|-
| type
| Type of the underground belt or loader, optional. Either "input" or "output".
| String
|-
| input_priority
| Input priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| output_priority
| Output priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| filter
| Filter of the splitter, optional. Name of the item prototype the filter is set to, string.
| String
|-
| filters
| Filters of the filter inserter or loader, optional. Array of [[#Item filter object]]s.
| Array
|-
| filter_mode
| Filter mode of the filter inserter, optional. Either "whitelist" or "blacklist".
| String
|-
| override_stack_size
| The stack size the inserter is set to, optional. [[Types/uint8]].
| Integer
|-
| drop_position
| The drop position the inserter is set to, optional. [[#Position object]].
| Object
|-
| pickup_position
| The pickup position the inserter is set to, optional. [[#Position object]].
| Object
|-
| request_filters
| Used by [[Prototype/LogisticContainer]], optional. [[#Logistic filter object]].
| Array
|-
| request_from_buffers
| Boolean. Whether this requester chest can request from buffer chests.
| Boolean
|-
| parameters
| Used by [[Programmable speaker]], optional. [[#Speaker parameter object]].
| Object
|-
| alert_parameters
| Used by [[Programmable speaker]], optional. [[#Speaker alert parameter object]]
| Object
|-
| auto_launch
| Used by the rocket silo, optional. Boolean, whether auto launch is enabled.
| Boolean
|-
| variation
| Used by [[Prototype/SimpleEntityWithForce]] or [[Prototype/SimpleEntityWithOwner]], optional. [[Types/GraphicsVariation]]
|
|-
| color
| Color of the [[Prototype/SimpleEntityWithForce]], [[Prototype/SimpleEntityWithOwner]], or train station, optional. [[#Color object]].
| Object
|-
| station
| The name of the train station, optional.
| String
|-
| manual_trains_limit
| The manually set train limit of the train station, optional.
| Integer
|-
| switch_state
| The current state of the power switch, optional.
| Boolean
|-
| tags
| Dictionary of arbitrary data, optional. [https://lua-api.factorio.com/latest/concepts.html#Tags Tags].
| Object
|}

=== Inventory object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| filters
| Array of [[#Item filter object]]s.
| Array
|-
| bar
| The index of the first inaccessible item slot due to limiting with the red "bar". 0-based, optional. [[Types/ItemStackIndex]].
| Integer
|}

=== Schedule object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| schedule
| Array of [[#Schedule Record object]]s.
| Array
|-
| locomotives
| Array of entity numbers of locomotives using this schedule.
| Array
|}

=== Schedule Record object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| station
| The name of the stop for this schedule record.
| String
|-
| wait_conditions
| Array of [[#Wait Condition object]]s.
| Array
|}

=== Wait Condition object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| type
| One of "time", "inactivity", "full", "empty", "item_count", "circuit", "robots_inactive", "fluid_count", "passenger_present", "passenger_not_present".
| String
|-
| compare_type
| Either "and", or "or". Tells how this condition is to be compared with the preceding conditions in the corresponding wait_conditions array.
| String
|-
| ticks
| Number of ticks to wait or of inactivity. Only present when type is "time" or "inactivity". Optional.
| uint
|-
| condition
| [https://lua-api.factorio.com/latest/concepts.html#CircuitCondition CircuitCondition object], only present when type is "item_count", "circuit" or "fluid_count".
| Object
|}

=== Tile object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Prototype name of the tile (e.g. "concrete")
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|}

=== Position object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| x
| X position within the blueprint, 0 is the center.
| Floating point
|-
| y
| Y position within the blueprint, 0 is the center.
| Floating point
|}

=== Connection object ===
Object containing information about the connections to other entities formed by red or green wires.

{| class="wikitable"
! Key !! Description !! Data type
|-
| 1
| First connection point. The default for everything that doesn't have multiple connection points.[[#Connection point object]]
| Object
|-
| 2
| Second connection point. For example, the "output" part of an arithmetic combinator.[[#Connection point object]]
| Object
|}

=== Connection point object ===
The actual point where a wire is connected to. Contains information about where it is connected to.

{| class="wikitable"
! Key !! Description !! Data type
|-
| red
| An array of [[#Connection data object]] containing all the connections from this point created by red wire.
| Array
|-
| green
| An array of [[#Connection data object]] containing all the connections from this point created by green wire.
| Array
|}

=== Connection data object ===
Information about a single connection between two connection points.

{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_id
| ID of the entity this connection is connected with.
| Integer
|-
| circuit_id
| The circuit connector id of the entity this connection is connected to, see [https://lua-api.factorio.com/latest/defines.html#defines.circuit_connector_id defines.circuit_connector_id].
| Integer
|}

=== Item request object ===
1 or more instances of key/value pairs.
Key is the name of the item, string.
Value is the amount of items to be requested, [[Types/ItemCountType]].

=== Item filter object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}

=== Infinity settings object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| remove_unfiltered_items
| Boolean. Whether the "remove unfiltered items" checkbox is checked.
| Boolean
|-
| filters
| Filters of the infinity container, optional. Array of [[#Infinity filter object]]s.
| Array
|}

=== Infinity filter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype the filter is set to, string.
| String
|-
| count
| Number the filter is set to, [[Types/ItemCountType]].
| Integer
|-
| mode
| Mode of the filter. Either "at-least", "at-most", or "exactly".
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}

=== Logistic filter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|-
| count
| Number the filter is set to, [[Types/ItemCountType]]. Is 0 for storage chests.
| Integer
|}

=== Speaker parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| playback_volume
| [[Types/double]]. Volume of the speaker.
| Floating point
|-
| playback_globally
| Boolean, whether global playback is enabled.
| Boolean
|-
| allow_polyphony
| Boolean, whether polyphony is allowed.
| Boolean
|}

=== Speaker alert parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| show_alert
| Boolean, whether an alert is shown.
| Boolean
|-
| show_on_map
| Boolean, whether an alert icon is shown on the map.
| Boolean
|-
| icon_signal_id
| The icon that is displayed with the alert, [[#SignalID object]].
| Object
|-
| alert_message
| String, message of the alert.
| String
|}

=== Color object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| r
| red, number from 0 to 1.
| Floating point
|-
| g
| green, number from 0 to 1.
| Floating point
|-
| b
| blue, number from 0 to 1.
| Floating point
|-
| a
| transparency, number from 0 to 1.
| Floating point
|}

=== Control behavior object ===

'''ALL fields are optional''' and depend on the type of the entity.

{| class="wikitable"
|-
! Key !! Description !! Data type
|-
| logistic_condition
| [https://lua-api.factorio.com/latest/concepts.html#CircuitCondition CircuitCondition]
| Object
|-
| connect_to_logistic_network
| Whether this entity is connected to the logistic network and enables/disables based on logistic_condition.
| Boolean
|-
| circuit_close_signal
| Whether this rail signal can be closed by circuit_condition.
| Boolean
|-
| circuit_read_signal
| Whether or not to read the state of this rail/chain signal.
| Boolean
|-
| red_output_signal
| [[#SignalID]] to use if the rail/chain signal is currently red.
| Object
|-
| orange_output_signal
| [[#SignalID]] to use if the rail/chain signal is currently orange.
| Object
|-
| green_output_signal
| [[#SignalID]] to use if the rail/chain signal is currently green.
| Object
|-
| blue_output_signal
| [[#SignalID]] to use if the chain signal is currently blue.
| Object
|-
| circuit_condition
| [https://lua-api.factorio.com/latest/concepts.html#CircuitCondition CircuitCondition]
| Object
|-
| circuit_enable_disable
| Enable or disable based on circuit_condition.
| Boolean
|-
| send_to_train
| Send circuit values to the train to use in schedule conditions.
| Boolean
|-
| read_from_train
| Get the currently stopped trains cargo.
| Boolean
|-
| read_stopped_train
| Get the currently stopped trains ID.
| Boolean
|-
| train_stopped_signal
| [[#SignalID]] to output the train ID on.
| Object
|-
| set_trains_limit
| Whether this stations trains limit will be set through circuit values.
| Boolean
|-
| trains_limit_signal
| [[#SignalID]] to use to set the trains limit.
| Object
|-
| read_trains_count
| Whether to read this stations currently on route trains count.
| Boolean
|-
| trains_count_signal
| [[#SignalID]] to output the on route trains count on.
| Object
|-
| read_logistics
| Whether this roboport should output the contents of its network.
| Boolean
|-
| read_robot_stats
| Whether this roboport should output the robot stats of its network.
| Boolean
|-
| available_logistic_output_signal
| [[#SignalID]] to output available logistic robots on.
| Object
|-
| total_logistic_output_signal
| [[#SignalID]] to output the total count of logistic robots on.
| Object
|-
| available_construction_output_signal
| [[#SignalID]] to output available construction robots on.
| Object
|-
| total_construction_output_signal
| [[#SignalID]] to output the total count of construction robots on.
| Object
|-
| circuit_open_gate
| Whether to limit the gate opening with circuit_condition.
| Boolean
|-
| circuit_read_sensor
| Whether to send the wall-gate proximity sensor to the circuit network.
| Boolean
|-
| output_signal
| [[#SignalID]] to output the wall-gate sensor / accumulator charge on.
| Object
|-
| circuit_read_hand_contents
| Whether to read this belts content or inserters hand.
| Boolean
|-
| circuit_contents_read_mode
| [https://lua-api.factorio.com/latest/defines.html#defines.control_behavior.transport_belt.content_read_mode defines.control_behavior.transport_belt.content_read_mode]
| Integer
|-
| circuit_mode_of_operation
|
| Integer
|-
| circuit_hand_read_mode
| [https://lua-api.factorio.com/latest/defines.html#defines.control_behavior.inserter.hand_read_mode defines.control_behavior.inserter.hand_read_mode]
| Integer
|-
| circuit_set_stack_size
| Whether to set the inserters stack size from a circuit signal.
| Boolean
|-
| stack_control_input_signal
| [[#SignalID]] to use to set the inserters stack size.
| Object
|-
| circuit_read_resources
| Whether this miner should output its remaining resource amounts to the circuit network.
| Boolean
|-
| circuit_resource_read_mode
| [https://lua-api.factorio.com/latest/defines.html#defines.control_behavior.mining_drill.resource_read_mode defines.control_behavior.mining_drill.resource_read_mode]
| Integer
|-
| is_on
| Whether this constant combinator is currently on or off.
| Boolean
|-
| filters
| Array of [https://lua-api.factorio.com/latest/concepts.html#ConstantCombinatorParameters ConstantCombinatorParameters].
| Array
|-
| arithmetic_conditions
| [https://lua-api.factorio.com/latest/concepts.html#ArithmeticCombinatorParameters ArithmeticCombinatorParameters]
| Object
|-
| decider_conditions
| [https://lua-api.factorio.com/latest/concepts.html#DeciderCombinatorParameters DeciderCombinatorParameters]
| Object
|-
| circuit_parameters
| [https://lua-api.factorio.com/latest/concepts.html#ProgrammableSpeakerCircuitParameters ProgrammableSpeakerCircuitParameters]
| Object
|-
| use_colors
| Whether this lamp should use colors or not.
| Boolean
|}

[[Category:Technical]]

Blueprint string format

2023-01-16T08:50:18Z

Bitbyte: typo

{{Languages}} [[Category:Technical]]
[[File:blueprint_string_preview.png|thumb|340px|right|Preview of a blueprint string.]]This is a technical description of the blueprint string format, used to share blueprints with other users.

A blueprint string is a JSON representation of the blueprint, compressed with zlib deflate using compression level 9 and then encoded using base64 with a version byte in front of the encoded string. The version byte is currently 0 (for all Factorio versions through 1.1).
So to get the JSON representation of a blueprint from a blueprint string, skip the first byte, base64 decode the string, and finally decompress using zlib inflate.

== Json representation of a blueprint/blueprint book ==

The json representation of a blueprint or blueprint book is one large object inside another "wrapping" object, its key inside that object is either blueprint or blueprint-book.

=== Blueprint book object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| item
| String, the name of the item that was saved ("blueprint-book" in vanilla).
| String
|-
| label
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
| blueprints
| The actual content of the blueprint book, array of objects containing an "index" key and 0-based value and a "blueprint" key with a [[#Blueprint object]] as the value.
| Array
|-
| active_index
| Index of the currently selected blueprint, 0-based.
| Integer
|-
| version
| The map version of the map the blueprint was created in, see [[Version string format]].
| Integer (long)
|}

=== Blueprint object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| item
| String, the name of the item that was saved ("blueprint" in vanilla).
| String
|-
| label
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
| entities
| The actual content of the blueprint, array of [[#Entity object]]s.
| Array
|-
| tiles
| The tiles included in the blueprint, array of [[#Tile object]]s.
| Array
|-
| icons
| The icons of the blueprint set by the user, array of [[#Icon object]]s.
| Array
|-
| schedules
| The schedules for trains in this blueprint, array of [[#Schedule object]]s.
| Array
|-
| version
| The map version of the map the blueprint was created in.
| Integer (long)
|}

=== Icon object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| index
| Index of the icon, 1-based.
| Integer
|-
| signal
| The icon that is displayed, [[#SignalID object]].
| Object
|}

=== SignalID object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the signal prototype this signal is set to.
| String
|-
| type
| Type of the signal. Either "item", "fluid" or "virtual".
| String
|}

=== Entity object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_number
| Index of the entity, 1-based.
| Integer
|-
| name
| Prototype name of the entity (e.g. "offshore-pump").
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|-
| direction
| Direction of the entity, uint (optional).
| Integer
|-
| orientation
| Orientation of cargo wagon or locomotive, value 0 to 1 (optional).
| Floating Point
|-
| connections
| Circuit connection, object with keys starting from 1, values are [[#Connection object]]s (optional).
| Object
|-
| neighbours
| Copper wire connections, array of entity_numbers (optional).
| Array
|-
| control_behavior
|
| Object
|-
| items
| Item requests by this entity, this is what defines the item-request-proxy when the blueprint is placed, optional. [[#Item request object]]
| Object
|-
| recipe
| Name of the recipe prototype this assembling machine is set to, optional, string.
| String
|-
| bar
| Used by [[Prototype/Container]], optional. The index of the first inaccessible item slot due to limiting with the red "bar". 0-based [[Types/ItemStackIndex]].
| Integer
|-
| inventory
| Cargo wagon inventory configuration, optional. [[#Inventory object]]
| Object
|-
| infinity_settings
| Used by [[Prototype/InfinityContainer]], optional. [[#Infinity settings object]]
| Object
|-
| type
| Type of the underground belt or loader, optional. Either "input" or "output".
| String
|-
| input_priority
| Input priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| output_priority
| Output priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| filter
| Filter of the splitter, optional. Name of the item prototype the filter is set to, string.
| String
|-
| filters
| Filters of the filter inserter or loader, optional. Array of [[#Item filter object]]s.
| Array
|-
| filter_mode
| Filter mode of the filter inserter, optional. Either "whitelist" or "blacklist".
| String
|-
| override_stack_size
| The stack size the inserter is set to, optional. [[Types/uint8]].
| Integer
|-
| drop_position
| The drop position the inserter is set to, optional. [[#Position object]].
| Object
|-
| pickup_position
| The pickup position the inserter is set to, optional. [[#Position object]].
| Object
|-
| request_filters
| Used by [[Prototype/LogisticContainer]], optional. [[#Logistic filter object]].
| Array
|-
| request_from_buffers
| Boolean. Whether this requester chest can request from buffer chests.
| Boolean
|-
| parameters
| Used by [[Programmable speaker]], optional. [[#Speaker parameter object]].
| Object
|-
| alert_parameters
| Used by [[Programmable speaker]], optional. [[#Speaker alert parameter object]]
| Object
|-
| auto_launch
| Used by the rocket silo, optional. Boolean, whether auto launch is enabled.
| Boolean
|-
| variation
| Used by [[Prototype/SimpleEntityWithForce]] or [[Prototype/SimpleEntityWithOwner]], optional. [[Types/GraphicsVariation]]
|
|-
| color
| Color of the [[Prototype/SimpleEntityWithForce]], [[Prototype/SimpleEntityWithOwner]], or train station, optional. [[#Color object]].
| Object
|-
| station
| The name of the train station, optional.
| String
|}

=== Inventory object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| filters
| Array of [[#Item filter object]]s.
| Array
|-
| bar
| The index of the first inaccessible item slot due to limiting with the red "bar". 0-based, optional. [[Types/ItemStackIndex]].
| Integer
|}

=== Schedule object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| schedule
| Array of [[#Schedule Record object]]s.
| Array
|-
| locomotives
| Array of entity numbers of locomotives using this schedule.
| Array
|}

=== Schedule Record object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| station
| The name of the stop for this schedule record.
| String
|-
| wait_conditions
| Array of [[#Wait Condition object]]s.
| Array
|}

=== Wait Condition object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| type
| One of "time", "inactivity", "full", "empty", "item_count", "circuit", "robots_inactive", "fluid_count", "passenger_present", "passenger_not_present".
| String
|-
| compare_type
| Either "and", or "or". Tells how this condition is to be compared with the preceding conditions in the corresponding wait_conditions array.
| String
|-
| ticks
| Number of ticks to wait or of inactivity. Only present when type is "time" or "inactivity". Optional.
| uint
|-
| condition
| CircuitCondition Object, only present when type is "item_count", "circuit" or "fluid_count".
| Object
|}

=== Tile object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Prototype name of the tile (e.g. "concrete")
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|}

=== Position object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| x
| X position within the blueprint, 0 is the center.
| Floating point
|-
| y
| Y position within the blueprint, 0 is the center.
| Floating point
|}

=== Connection object ===
Object containing information about the connections to other entities formed by red or green wires.

{| class="wikitable"
! Key !! Description !! Data type
|-
| 1
| First connection point. The default for everything that doesn't have multiple connection points.[[#Connection point object]]
| Object
|-
| 2
| Second connection point. For example, the "output" part of an arithmetic combinator.[[#Connection point object]]
| Object
|}

=== Connection point object ===
The actual point where a wire is connected to. Contains information about where it is connected to.

{| class="wikitable"
! Key !! Description !! Data type
|-
| red
| An array of [[#Connection data object]] containing all the connections from this point created by red wire.
| Array
|-
| green
| An array of [[#Connection data object]] containing all the connections from this point created by green wire.
| Array
|}

=== Connection data object ===
Information about a single connection between two connection points.

{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_id
| ID of the entity this connection is connected with.
| Integer
|-
| circuit_id
| The circuit connector id of the entity this connection is connected to, see [https://lua-api.factorio.com/latest/defines.html#defines.circuit_connector_id defines.circuit_connector_id].
| Integer
|}

=== Item request object ===
1 or more instances of key/value pairs.
Key is the name of the item, string.
Value is the amount of items to be requested, [[Types/ItemCountType]].

=== Item filter object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}

=== Infinity settings object ===
{| class="wikitable"
! Key !! Description
|-
| remove_unfiltered_items
| Boolean. Whether the "remove unfiltered items" checkbox is checked.
| Boolean
|-
| filters
| Filters of the infinity container, optional. Array of [[#Infinity filter object]]s.
| Array
|}

=== Infinity filter object ===
{| class="wikitable"
! Key !! Description
|-
| name
| Name of the item prototype the filter is set to, string.
| String
|-
| count
| Number the filter is set to, [[Types/ItemCountType]].
| Integer
|-
| mode
| Mode of the filter. Either "at-least", "at-most", or "exactly".
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}

=== Logistic filter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|-
| count
| Number the filter is set to, [[Types/ItemCountType]]. Is 0 for storage chests.
| Integer
|}

=== Speaker parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| playback_volume
| [[Types/double]]. Volume of the speaker.
| Floating point
|-
| playback_globally
| Boolean, whether global playback is enabled.
| Boolean
|-
| allow_polyphony
| Boolean, whether polyphony is allowed.
| Boolean
|}

=== Speaker alert parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| show_alert
| Boolean, whether an alert is shown.
| Boolean
|-
| show_on_map
| Boolean, whether an alert icon is shown on the map.
| Boolean
|-
| icon_signal_id
| The icon that is displayed with the alert, [[#SignalID object]].
| Object
|-
| alert_message
| String, message of the alert.
| String
|}

=== Color object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| r
| red, number from 0 to 1.
| Floating point
|-
| g
| green, number from 0 to 1.
| Floating point
|-
| b
| blue, number from 0 to 1.
| Floating point
|-
| a
| transparency, number from 0 to 1.
| Floating point
|}

Download API

2020-07-09T15:47:34Z

Bitbyte: /* Downloading */

This API allows you to download official releases of stand-alone Factorio from the Factorio servers. It's not so much of an API as it is web scraping, but it's documented here for completeness. Please update this page if you utilize it and the information becomes outdated. Also note that's there's a separate, (semi)official API for upgrading between releases, which should be used when possible to lighten the load on the Factorio servers. (I'll document that later, promise!)

== Authenticating ==

Downloading Factorio requires an authenticated session with the web server, which is different than the typical API authentication mechanism. Authentication uses the HTML endpoint at

<code>https://www.factorio.com/login</code>

Login in procedure:

# Create an HTTP session and send a GET request. You'll get some HTML in return. There's a [[:Wikipedia:Cross-site_request_forgery#Synchronizer_token_pattern|CSRF token]] you'll need to grab which can be found using one of the following selectors:
#* CSS1: <code>input[name=csrf_token]</code> (and then take the "value" attribute).
#* XPATH1: <code>//input[@name="csrf_token"]/@value</code>
# Then send a POST request with the following parameters:
#* <code>csrf_token</code>: the CSRF token you grabbed earlier.
#* <code>username_or_email</code>: your username or email address.
#* <code>password</code>: your password.

== Downloading ==

Download Factorio releases at

<code>https://www.factorio.com/get-download/{version}/{build}/{distro}</code>

* Where {version} is the version string of the release you wish to grab - e.g. "0.15.31". Use "latest" instead to default to the latest version for that build.
* {build} is the release build, which currently comprises of:
** <code>alpha</code> - the current standard full-featured build.
** <code>demo</code> - the free, publicly accessible demo versions.
** <code>headless</code> - for running servers on machines without graphical interface.
* and {distro} is the os / type of release you wish to download, currently:
** <code>win64</code> - EXE installer for 64 bit Windows.
** <code>win64-manual</code> - ZIP package for 64 bit Windows.
** <code>win32</code> - EXE installer for 32 bit Windows. ''No longer supported.''
** <code>win32-manual</code> - ZIP package for 32 bit Windows. ''No longer supported.''
** <code>osx</code> - DMG package for 64 bit Mac OS.
** <code>linux64</code> - tar.gz or tar.xz package for 64 bit Linux.
** <code>linux32</code> - tar.gz or tar.xz package for 32 bit Linux. ''No longer supported.''

Factorio servers will correctly respond with a 404 if the requested download isn't available. Experimental builds are taken down quickly after they become obsolete, so it's best to check what versions are available before hand (documented below).

Note: Windows 32 bit and 64 bit installers are [https://en.wikipedia.org/wiki/Inno_Setup Inno Setup] formatted packages (I'll document that somewhere someday).

== Version Listings ==
There is an API endpoint to find the latest version number at <code>https://factorio.com/api/latest-releases</code>. This can be polled to automatically detect when a new update was released.

Furthermore, you can grab a list of Factorio versions available for download by sending a GET request to the endpoint at

<code>https://www.factorio.com/download</code>

Experimental releases have their own page, which has the same interface, and can be found at:

<code>https://www.factorio.com/download/experimental</code>

There is also another endpoint available that filters to only headless releases. (Does not contain experimental releases)

<code>https://www.factorio.com/download-headless</code>

Then a list of version number and build combinations can be grabbed by using either of the selectors:
* CSS1: <code>h3</code>
* XPATH1: <code>//h3</code>

Alternatively, you can skip straight to selecting all of the download links, and parsing out the version numbers and such from there. (I actually recommend this method)
* CSS1: <code>body>div>ul a</code> (and then take the "href" attribute)
* XPATH1: <code>//body/div/ul//a/@href</code>

A list of available update packages is provided at <code>https://updater.factorio.com/get-available-versions</code>.

{{Languages}}[[Category:Technical]]

Console

2020-07-06T23:24:54Z

Bitbyte: add section "Increase player inventory slots"

{{Languages}}
The '''console''' is Factorio's in-game command-line interface. See [[command line parameters]] for the command line interface of the Factorio executable.

The in-game console can be used for:

* Chatting with other players
* Occasional status updates
* Running commands / scripts / cheats

There are three types of commands:

* '''[[#Normal commands|Normal]]''' - Display information about the game and customize your experience.
* '''[[#Multiplayer commands|Multiplayer]]''' - Message filtering, banning users, etc.
* '''[[#Scripting and cheat commands|Scripting/Cheating]]''' - Run small Lua scripts (but they disable achievements for the save game)

__TOC__

=== Using the console ===
The console display can be toggled with the {{keybinding|/}} (slash) or {{keybinding|~}} (tilde) keys.

You can customize the keys via '''Options Menu → Keyboard → Toggle Lua console'''.
When the console is open, you'll see a blinking cursor at the bottom of the screen; type your message or command and hit '''Return''' to send it (this will also close the console).
Documentation about message and command prefixes can be found further down this page.

The console supports [[rich text]] tags. These tags are useful for sharing blueprints, marking map locations in chat or adding icons to map markers and train stations. Ctrl + Alt-clicking the map or ground will automatically insert a GPS tag and post it into the console. Shift-clicking most things with the console open will insert a tag for that thing into the console.

When the console is closed, only the most recent messages/commands will be displayed, but they will gradually fade away (opening the console will immediately re-display all recent messages).
Note that by default, all executed commands are made visible to all users. You can set the fade-out time via '''Options Menu → Other Settings → Message Delay'''.

If you want to immediately hide the console, open the console and then press '''Escape''' key (or press '''Return''' without entering any message/command).
This not only closes the console, but it also hides all the recent messages/commands.
The console can be cleared with the '''/clear''' command.

Use the {{keybinding|↑}} and {{keybinding|↓}} keys to scroll through the console history. The {{keybinding|Tab}} key will auto-complete commands and player names.

== Normal commands ==

{| class="wikitable"
|-
! style="width:25%"| Command
! style="width:25%"| Example
! style="width:46%"| Description
! style="width:4%"| Admin only
|-
| /alerts <enable/disable/mute/unmute> <alert>
| /alerts disable turret_fire
| Enables, disables, mutes, or unmutes the given [[alerts|alert]] type. Available alerts: entity_destroyed, entity_under_attack, not_enough_construction_robots, no_material_for_construction, not_enough_repair packs, turret_fire, custom, no_storage, train_out_of_fuel, fluid_mixing.
| No
|-
| /clear
| /clear
| Clears the console.
| No
|-
| /color <color>
| /color 20 255 255 100
| Changes your color. Can either be one of the pre-defined colors or [[:Wikipedia:RGBA_color_space|RGBA value]] in the format of “# # # #”. Available colors: default, red, green, blue, orange, yellow, pink, purple, white, black, gray, brown, cyan, acid.
| No
|-
| /evolution
| /evolution
| Prints info about the alien evolution factor.
| No
|-
| /help [command]
| /help
| Prints a list of available commands, the optional argument can specify the command that should be described.
| No
|-
| /h [command]
| /h
| Same as /help.
| No
|-
| /mute-programmable-speaker <mute/unmute> <local/everyone>
| /mute-programmable-speaker mute local
| Mutes or unmutes the global sounds created by the Programmable Speaker. Use “local” to mute just the local client. Admins can use “everyone” to mute the sounds for everyone on the server.
| No
|-
| /perf-avg-frames <number>
| /perf-avg-frames 100
| Number of ticks/updates used to average performance counters. Default is 100. Value of 5-10 is recommended for fast convergence, but numbers will jitter more rapidly.
| No
|-
| /permissions
| /permissions
| Opens the permissions GUI.
| Yes
|-
| /screenshot [x resolution] [y resolution] [zoom]
| /screenshot
| Takes a screenshot with the GUI hidden, centered on the player. It is saved in the "script-output" subfolder of your [[User data directory]]. Resolution is optional and defaults to the current window size. Zoom is optional and defaults to 1.
| No
|-
| /seed
| /seed
| Prints the starting map seed.
| No
|-
| /time
| /time
| Prints info about how old the map is.
| No
|-
| /toggle-action-logging
| /toggle-action-logging
| Toggles logging all input actions performed by the game. This value isn’t persisted between game restarts and only affects your local game in multiplayer sessions.
| Yes
|-
| /toggle-heavy-mode
| /toggle-heavy-mode
| Used to investigate [[Desynchronization#Using_heavy_mode_command|desyncs]]. Will slow down the game and make multiplayer unplayable.
| Yes
|-
| /toggle-rockets-sent-gui
| /toggle-rockets-sent-gui
| Toggles if the rockets sent button is shown in the upper left corner of the screen.
| No
|-
| /unlock-shortcut-bar
| /unlock-shortcut-bar
| Unlocks all shortcut bar items.
| No
|-
| /version
| /version
| Prints the current game version.
| No
|-
|}

== Multiplayer commands ==

{| class="wikitable"
|-
! style="width:25%"| Command
! style="width:25%"| Example
! style="width:46%"| Description
! style="width:4%"| Admin only
|-
| <message>
| Hello team!
| Console input that does not start with {{keybinding|/}} is shown as a chat message to your team.
| No
|-
| /admin
| /admin
| Opens the player management GUI.
| Yes
|-
| /admins
| /admins
| Prints a list of game admins.
| No
|-
| /ban <player> <reason>
| /ban xTROLLx Throwing grenades in base
| Bans the specified player.
| Yes
|-
| /banlist <add/remove/get/clear> <player>
| /banlist get
| Adds or removes a player from the banlist. Same as /ban or /unban.
| No
|-
| /config <get/set> <option> <value>
| /config set password hunter2
| Gets or sets various multiplayer game settings. Available configs are: afk-auto-kick, allow-commands, allow-debug-settings, autosave-interval, autosave-only-on-server, ignore-player-limit-for-returning-players, max-players, max-upload-speed, only-admins-can-pause, password, require-user-verification, visibility-lan, visibility-public.
| Yes
|-
| /delete-blueprint-library <player>
| /delete-blueprint-library everybody confirm
| Deletes the blueprint library storage for the given offline player from the save file. Enter “everybody confirm” to delete the storage of all offline players.
| Yes
|-
| /demote <player>
| /demote AzureDiamond
| Demotes the player from admin.
| Yes
|-
| /ignore <player>
| /ignore Cthon98
| Prevents the chat from showing messages from this player. Admin messages are still shown.
| No
|-
| /ignores
| /ignores
| Prints a list of ignored players.
| No
|-
| /kick <player> <reason>
| /kick xTROLLx Throwing grenades in base
| Kicks the specified player.
| Yes
|-
| /mute <player>
| /mute Cthon98
| Prevents the player from saying anything in chat.
| Yes
|-
| /mutes
| /mutes
| All players that are muted (can’t talk in chat).
| No
|-
| /open <player>
| /open AzureDiamond
| Opens another player’s inventory.
| Yes
|-
| /o <player>
| /o AzureDiamond
| Same as /open.
| Yes
|-
| /players [online/o/count/c]
| /players
| Prints a list of players in the game. (parameter online/o, it prints only players that are online, count/c prints only count)
| No
|-
| /promote <player>
| /promote AzureDiamond
| Promotes the player to admin.
| Yes
|-
| /purge <player>
| /purge Cthon98
| Clears all the messages from this player from the chat log.
| Yes
|-
| /reply <message>
| /reply oh, really?
| Replies to the last player that whispered to you.
| No
|-
| /r <message>
| /r oh, really?
| Same as /reply.
| No
|-
| /server-save
| /server-save
| Saves the game on the server in a multiplayer game.
| Yes
|-
| /shout <message>
| /shout Hello world!
| Sends a message to all players including other forces.
| No
|-
| /s <message>
| /s Hello world!
| Same as /shout.
| No
|-
| /swap-players <player> [player]
| /swap-players AzureDiamond
| Swaps your character with the given player’s character, or if two players are given swaps the two player characters.
| Yes
|-
| /unban <player>
| /unban xTROLLx
| Unbans the specified player.
| Yes
|-
| /unignore <player>
| /unignore Cthon98
| Allows the chat to show messages from this player.
| No
|-
| /unmute <player>
| /unmute Cthon98
| Allows the player to talk in chat again.
| Yes
|-
| /whisper <player> <message>
| /whisper AzureDiamond that's what I see
| Sends a message to the specified player.
| No
|-
| /w <player> <message>
| /w AzureDiamond that's what I see
| Same as /whisper.
| No
|-
| /whitelist <add/remove/get/clear> [player]
| /whitelist get
| Adds or removes a player from the whitelist, where only whitelisted players can join the game. Enter nothing for “player” when using “get” to print a list of all whitelisted players. An empty whitelist disables the whitelist functionality allowing anyone to join.
| No
|}

== Scripting and cheat commands ==
{| class="wikitable"
|-
! Command
! Description
|-
| /cheat <all>
| Researches all technologies and enables cheat mode. Using the '''all''' option also gives the player some additional items.
|-
| /command <command>
| Executes a Lua command (if allowed).
|-
| /c <command>
| Executes a Lua command (if allowed).
|-
| /editor
| Toggles the map editor.
|-
| /measured-command <command>
| Executes a Lua command (if allowed) and measures time it took.
|-
| /silent-command <command>
| Executes a Lua command (if allowed) without printing it to the console.
|}

This is a very powerful feature, which also allows cheating, and as such achievements will be permanently disabled for the save as soon as you use a script command.

== Basic example scripts ==

=== Use it as calculator ===
<syntaxhighlight lang="lua">
/c game.player.print(1234*5678)
</syntaxhighlight>

=== Zoom beyond normal bounds ===
Note that zooming too far out can cause performance hits. Be careful.
<syntaxhighlight lang="lua">
/c game.player.zoom=0.1
</syntaxhighlight>

=== Mine faster ===
<syntaxhighlight lang="lua">
/c game.player.force.manual_mining_speed_modifier=1000
</syntaxhighlight>

=== Craft faster ===
<syntaxhighlight lang="lua">
/c game.player.force.manual_crafting_speed_modifier=1000
</syntaxhighlight>

=== Unlock and research all technologies ===
<syntaxhighlight lang="lua">
/c game.player.force.research_all_technologies()
</syntaxhighlight>

Undo this with the command in the next section.

=== Unresearch all technologies ===
This does not reset manually applied bonuses
<syntaxhighlight lang="lua">
/c for _, tech in pairs(game.player.force.technologies) do
tech.researched=false
game.player.force.set_saved_technology_progress(tech, 0)
end
</syntaxhighlight>

=== Reset your force ===
This resets all data for your force, including kill and production statistics, technologies, bonuses and charting status.
<syntaxhighlight lang="lua">
/c game.player.force.reset()
</syntaxhighlight>

=== Always show rail block visualization ===
Permanently show the rail block visualization instead of only when holding a rail signal. Disable by replacing true with false.

<syntaxhighlight lang="lua">
/c game.player.game_view_settings.show_rail_block_visualisation = true
</syntaxhighlight>

== Inventory manipulation scripts ==

=== Cheat mode ===
Allows for infinite free crafting. Disable by replacing true with false.
<syntaxhighlight lang="lua">
/c game.player.cheat_mode=true
</syntaxhighlight>

=== Refill resources (refill oil, iron etc.) ===
While holding the cursor over a resource tile in-game
<syntaxhighlight lang="lua">
/c game.player.selected.amount=7500
</syntaxhighlight>

Alternatively you can refill all resources in the map with the following command. Change ore.amount to the desired value.
<syntaxhighlight lang="lua">
/c surface = game.player.surface
for _, ore in pairs(surface.find_entities_filtered({type="resource"})) do
ore.amount = 10000
end
</syntaxhighlight>

=== Add items to the player's inventory ===
Replace iron-plate with the [[data.raw|internal name]] of the item desired.
<syntaxhighlight lang="lua">
/c game.player.insert{name="iron-plate", count=100}
</syntaxhighlight>

For instance, here's a stack of the god-mode energy system interface:
<syntaxhighlight lang="lua">
/c game.player.insert{name="electric-energy-interface"}
</syntaxhighlight>

Add a powerful armor with equipment and some tools for construction:
<syntaxhighlight lang="lua">
/c local player = game.player
player.insert{name="power-armor-mk2", count = 1}
local p_armor = player.get_inventory(5)[1].grid
p_armor.put({name = "fusion-reactor-equipment"})
p_armor.put({name = "fusion-reactor-equipment"})
p_armor.put({name = "fusion-reactor-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "energy-shield-mk2-equipment"})
p_armor.put({name = "energy-shield-mk2-equipment"})
p_armor.put({name = "personal-roboport-mk2-equipment"})
p_armor.put({name = "night-vision-equipment"})
p_armor.put({name = "battery-mk2-equipment"})
p_armor.put({name = "battery-mk2-equipment"})
player.insert{name="construction-robot", count = 25}
</syntaxhighlight>

=== Increase player inventory slots ===
Gives 100 additional bonus inventory slots to your entire force. Used by the [[Toolbelt]] research.
<syntaxhighlight lang="lua">
/c game.player.force.character_inventory_slots_bonus=100
</syntaxhighlight>

== World manipulation scripts ==

=== Reveal the map around the player ===

Reveals the map around the player, similar to a [[radar]].
<syntaxhighlight lang="lua">
/c local radius=150
game.player.force.chart(game.player.surface, {{game.player.position.x-radius, game.player.position.y-radius}, {game.player.position.x+radius, game.player.position.y+radius}})
</syntaxhighlight>
or from start position
<syntaxhighlight lang="lua">
/c local radius=150
game.player.force.chart(game.player.surface, {{x = -radius, y = -radius}, {x = radius, y = radius}})
</syntaxhighlight>
Change 150 to the desired radius, higher values take longer.

=== Hide revealed map ===

Hides all revealed chunks, inverted map revealing.
<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local force = game.player.force
for chunk in surface.get_chunks() do
force.unchart_chunk({x = chunk.x, y = chunk.y}, surface)
end
</syntaxhighlight>

=== Reveal all generated map ===

Revels all of the generated map to the player's team.
<syntaxhighlight lang="lua">
/c game.player.force.chart_all()
</syntaxhighlight>

=== Delete chunks ===
If much of the map is revealed, it increases the size of the save file. The following command cancels the generation of all chunks that are currently queued for generation and removes chunks outside a 32 chunks radius around 0,0. Note that this will remove player entities if there are any on these chunks.
<syntaxhighlight lang="lua">
/c local surface = game.player.surface;
game.player.force.cancel_charting(surface);
local chunk_radius = 32;
for chunk in surface.get_chunks() do
if (chunk.x < -chunk_radius or chunk.x > chunk_radius or chunk.y < -chunk_radius or chunk.y > chunk_radius) then
surface.delete_chunk(chunk)
end
end
</syntaxhighlight>

=== Turn off night ===
Enables eternal day.
<syntaxhighlight lang="lua">
/c game.player.surface.always_day=true
</syntaxhighlight>

=== Change game speed ===
0.5 is half speed, 1 is default, 2 is double speed, etc. Minimum is 0.01. This can be used for a lot of things like when you know you will have to wait for long periods of time for something to complete. Increasing will decrease performance, be careful.
<syntaxhighlight lang="lua">
/c game.speed=X
</syntaxhighlight>

=== Expensive (marathon) or normal mode ===
To change from normal to expensive mode preset (this changes the research cost and intermediate product cost):
<syntaxhighlight lang="lua">
/c game.difficulty_settings.recipe_difficulty=1
game.difficulty_settings.technology_difficulty=1
game.difficulty_settings.technology_price_multiplier=4
</syntaxhighlight>

To change back to normal:
<syntaxhighlight lang="lua">
/c game.difficulty_settings.recipe_difficulty=0
game.difficulty_settings.technology_difficulty=0
game.difficulty_settings.technology_price_multiplier=1
</syntaxhighlight>

=== Freeze time ===
Stops the advancement of the time if you replace "BOOL" with "true" or unfreezes it if you replace it with "false".
<syntaxhighlight lang="lua">
/c game.player.surface.freeze_daytime=BOOL
</syntaxhighlight>

=== Remove all pollution ===
<syntaxhighlight lang="lua">
/c game.player.surface.clear_pollution()
</syntaxhighlight>

=== Completely turn off pollution ===

<syntaxhighlight lang="lua">
/c for _, surface in pairs(game.surfaces) do
surface.clear_pollution()
end
game.map_settings.pollution.enabled = false
</syntaxhighlight>

=== Add a lot of pollution ===
<syntaxhighlight lang="lua">
/c game.player.surface.pollute(game.player.position, 1000000)
</syntaxhighlight>

=== Where speakers are, by who ===
<syntaxhighlight lang="lua">
/c speakers = game.player.surface.find_entities_filtered{force = game.player.force, type="programmable-speaker"}
for key, speaker in pairs(speakers) do
game.player.print(speaker.last_user.name .. " placed a speaker at X=" .. speaker.position.x .. ", Y=" .. speaker.position.y)
end
</syntaxhighlight>

=== Disable friendly fire for your force ===
<syntaxhighlight lang="lua">
/c game.player.force.friendly_fire = false
</syntaxhighlight>

=== Add new resource patch ===
This creates a new 11×11 patch of resources, centered on the player character, where the ground is not water.
The patch it creates is perfectly square but it randomizes the amount similar to natural generation, with fewer ore at the edges and more ore in the center.
The default numbers result in a patch with 2500-3000 ore.

If you want a larger patch, change "local size = 5" to a larger number.
A larger patch will have exponentially more ore.
Entering a number above 30 is not recommended.

If you want a richer patch, change "local density = 10" to a larger number.
Entering a very large number shouldn't hurt anything but you probably don't need to go above 100.

To choose which resource is spawned, change "stone" near the bottom to "iron-ore", "copper-ore", "coal", or "uranium-ore".

<syntaxhighlight lang="lua">
/c local surface=game.player.surface
local ore=nil
local size=5
local density=10
for y=-size, size do
for x=-size, size do
a=(size+1-math.abs(x))*10
b=(size+1-math.abs(y))*10
if a<b then
ore=math.random(a*density-a*(density-8), a*density+a*(density-8))
end
if b<a then
ore=math.random(b*density-b*(density-8), b*density+b*(density-8))
end
if surface.get_tile(game.player.position.x+x, game.player.position.y+y).collides_with("ground-tile") then
surface.create_entity({name="stone", amount=ore, position={game.player.position.x+x, game.player.position.y+y}})
end
end
end
</syntaxhighlight>

=== Remove resources around the player ===
Removes all resource patches from the ground in a 50 x 50 area around the player.

<syntaxhighlight lang="lua">
/c local surface=game.player.surface
local size=50
local pos=game.player.position

for _, e in pairs(surface.find_entities_filtered{area={{pos.x-size, pos.y-size},{pos.x+size, pos.y+size}}, type="resource"})
do e.destroy()
end
</syntaxhighlight>

=== Add new oil patch ===
This creates 9 crude oil patches in a 3×3 square.
<syntaxhighlight lang="lua">
/c for y=0,2 do
for x=0,2 do
game.player.surface.create_entity({name="crude-oil", amount=100000, position={game.player.position.x+x*7-7, game.player.position.y+y*7-7}})
end
end
</syntaxhighlight>

or randomly without any collision:
<syntaxhighlight lang="lua">
/c local position=nil
for i=1,9 do
position=game.player.surface.find_non_colliding_position("crude-oil", game.player.position, 0, i/2+1.5)
if position then
game.player.surface.create_entity({name="crude-oil", amount=100000, position=position})
end
end
</syntaxhighlight>

=== Create 10 fishes ===
This creates 10 fishes around of player. The player must be on the water edge.
<syntaxhighlight lang="lua">
/c local player = game.player
local surface = player.surface
for i = 1, 10 do
local position = surface.find_non_colliding_position('fish', player.position, 10, 1)
if not position then return end
surface.create_entity {name = 'fish', position = position}
end
</syntaxhighlight>

=== Count entities ===
Counts all entities whose name includes the string in local entity.
<syntaxhighlight lang="lua">
/c local entity="belt"
local surface=game.player.surface
local count=0
for key, ent in pairs(surface.find_entities_filtered({force=game.player.force})) do
if string.find(ent.name,entity) then
count=count+1
end
end
game.player.print(count)
</syntaxhighlight>

=== Emptying all pipes, underground pipes and pumps ===
Useful when pipes contain a fluid you dont want.
<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local deleted=0
for key, entity in pairs(surface.find_entities_filtered({force=game.player.force})) do
if string.find(entity.name, "pipe") or
string.find(entity.name, "pump")
then
for i=1,#entity.fluidbox do
deleted = deleted + 1
entity.fluidbox[i] = nil;
end
end
end
game.player.print("Fluids removed from "..deleted .." entities")
</syntaxhighlight>

=== Turn off cliff generation ===
Sets size to "none". Only effective on chunks that are generated after using this command. Use [[#Remove all cliffs]] to delete existing cliffs.

<syntaxhighlight lang="lua">
/c local mgs = game.player.surface.map_gen_settings
mgs.cliff_settings.cliff_elevation_0 = 1024
game.player.surface.map_gen_settings = mgs</syntaxhighlight>

=== Remove all cliffs ===
Removes all cliffs existing cliffs from the world. Use [[#Turn off cliff generation]] to turn off cliff generation in new chunks.

<syntaxhighlight lang="lua">
/c for _, v in pairs(game.player.surface.find_entities_filtered{type="cliff"}) do
v.destroy()
end</syntaxhighlight>

=== Delete all decoratives ===
Delete the decoratives that can be found in the world.

<syntaxhighlight lang="lua">
/c game.player.surface.destroy_decoratives({})</syntaxhighlight>

=== Change map generation settings ===
This allows to change the map generation settings for new chunks; it does not alter already generated chunks. [[#Delete chunks|Deleted chunks]] are affected by the setting change because they are newly generated when they get explored again.

To change resource generation settings, replace "iron-ore" with the [[Data.raw#resource|resource]] that should be changed and replace "very-high" with the desired [https://lua-api.factorio.com/latest/Concepts.html#MapGenSize MapGenSize] in the following command. Replace "iron-ore" with "enemy-base" to change the enemy base generation settings.

<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local resource = "iron-ore"
local mgs = surface.map_gen_settings
mgs.autoplace_controls[resource].size = "very-high"
mgs.autoplace_controls[resource].frequency = "very-high"
mgs.autoplace_controls[resource].richness = "very-high"
surface.map_gen_settings = mgs</syntaxhighlight>

To change water generation settings, replace "very-high" with the desired [https://lua-api.factorio.com/latest/Concepts.html#MapGenSize MapGenSize] in the following command.

<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local mgs = surface.map_gen_settings
mgs.water = "very-high" --[[ size]]
mgs.terrain_segmentation = "very-high" --[[ frequency]]
surface.map_gen_settings = mgs </syntaxhighlight>

== Enemy/evolution scripts ==

=== Set evolution factor ===
Ranges from 0 (new game) to 1.
<syntaxhighlight lang="lua">
/c game.forces["enemy"].evolution_factor=X
</syntaxhighlight>

=== Disable time-based evolution & increases pollution-based evolution ===
<syntaxhighlight lang="lua">
/c game.map_settings.enemy_evolution.time_factor=0
/c game.map_settings.enemy_evolution.pollution_factor=game.map_settings.enemy_evolution.pollution_factor*2
</syntaxhighlight>

The "2" at the end of the last command will double the default pollution factor. You can substitute another number to increase (or decrease) the pollution factor further.

=== Kill all biters on the "enemy" force ===
Note that this will kill only mobile units, spawners will not be killed.
<syntaxhighlight lang="lua">
/c game.forces["enemy"].kill_all_units()
</syntaxhighlight>

=== Kill all enemies ===
This will kill all biters, bases and worms. Anything that is an enemy will be completely destroyed. This only affects enemies in the explored world, so any unexplored parts of the map which still need to be generated will still have enemies. You can [[#Prevent biters being on newly generated chunks|prevent biters being on newly generated chunks]] if desired.
<syntaxhighlight lang="lua">
/c local surface=game.player.surface
for key, entity in pairs(surface.find_entities_filtered({force="enemy"})) do
entity.destroy()
end
</syntaxhighlight>

=== Kill all nearby enemies ===

This will kill all biters, bases and worms in a configurable radius. The default, 250 tiles, is about two zoomed-out screen widths on full HD. After destruction, it shows how many objects were destroyed.

<syntaxhighlight lang="lua">
/c local surface=game.player.surface
local pp = game.player.position
local cnt = 0
for key, entity in pairs(surface.find_entities_filtered({force="enemy", radius=250, position=pp })) do
cnt = cnt+1
entity.destroy()
end
game.player.print(cnt)
</syntaxhighlight>

=== Enable/Disable peaceful mode ===
Enabling peaceful mode prevents biter attacks until provoked. Substitute true for false to disable. Already existing biters are not affected by this command so attacks could continue for a while after activating peaceful mode.
<syntaxhighlight lang="lua">
/c game.player.surface.peaceful_mode = true
</syntaxhighlight>

=== Enable/Disable biter expansion ===
Biter expansion allows biters to create new nests, it is enabled by default. Substitute true for false to disable.
<syntaxhighlight lang="lua">
/c game.map_settings.enemy_expansion.enabled = true
</syntaxhighlight>

=== Prevent biters being on newly generated chunks ===
On newly generated chunks no biters will be present, however all current biters will remain unaffected. Equivalent of setting the Enemy Base Size to None under the Terrain settings during map generation but achieved mid game by [[#Change map generation settings|changing map generation settings]].
<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local mgs = surface.map_gen_settings
mgs.autoplace_controls["enemy-base"].size = "none"
surface.map_gen_settings = mgs
</syntaxhighlight>

== Player character scripts ==
Commands concerning the player directly.
=== Get player position ===
Prints coordinates of your current position.
<syntaxhighlight lang="lua">
/c game.player.print(game.player.position.x .. ", " .. game.player.position.y)
</syntaxhighlight>

=== Teleport player ===
Moves the player to the specified location. You should be able to teleport to a specific player if you obtain their coordinates via them executing the previous command and giving them to you.
<syntaxhighlight lang="lua">
/c game.player.teleport({X, Y})
</syntaxhighlight>

To teleport to the world's origin, use 0,0.

=== Enable god mode ===
God mode removes your player character allowing you to fly over obstacles and take no damage.

Disassociate your controls from the player:
<syntaxhighlight lang="lua">
/c game.player.character=nil
</syntaxhighlight>

Then, hover the mouse over the useless player and destroy it by typing:
<syntaxhighlight lang="lua">
/c game.player.selected.destroy()
</syntaxhighlight>

To undo, spawn a player character. This will spawn a new player at the spawn point of the world, and connect your controls to it.
<syntaxhighlight lang="lua">
/c game.player.create_character()
</syntaxhighlight>

=== Enable long reach ===
Enables long reach, which allows the player to build and interact with entities at a greater distance. The default reach is 10.
<syntaxhighlight lang="lua">
/c local reach = 10000
game.player.force.character_build_distance_bonus = reach
game.player.force.character_reach_distance_bonus = reach
</syntaxhighlight>

== Research scripts ==

=== Enable Research Queue ===
Enable the research queue for the players current team. Can be done after the game has started if it was forgotten during the map's setup.
<syntaxhighlight lang="lua">
/c game.player.force.research_queue_enabled = true
</syntaxhighlight>

=== Enable faster research ===
<syntaxhighlight lang="lua">
/c game.player.force.laboratory_speed_modifier=1
</syntaxhighlight>
1 is normal speed, 2 is double speed 3 is triple etc.

=== Research specific technologies ===
The internal technology names can be found in the infoboxes on their respective pages.
<syntaxhighlight lang="lua">
/c game.player.force.technologies['electric-energy-distribution-1'].researched=true
/c game.player.force.technologies['steel-processing'].researched=true
</syntaxhighlight>

=== Unresearch specific technologies ===
The internal technology names can be found in the infoboxes on their respective pages.
<syntaxhighlight lang="lua">
/c game.player.force.technologies['electric-energy-distribution-1'].researched=false; game.player.force.set_saved_technology_progress('electric-energy-distribution-1', 0)
/c game.player.force.technologies['steel-processing'].researched=false; game.player.force.set_saved_technology_progress('steel-processing', 0)
</syntaxhighlight>

=== Enabling specific recipes ===
The internal recipe/item names can be found in the infoboxes on their respective pages.
<syntaxhighlight lang="lua">
/c game.player.force.recipes["electric-energy-interface"].enabled=true
/c game.player.force.recipes["rocket-silo"].enabled=true
/c game.player.force.recipes.loader.enabled=true
/c game.player.force.recipes["fast-loader"].enabled = true
/c game.player.force.recipes["express-loader"].enabled = true
</syntaxhighlight>

=== Enable all recipes ===
<syntaxhighlight lang="lua">
/c for name, recipe in pairs(game.player.force.recipes) do recipe.enabled = true end
</syntaxhighlight>

== Modding tools ==
A list of the internal names of most things in the vanilla game can also be found on [[data.raw]].

=== Access a mod's data ===
If the first word of the command is __mod-name__ it will run in the context of the mod with the same name. For instance, this command prints the data from Resource Spawner Overhaul:
<syntaxhighlight lang="lua">
/c __rso-mod__ game.player.print(serpent.dump(global))
</syntaxhighlight>

=== Print to console which tile are you have under the player position ===
<syntaxhighlight lang="lua">
/c game.player.print(game.player.surface.get_tile(game.player.position).name)
</syntaxhighlight>

=== Write all researched technologies to file ===
<syntaxhighlight lang="lua">
/c local list = {}
for _, tech in pairs(game.player.force.technologies) do
if tech.researched then
list[#list+1] = tech.name
end
end
game.write_file("techs.lua", serpent.block(list) .. "\n", true)
</syntaxhighlight>

=== Write all enabled recipes to file ===
<syntaxhighlight lang="lua">
/c local list = {}
for _, recipe in pairs(game.player.force.recipes) do
if recipe.enabled then
list[#list+1] = recipe.name
end
end
game.write_file("recipes.lua", serpent.block(list) .. "\n", true)
</syntaxhighlight>

=== Write mod list to file ===
Write all currently active mods and their version to the file script-output/mods.txt in the [[user data directory]].

<syntaxhighlight lang="lua">
/c game.write_file("mods.txt", serpent.block(game.active_mods))
</syntaxhighlight>

== See also ==

* [[Command line parameters]]
* http://lua-api.factorio.com/latest/ - Factorio API reference for latest version

Tutorial:Modding tutorial

2020-06-04T06:54:22Z

Bitbyte: add link to scenario system in additional info (should this also be included on modding?)

These tutorials range from teaching the first steps of modding to in-depth explanations of individual mechanics:

* [[Tutorial:Modding tutorial/Gangsir|Modding tutorial/Gangsir]] — A simple modding tutorial that suits beginners well.
* [[Tutorial:Mod structure|Mod structure]] — More details on how mods need to be structured in order to be loaded by the game.
* [[Tutorial:Scripting|Scripting]] — A small tutorial that focuses on run-time scripting and provides some info on how to use the story script.
* [[Tutorial:Mod settings|Mod settings]] — A comprehensive tutorial about how to create and use mod settings.
* [[Tutorial:Localisation|Localisation]] — A tutorial about how to format and use localisation, which is how mods are translated.
* [[Tutorial:Script interfaces|Script interfaces]] — A small tutorial about script interfaces ([http://lua-api.factorio.com/latest/LuaRemote.html LuaRemote]) and custom keyboard shortcuts.

=== Additional info ===
* [[Tutorial:Modding FAQ|Modding FAQ]]
* [[Prototype definitions|Prototype documentation]]
* [[Scenario system]] — A save-based mod which can control map generation and gameplay
* [http://lua-api.factorio.com/latest/ Factorio API Documentation] — Documentation of the runtime api
* [https://lua-api.factorio.com/latest/Migrations.html Migrations guide] — All information about mod migrations
* [https://github.com/wube/factorio-data Factorio data github repository] — Tracks changes of the lua prototype definitions in factorio in between releases.
<noinclude>
== See also ==
* [[Tutorials]]
* [[Modding]]
* [[:Category:Technical]] — Documentation of technical formats and API's not related to modding</noinclude>

Infobox:Express splitter

2019-02-27T23:18:04Z

Bitbyte: Updated belt speed to match express transport belt

{{Infobox
|mining-time = 0.1
|map-color = f8d000
|prototype-type = splitter
|internal-name = express-splitter
|expensive-total-raw = Time, 202 + Copper plate, 215 + Iron plate, 165 + Lubricant, 80 + Plastic bar, 40
|total-raw = Time, 130.75 + Copper plate, 72.5 + Iron plate, 86 + Lubricant, 80 + Plastic bar, 20
|category = Logistics
|image = express_splitter_entity
|health = 190
|belt-speed = 45 Items/s
|stack-size=50
|dimensions=1x2
|recipe = Time, 2 + Advanced circuit, 10 + Fast splitter, 1 + Iron gear wheel, 10 + Lubricant, 80
|required-technologies = Logistics 3
|producers = Assembling machine 2 + Assembling machine 3
}}<noinclude>[[Category:Infobox page]]</noinclude>

Infobox:Fast splitter

2019-02-27T23:17:37Z

Bitbyte: Updated belt speed to match fast transport belt

{{Infobox
|mining-time = 0.1
|map-color = f8d000
|prototype-type = splitter
|internal-name = fast-splitter
|expensive-total-raw = Time, 55 + Copper plate, 75 + Iron plate, 85
|category = Logistics
|image = fast_splitter_entity
|health = 180
|stack-size=50
|dimensions=1×2
|belt-speed = 30 Items/s
|recipe = Time, 2 + Electronic circuit, 10 + Iron gear wheel, 10 + Splitter, 1
|total-raw = Time, 28.75 + Copper plate, 22.5 + Iron plate, 46
|required-technologies = Logistics 2
|producers=Manual + Assembling machine 2 + Assembling machine 3
|consumers = Express splitter
}}<noinclude>[[Category:Infobox page]]</noinclude>

Infobox:Splitter

2019-02-27T23:17:04Z

Bitbyte: Updated belt speed to match transport belt

{{Infobox
|mining-time = 0.1
|map-color = f8d000
|prototype-type = splitter
|internal-name = splitter
|expensive-total-raw = Time, 18 + Copper plate, 25 + Iron plate, 25
|category = Logistics
|image = splitter_entity
|health = 170
|stack-size=50
|dimensions=1x2
|belt-speed = 15 Items/s
|recipe = Time, 1 + Electronic circuit, 5 + Iron plate, 5 + Transport belt, 4
|total-raw = Time, 9.25 + Copper plate, 7.5 + Iron plate, 16
|required-technologies=Logistics
|producers=Manual + Assembling machine 2 + Assembling machine 3
|consumers = Fast splitter
}}<noinclude>[[Category:Infobox page]]</noinclude>

Express splitter

2019-02-27T21:10:06Z

Bitbyte: Updated version history

{{Languages}}{{:Infobox:Express splitter}}
'''Express splitters''' are the fastest type of [[splitters]]. They are three times as fast as [[splitter|normal splitters]] and 50% faster than [[fast splitter]]s. The items are placed in 1:1 relation on the outgoing belts. It is possible to set a filter and input and output priorities as described on [[Belt_transport_system#Splitters|belt transport system]].

=== Other express belts ===
{|
| {{Imagelink|Express transport belt}} || {{Imagelink|Express underground belt}}
|}

=== Other [[Splitters]] ===
{|
| {{Imagelink|Splitter}} || {{Imagelink|Fast splitter}}
|}

== Gallery ==
[[File:Express splitter gui.png]]

== History ==
{{history|0.17.0|
* Match [[express transport belt]] speed of 30 items/per second.}}

{{history|0.16.17|
* Added filter to splitter.
* Added input and output priority to splitter.}}

{{history|0.16.16|
* Changed splitters so they work more intuitively. The left and right lane splitting is now completely independent. The decision whether item goes to left or right output is now independent of the item type.}}

{{history|0.11.0|
* Fast/express splitters are now made from their lesser variants.}}

{{history|0.5.0|
* Introduced
* New graphics.}}

== See also ==
* [[Belt transport system]]
** [[Transport belts]]
** [[Underground belts]]
** [[Inserters]]
* [[Crafting]]

{{LogisticsNav}}
{{C|Belt transport system}}

Fast splitter

2019-02-27T21:09:00Z

Bitbyte: Updated version history

{{Languages}}{{:Infobox:Fast splitter}}
'''Fast splitters''' are [[splitters]] which are twice as fast as [[splitter|normal splitters]], but only 67% as fast as [[express splitter]]s. The items are placed in 1:1 relation on the outgoing belts. It is possible to set a filter and input and output priorities as described on [[Belt_transport_system#Splitters|belt transport system]].

=== Other fast belts ===
{|
| {{Imagelink|Fast transport belt}} || {{Imagelink|Fast underground belt}}
|}

=== Other [[Splitters]] ===
{|
| {{Imagelink|Splitter}} || {{Imagelink|Express splitter}}
|}

== Gallery ==
[[File:Fast splitter gui.png]]

== History ==
{{history|0.17.0|
* Match [[fast transport belt]] speed of 30 items/per second.}}

{{history|0.16.17|
* Added filter to splitter.
* Added input and output priority to splitter.}}

{{history|0.16.16|
* Changed splitters so they work more intuitively. The left and right lane splitting is now completely independent. The decision whether item goes to left or right output is now independent of the item type.}}

{{history|0.11.0|
* Fast/express splitters are now made from their lesser variants.}}

{{history|0.5.0|
* Introduced
* New graphics.}}

== See also ==
* [[Belt transport system]]
** [[Transport belts]]
** [[Underground belts]]
** [[Inserters]]
* [[Crafting]]

{{LogisticsNav}}
{{C|Belt transport system}}

Splitter

2019-02-27T21:07:30Z

Bitbyte: Updated version history

{{Languages}}{{:Infobox:Splitter}}
The '''splitter''' is used to divide a single belt, combine two belts into one, or equally balance two belts together. The items are placed in 1:1 relation on the outgoing belts. It is possible to set a filter and input and output priorities as described on [[Belt_transport_system#Splitters|belt transport system]].

=== Other basic belts ===
{|
| {{Imagelink|Transport belt}} || {{Imagelink|Underground belt}}
|}

=== Other [[Splitters]] ===
{|
| {{Imagelink|Fast splitter}} || {{Imagelink|Express splitter}}
|}

== Gallery ==
[[File:Splitter gui.png]]

== History ==
{{history|0.17.0|
* Match transport belt speed of 15 items/per second}}

{{history|0.16.17|
* Added filter to splitter.
* Added input and output priority to splitter.}}

{{history|0.16.16|
* Changed splitters so they work more intuitively. The left and right lane splitting is now completely independent. The decision whether item goes to left or right output is now independent of the item type.}}

{{history|0.13.0|
* Renamed "basic splitter" to "splitter".}}

{{history|0.11.0|
* Fast/express splitters are now made from their lesser variants.}}

{{history|0.5.0|
* Added fast and express splitters
* New graphics.}}

{{history|0.4.1|
* Draw ending/starting pieces of underground belt and splitter.}}

{{history|0.3.0|
* Splitter now has a maximum memory of 5 items when forced to send items on one side because the other one is blocked.}}

{{history|0.2.9|
* Introduced}}

== See also ==
* [[Belt transport system]]
** [[Transport belts]]
** [[Underground belts]]
** [[Inserters]]

{{LogisticsNav}}
{{C|Belt transport system}}

Infobox:Express underground belt

2019-02-27T21:03:44Z

Bitbyte: Updated belt speed to match express transport belt

{{Infobox
|mining-time = 0.1
|map-color = 887000
|prototype-type = underground-belt
|internal-name = express-underground-belt
|expensive-total-raw = Time, 67.5 + Iron plate, 502.5 + Lubricant, 40
|total-raw = Time, 67.5 + Iron plate, 257.5 + Lubricant, 40
|recipe = Time, 2 + Fast underground belt, 2 + Iron gear wheel, 80 + Lubricant, 40 = Express underground belt, 2
|category = Logistics
|image = express_underground_belt_entity
|stack-size=50
|health = 170
|dimensions=1x1
|belt-speed = 45 Items/s
|required-technologies = Logistics 3
|producers= Assembling machine 2 + Assembling machine 3
}}<noinclude>[[Category:Infobox page]]</noinclude>

Infobox:Fast underground belt

2019-02-27T21:02:50Z

Bitbyte: Updated belt speed to match fast transport belt

{{Infobox
|mining-time = 0.1
|map-color = 887000
|prototype-type = underground-belt
|internal-name = fast-underground-belt
|expensive-total-raw = Time, 25.5 + Iron plate, 182.5
|recipe = Time, 2 + Iron gear wheel, 40 + Underground belt, 2 = Fast underground belt, 2
|category = Logistics
|image = fast_underground_belt_entity
|health = 160
|dimensions=1x1
|stack-size=50
|belt-speed = 30 Items/s
|total-raw = Time, 25.5 + Iron plate, 97.5
|required-technologies = Logistics 2
|producers=Manual + Assembling machine
|consumers = Express underground belt
}}<noinclude>[[Category:Infobox page]]</noinclude>

Infobox:Underground belt

2019-02-27T20:57:19Z

Bitbyte: Updated belt speed to match transport belt

{{Infobox
|mining-time = 0.1
|map-color = 887000
|prototype-type = underground-belt
|internal-name = underground-belt
|expensive-total-raw = Time, 3.5 + Iron plate, 22.5
|recipe = Time, 1 + Iron plate, 10 + Transport belt, 5 = Underground belt, 2
|category = Logistics
|image = Underground belt entity
|health = 150
|stack-size=50
|dimensions=1x1
|belt-speed = 15 Items/s
|total-raw = Time, 3.5 + Iron plate, 17.5
|required-technologies=Logistics
|producers=Manual + Assembling machine
|consumers = Fast underground belt
}}<noinclude>[[Category:Infobox page]]</noinclude>

Express transport belt

2019-02-27T20:53:30Z

Bitbyte: Updated the belt density to 8 items and removed duplicate links.

{{Languages}}{{:Infobox:Express transport belt}}
'''Express transport belts''' are a faster variant of the [[transport belt]], operating at triple speed. They are the third and final tier among the [[Belt transport system|transport belts]].

Unlike previous tiers, express transport belts rely on [[oil processing]] for [[lubricant]]. Therefore, it is recommended to restrict their production in early-game until high throughput is needed.

== Properties ==

[[File:Express_transport_belt_fulldensity.gif|right|300px|thumb| 9 [[Fast inserter]] per side will fill an express belt to max. density.]]

{| class="wikitable"
|-
! scope="col" | Type
! scope="col" | Max. throughput (Items per [[game-second]])1
! scope="col" | Speed ([[Tile|Tiles]] per game-second)1
! scope="col" | Max. density (Items per tile)1
! scope="col" | Required [[Research|technologies]]
|-
| {{Imagelink|Express transport belt|Express transport belt}} || 45.0 || 5.625 || 8 || [[Logistics 3 (research)]]
|}

(1) See [[Transport belts/Physics|Physics of Transport Belts]] for more detailed information.

== History ==

{{history|0.17.0|
* Increased throughput from 40 to 45.
* Updated the belt density to 8 items and removed duplicate links.}}

{{history|0.15.0|
* Increased stack size from 50 to 100.}}

{{history|0.13.0|
* Transport belt is now connectible to the [[circuit network]].
* Transport belt connectible entities will now disconnect from incoming belts when marked for deconstruction.}}

{{history|0.12.0|
* Items on transport belts don't go off the belt at the end, so the transport belt has to go directly in front of the required inserter.
* Optimised the transport belt movement.}}

{{history|0.11.9|
* Items marked for deconstruction cannot be moved by belts anymore.
* Reduced the CPU load caused by big counts of [[inserters]] loading/unloading transport belts.}}

{{history|0.11.0|
* Fast/express belts are now made from the slower variants.}}

{{history|0.9.7|
* Belts to be deconstructed no longer accept items. }}

{{history|0.9.6|
* New transport belt graphics. }}

{{history|0.9.0|
* Small optimisation. }}

{{history|0.7.1|
* [[Express transport belt]] now takes 10 [[Iron gear wheel]]s to craft, down from 15. }}

{{history|0.6.0|
* Transport belt doesn't pull player out of the edge of it (like items), so player won't be almost trapped on faster transport belts. }}

{{history|0.5.0|
* Better movement on transport belts in turns and crossings. }}

{{history|0.2.8|
* Cross connections of transport belt of the same type are disabled. }}

{{history|0.2.2|
* When transport belts are rotated (or replaced with different than opposite direction), items on transport belt are collected.}}

{{history|0.2.1|
* Small optimisation. }}

{{history|0.1.0|
* Introduced}}

== See also ==
* [[Belt transport system]]
** [[Splitters]]
** [[Inserters]]
* [[Crafting]]

{{LogisticsNav}}
{{C|Belt transport system}}

Fast transport belt

2019-02-27T20:49:26Z

Bitbyte: Updated the belt density to 8 items and removed duplicate links.

{{Languages}}
{{:Infobox:Fast transport belt}}

'''Fast transport belts''' are a faster variant of the [[transport belt]], operating at double speed. They are the second tier among the three [[Belt transport system|transport belts]].

==Properties==

[[File:Fast_transport_belt_fulldensity.gif|right|300px|thumb|6 [[Fast inserter]]s per side will fill a fast transport belt to max. density]]

{| class="wikitable"
|-
! scope="col" | Type
! scope="col" | Max. throughput (Items per [[game-second]])1
! scope="col" | Speed ([[Tile|Tiles]] per game-second)1
! scope="col" | Max. density (Items per tile)1
! scope="col" | Required [[Research|technologies]]
|-
| {{Imagelink|Fast transport belt|Fast transport belt}} || 30 || 3.75 || 8 || [[Logistics 2 (research)]]
|}

(1) See [[Transport belts/Physics|Physics of Transport Belts]] for more detailed information.

== History ==

{{history|0.17.0|
* Increased throughput to 30 items/second.
* Consistently holds 8 items per tile.}}

{{history|0.15.0|
* Increased stack size from 50 to 100.}}

{{history|0.13.0|
* Transport belt is now connectible to the [[circuit network]].
* Transport belt connectible entities will now disconnect from incoming belts when marked for deconstruction.}}

{{history|0.12.0|
* Items on transport belts don't go off the belt at the end, so the transport belt has to go directly in front of the required inserter.
* Optimised the transport belt movement.}}

{{history|0.11.9|
* Items marked for deconstruction cannot be moved by belts anymore.
* Reduced the CPU load caused by big counts of [[inserters]] loading/unloading transport belts.}}

{{history|0.11.0|
* Fast/express belts are now made from the slower variants.}}

{{history|0.9.7|
* Belts to be deconstructed no longer accept items. }}

{{history|0.9.6|
* New transport belt graphics. }}

{{history|0.9.0|
* Small optimisation. }}

{{history|0.6.0|
* Transport belt doesn't pull player out of the edge of it (like items), so player won't be almost trapped on faster transport belts. }}

{{history|0.5.0|
* Better movement on transport belts in turns and crossings. }}

{{history|0.2.8|
* Cross connections of transport belt of the same type are disabled. }}

{{history|0.2.2|
* When transport belts are rotated (or replaced with different than opposite direction), items on transport belt are collected.}}

{{history|0.2.1|
* Small optimisation. }}

{{history|0.1.0|
* Introduced}}

== See also ==
* [[Belt transport system]]
** [[Splitters]]
** [[Inserters]]
* [[Crafting]]

{{LogisticsNav}}
{{C|Belt transport system}}

Transport belt

2019-02-27T20:42:38Z

Bitbyte: Updated the belt density to 8 items and removed duplicate links

{{Languages}}{{:Infobox:Transport belt}}
The '''transport belt''' is the easiest and cheapest method of automatic item transportation. It is the first tier among the three [[belt transport system|transport belts]].

No prior [[research]] is required and it is available from the beginning of the game.

==Properties==

[[File:Basic_transport_belt_fulldensity.gif|right|400px|thumb|3 [[fast inserter]]s per side will fill a basic transport belt to maximum density.]]

{| class="wikitable"
|-
! scope="col" | Type
! scope="col" | Max. throughput (items per [[game-second]] for two lanes)1
! scope="col" | Speed ([[tile]]s per game-second)1
! scope="col" | Max. density (items per tile)1
! scope="col" | Required [[research|technologies]]
|-
| {{Imagelink|Transport belt|Transport belt}} || 15 || 1.875 || 8 || None
|}

(1) See [[transport belts/Physics|physics of transport belts]] for more detailed information.

== History ==

{{history|0.17.0|
* Increased throughput from 12.33 to 15.
* Consistently holds 8 items per tile.}}

{{history|0.15.0|
* Increased stack size from 50 to 100.}}

{{history|0.13.0|
* Transport belt is now connectible to the [[circuit network]].
* Transport belt connectible entities will now disconnect from incoming belts when marked for deconstruction.}}

{{history|0.12.0|
* Items on transport belts don't go off the belt at the end, so the transport belt has to go directly in front of the required inserter.
* Optimised the transport belt movement.}}

{{history|0.11.9|
* Items marked for deconstruction cannot be moved by belts anymore.
* Reduced the CPU load caused by big counts of [[inserters]] loading/unloading transport belts.}}

{{history|0.9.7|
* Belts to be deconstructed no longer accept items. }}

{{history|0.9.6|
* New transport belt graphics. }}

{{history|0.9.0|
* Small optimisation. }}

{{history|0.6.0|
* Transport belt doesn't pull player out of the edge of it (like items), so player won't be almost trapped on faster transport belts. }}

{{history|0.5.0|
* Better movement on transport belts in turns and crossings. }}

{{history|0.2.8|
* Cross connections of transport belt of the same type are disabled. }}

{{history|0.2.2|
* When transport belts are rotated (or replaced with different than opposite direction), items on transport belt are collected.}}

{{history|0.2.1|
* Small optimisation. }}

{{history|0.1.0|
* Introduced}}

== See also ==

* [[Belt transport system]]
* [[Fast transport belt]]
** [[Fast splitter]]
* [[Express transport belt]]
** [[Express splitter]]

{{LogisticsNav}}
{{C|Belt transport system}}