Prototype/TransportBeltConnectable: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Further clarify the speed value and how the value is derived)
(Removed old prototype docs)
 
(13 intermediate revisions by 4 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/TransportBeltConnectablePrototype.html https://lua-api.factorio.com/latest/prototypes/TransportBeltConnectablePrototype.html]
This type is abstract and cannot be created directly.


Abstract class that anything that is a belt or can connect to belts uses. Extends [[Prototype/EntityWithHealth]].
</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>
 
== Extensions ==
 
* [[Prototype/Loader]] '''loader'''
* [[Prototype/Splitter]] '''splitter'''
* [[Prototype/TransportBelt]] '''transport-belt'''
* [[Prototype/UndergroundBelt]] '''underground-belt'''
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
 
=== speed ===
'''Type''': [[Types/double]]
 
The speed of the belt (since 0.17): <code>speed × 480 = x Items/second</code>
 
The raw value is expressed as the number of tiles traveled by each item on the belt per tick, relative to the belt's maximum density - e.g. <code>x items/second ÷ (4 items/lane × 2 lanes/belt × 60 ticks/second) = <speed> belts/tick</code> where a "belt" is the size of one tile. See [[Transport_belts/Physics]] for more details.
 
== Optional properties ==
 
=== animation_speed_coefficient ===
'''Type''': [[Types/double]]
 
'''Default''': 1
 
=== belt_animation_set ===
'''Type''': [[Types/table]]
 
Either this, or all of the properties below this one have to present.
 
Table with the following properties:
 
* animation_set - [[Types/RotatedAnimation]] - Mandatory.
* east_index - [[Types/uint8]] - Optional. - Default: 1
* west_index - [[Types/uint8]] - Optional. - Default: 2
* north_index - [[Types/uint8]] - Optional. - Default: 3
* south_index - [[Types/uint8]] - Optional. - Default: 4
* starting_south_index - [[Types/uint8]] - Optional. - Default: 13
* ending_south_index - [[Types/uint8]] - Optional. - Default: 14
* starting_west_index - [[Types/uint8]] - Optional. - Default: 15
* ending_west_index - [[Types/uint8]] - Optional. - Default: 16
* starting_north_index - [[Types/uint8]] - Optional. - Default: 17
* ending_north_index - [[Types/uint8]] - Optional. - Default: 18
* starting_east_index - [[Types/uint8]] - Optional. - Default: 19
* ending_east_index - [[Types/uint8]] - Optional. - Default: 20
* ending_patch - [[Types/Sprite4Way]] - Optional.
* ends_with_stopper - [[Types/bool]] - Optional. - Default: false
 
=== belt_horizontal ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== belt_vertical ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== ending_top ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== ending_bottom ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== ending_side ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== starting_top ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== starting_bottom ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== starting_side ===
'''Type''': [[Types/Animation]]
 
Mandatory if <code>belt_animation_set</code> is not present.
 
=== ending_patch ===
'''Type''': [[Types/Sprite4Way]]
 
Always optional. Only read if <code>belt_animation_set</code> is not present.
 
=== ends_with_stopper ===
'''Type''': [[Types/bool]]
 
'''Default''': false

Latest revision as of 14:33, 25 October 2024

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/TransportBeltConnectablePrototype.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.