Prototype/RailSignalBase: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(Removed old prototype docs)
 
Line 2: Line 2:


</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>
</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/EntityWithOwner}}
The abstract base entity for both rail signals.
{{Prototype TOC|''abstract''}}
== Extensions ==
* [[Prototype/RailChainSignal]] '''rail-chain-signal'''
* [[Prototype/RailSignal]] '''rail-signal'''
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
{{Prototype property|animation|[[Types/RotatedAnimation|RotatedAnimation]]}}
== Optional properties ==
{{Prototype property|rail_piece|[[Types/Animation|Animation]]|optional=true}}
{{Prototype property|green_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
{{Prototype property|orange_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
{{Prototype property|red_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
{{Prototype property|default_red_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
{{Prototype property|default_orange_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
{{Prototype property|default_green_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.
{{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_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.
== Mandatory values ==
The [[Prototype/Entity#collision_box|collision_box]] of rail signals is hardcoded to {{-0.2, -0.2}, {0.2, 0.2}}.
Rail signals have additional requirements for the properties inherited from [[Prototype/Entity]]:
* The [[Types/EntityPrototypeFlags#.22placeable-off-grid.22|"placeable-off-grid"]] flag will be ignored.
* Rail signals must collide with each other, can be achieved by having the [[Types/CollisionMask#Layers|"rail-layer"]] collision mask layer on all rail signals.

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