Prototype/RollingStock: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎connection_distance: add description)
(Removed old prototype docs)
 
(17 intermediate revisions by 5 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/RollingStockPrototype.html https://lua-api.factorio.com/latest/prototypes/RollingStockPrototype.html]
This type is abstract and cannot be created directly.


The abstract base of all rolling stock. Extends [[Prototype/Vehicle]].
</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/ArtilleryWagon]] '''artillery-wagon'''
* [[Prototype/CargoWagon]] '''cargo-wagon'''
* [[Prototype/FluidWagon]] '''fluid-wagon'''
* [[Prototype/Locomotive]] '''locomotive'''
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Vehicle]].
 
=== max_speed ===
'''Type''': [[Types/double]]
 
=== air_resistance ===
'''Type''': [[Types/double]]
 
=== joint_distance ===
'''Type''': [[Types/double]]
 
Maximum joint distance is 15.
 
Note: There needs to be border at least 0.2 between the bounding box edge and joint.
 
=== connection_distance ===
'''Type''': [[Types/double]]
The distance this rolling stock and another rolling stock will snap to when placing near one another.
 
=== rail_category ===
'''Type''': [[Types/string]]
 
The rail category this rolling stock can drive on. Must be "regular" because it is not possible to create other rail categories.
 
=== pictures ===
'''Type''': [[Types/RotatedSprite]]
 
=== wheels ===
'''Type''': [[Types/RotatedSprite]]
 
=== vertical_selection_shift ===
'''Type''': [[Types/double]]
 
== Optional properties ==
 
=== drive_over_tie_trigger ===
'''Type''': [[Types/TriggerEffect]]
 
Usually a sound to play when the rolling stock drives over a tie.
 
=== tie_distance ===
'''Type''': [[Types/double]]
 
'''Default''': 10.0
 
=== back_light ===
'''Type''': [[Types/LightDefinition]]
 
=== stand_by_light ===
'''Type''': [[Types/LightDefinition]]
 
=== horizontal_doors ===
'''Type''': [[Types/Animation]]
 
=== vertical_doors ===
'''Type''': [[Types/Animation]]
 
=== color ===
'''Type''': [[Types/Color]]
 
=== allow_manual_color ===
'''Type''': [[Types/bool]]
 
'''Default''': true

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