Prototype/ElectricPole: Difference between revisions
(Created page. Missing info!) |
(Updated styling of prototype doc migration note) |
||
(13 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> | |||
This | |||
== | {{Prototype parent|Prototype/EntityWithOwner}} | ||
An electric pole - part of the [[electric system]]. | |||
{{Prototype TOC|electric-pole}} | |||
== Mandatory properties == | |||
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. | |||
Max value is 64. | |||
{{Prototype property|connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]}} | |||
== 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. | |||
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}} | ||
Latest 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.
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/ElectricPole
An electric pole - part of the electric system.
Mandatory properties
This prototype inherits all the properties from Prototype/EntityWithOwner.
pictures
Type: RotatedSprite
supply_area_distance
Type: 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.
Max value is 64.
connection_points
Type: table of WireConnectionPoint
Optional properties
radius_visualisation_picture
Type: Sprite
active_picture
Type: Sprite
Drawn above the pictures
when the electric pole is connected to an electric network.
maximum_wire_distance
Type: double
Default: 0
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.
draw_copper_wires
Type: bool
Default: true
draw_circuit_wires
Type: bool
Default: true
light
Type: LightDefinition
Drawn when the electric pole is connected to an electric network.
track_coverage_during_build_by_moving
Type: bool
Default: false