Prototype/TransportBelt: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Basics ==
<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/prototypes/TransportBeltPrototype.html https://lua-api.factorio.com/latest/prototypes/TransportBeltPrototype.html]
A [[transport belt]]. Extends [[Prototype/TransportBeltConnectable]].
 
</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>
 
 
 
{{Prototype parent|Prototype/TransportBeltConnectable}}
A [[transport belt]].
 
{{Prototype TOC|transport-belt}}


== Mandatory properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/TransportBeltConnectable]].
This prototype inherits all the properties from [[Prototype/TransportBeltConnectable]].


=== animations ===
{{Prototype property|connector_frame_sprites|[[Types/TransportBeltConnectorFrame|TransportBeltConnectorFrame]]}}
'''Type''': [[Types/RotatedAnimation]]


Transport belts must have 12 animations.
== Optional properties ==


=== connector_frame_sprites ===
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
'''Type''': [[Types/TransportBeltConnectorFrame]]
The maximum circuit wire distance for this entity.


== Optional properties ==
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|circuit_wire_connection_point|Array of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Defines how wires visually connect to this transport belt.


=== circuit_wire_max_distance ===
{{Prototype property|circuit_connector_sprites|Array of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
'''Type''': [[Types/double]]
The pictures displayed for circuit connections to this transport belt.


'''Default''': 0
{{Prototype property|belt_animation_set|[[Types/table|table]]|optional=true}}
Either this, or <code>animations</code> has to present.


=== circuit_wire_connection_point ===
This is the same table as the one used by [[Prototype/TransportBeltConnectable]], with additional properties. If this is present, the belt_animation_set will used for all graphics.
'''Type''': Array of [[Types/WireConnectionPoint]]


Defines how wires visually connect to this transport belt.
Table with the following additional optional properties:
* east_to_north_index - [[Types/uint8|uint8]] - Default: 5
* north_to_east_index - [[Types/uint8|uint8]] - Default: 6
* west_to_north_index - [[Types/uint8|uint8]] - Default: 7
* north_to_west_index - [[Types/uint8|uint8]] - Default: 8
* south_to_east_index - [[Types/uint8|uint8]] - Default: 9
* east_to_south_index - [[Types/uint8|uint8]] - Default: 10
* south_to_west_index - [[Types/uint8|uint8]] - Default: 11
* west_to_south_index - [[Types/uint8|uint8]] - Default: 12


=== circuit_connector_sprites ===
{{Prototype property|animations|[[Types/RotatedAnimation|RotatedAnimation]]|optional=true}}
'''Type''': Array of [[Types/CircuitConnectorSprites]]
Transport belts must have 12 animations. Mandatory if <code>belt_animation_set</code> is not present.


The pictures displayed for circuit connections to this transport belt.
{{Prototype property|related_underground_belt|[[Types/string|string]]|optional=true}}
The name of the [[Prototype/UndergroundBelt]] which is used in quick-replace fashion when the smart belt dragging behavior is triggered.

Revision as of 10:43, 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/prototypes/TransportBeltPrototype.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.


Template:Prototype parent A transport belt.

Template:Prototype TOC

Mandatory properties

This prototype inherits all the properties from Prototype/TransportBeltConnectable.

Template:Prototype property

Optional properties

Template:Prototype property The maximum circuit wire distance for this entity.

Template:Prototype property

Template:Prototype property

Template:Prototype property Defines how wires visually connect to this transport belt.

Template:Prototype property The pictures displayed for circuit connections to this transport belt.

Template:Prototype property Either this, or animations has to present.

This is the same table as the one used by Prototype/TransportBeltConnectable, with additional properties. If this is present, the belt_animation_set will used for all graphics.

Table with the following additional optional properties:

  • east_to_north_index - uint8 - Default: 5
  • north_to_east_index - uint8 - Default: 6
  • west_to_north_index - uint8 - Default: 7
  • north_to_west_index - uint8 - Default: 8
  • south_to_east_index - uint8 - Default: 9
  • east_to_south_index - uint8 - Default: 10
  • south_to_west_index - uint8 - Default: 11
  • west_to_south_index - uint8 - Default: 12

Template:Prototype property Transport belts must have 12 animations. Mandatory if belt_animation_set is not present.

Template:Prototype property The name of the Prototype/UndergroundBelt which is used in quick-replace fashion when the smart belt dragging behavior is triggered.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/TransportBelt&oldid=193944"