Prototype/ElectricPole: Difference between revisions
(Set prototype parent) |
(Updated styling of prototype doc migration note) |
||
| (8 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/prototypes/ElectricPolePrototype.html https://lua-api.factorio.com/latest/prototypes/ElectricPolePrototype.html] | |||
</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> | |||
An electric pole - part of the [[electric system]]. | |||
{{Prototype parent|Prototype/EntityWithOwner}} | |||
An electric pole - part of the [[electric system]]. | |||
{{Prototype TOC|electric-pole}} | |||
== Mandatory properties == | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/ | This prototype inherits all the properties from [[Prototype/EntityWithOwner]]. | ||
{{Prototype property|pictures|[[Types/RotatedSprite|RotatedSprite]]}} | |||
{{Prototype property|supply_area_distance|[[Types/double|double]]}} | |||
The "radius" of this pole's supply area. Corresponds to ''half'' of the "supply area" in the item tooltip. If this is 3.5, the pole will have a 7X7 supply area. | The "radius" of this pole's supply area. Corresponds to ''half'' of the "supply area" in the item tooltip. If this is 3.5, the pole will have a 7X7 supply area. | ||
Max value is 64. | Max value is 64. | ||
{{Prototype property|connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]}} | |||
== Optional properties == | == Optional properties == | ||
{{Prototype property|radius_visualisation_picture|[[Types/Sprite|Sprite]]|optional=true}} | |||
{{Prototype property|active_picture|[[Types/Sprite|Sprite]]|optional=true}} | |||
Drawn above the <code>pictures</code> when the electric pole is connected to an electric network. | |||
{{Prototype property|maximum_wire_distance|[[Types/double|double]]|0|optional=true}} | |||
The maximum distance between this pole and any other connected pole - if two poles are farther apart than this, they cannot be connected together directly. Corresponds to "wire reach" in the item tooltip. | The maximum distance between this pole and any other connected pole - if two poles are farther apart than this, they cannot be connected together directly. Corresponds to "wire reach" in the item tooltip. | ||
Max value is 64. | Max value is 64. | ||
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}} | |||
= | |||
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}} | |||
{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}} | |||
Drawn when the electric pole is connected to an electric network. | |||
{{Prototype property|track_coverage_during_build_by_moving|[[Types/bool|bool]]|false|optional=true}} | |||
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/prototypes/ElectricPolePrototype.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 An electric pole - part of the electric system.
Mandatory properties
This prototype inherits all the properties from Prototype/EntityWithOwner.
Template:Prototype property The "radius" of this pole's supply area. Corresponds to half of the "supply area" in the item tooltip. If this is 3.5, the pole will have a 7X7 supply area.
Max value is 64.
Optional properties
Template:Prototype property
Drawn above the pictures when the electric pole is connected to an electric network.
Template:Prototype property The maximum distance between this pole and any other connected pole - if two poles are farther apart than this, they cannot be connected together directly. Corresponds to "wire reach" in the item tooltip.
Max value is 64.
Template:Prototype property Drawn when the electric pole is connected to an electric network.