Types/PipeConnectionDefinition: Difference between revisions
(→Mandatory properties: reformatting) |
(Updated styling of prototype doc migration note) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
== | <div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/PipeConnectionDefinition.html https://lua-api.factorio.com/latest/types/PipeConnectionDefinition.html] | ||
Definition of a pipe connection. Used | |||
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
Definition of a pipe connection. Used by [[Types/FluidBox]]. | |||
== Mandatory properties == | == Mandatory properties == | ||
| Line 7: | Line 12: | ||
=== position === | === position === | ||
'''Type''': [[Types/vector]] | '''Type''': [[Types/vector]] | ||
Where pipes can connect to this fluidbox regardless the directions of entity. | |||
=== positions === | === positions === | ||
'''Type''': [[Types/table]] of [[Types/vector]] | '''Type''': [[Types/table]] of [[Types/vector]] | ||
Table must have 4 members, which are 4 explicit positions | Where pipes can connect to this fluidbox, depending on the entity direction. | ||
Table must have 4 members, which are 4 explicit positions corresponding to the 4 directions of entity. Positions must correspond to directions going one after another. | |||
== Optional properties == | == Optional properties == | ||
Latest revision as of 10:42, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/PipeConnectionDefinition.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Definition of a pipe connection. Used by Types/FluidBox.
Mandatory properties
Either position or positions must be specified. (position takes priority)
position
Type: Types/vector
Where pipes can connect to this fluidbox regardless the directions of entity.
positions
Type: Types/table of Types/vector
Where pipes can connect to this fluidbox, depending on the entity direction.
Table must have 4 members, which are 4 explicit positions corresponding to the 4 directions of entity. Positions must correspond to directions going one after another.
Optional properties
max_underground_distance
Type: Types/uint32
Default: 0
0 means not underground.
type
Type: Types/string
Default: "input-output"
Possible values:
- "input"
- "input-output"
- "output"