Prototype/ElectricPole: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(Undo revision 189026 by CybranM (talk) max_wire_distance is control stage, maximum_wire_distance is data stage)
Tag: Undo
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/EntityWithOwner}}
Prototype type: '''electric-pole'''
An electric pole - part of the [[electric system]].


An electric pole - part of the [[electric system]]. Based on [[Prototype/EntityWithHealth]].
{{Prototype TOC|electric-pole}}


== Properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].


=== pictures ===
{{Prototype property|pictures|[[Types/RotatedSprite|RotatedSprite]]}}
'''Type''': [[Types/RotatedSprite]]


=== radius_visualisation_picture ===
{{Prototype property|supply_area_distance|[[Types/double|double]]}}
'''Type''': [[Types/Sprite]]
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.


=== maximum_wire_distance ===
Max value is 64.
'''Type''': [[Types/double]]


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.
{{Prototype property|connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]}}
 
== Optional properties ==


Max value is 64.
{{Prototype property|radius_visualisation_picture|[[Types/Sprite|Sprite]]|optional=true}}


=== supply_area_distance ===
{{Prototype property|active_picture|[[Types/Sprite|Sprite]]|optional=true}}
'''Type''': [[Types/float]]
Drawn above the <code>pictures</code> when the electric pole is connected to an electric network.


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.
{{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.
Max value is 64.


=== track_coverage_during_build_by_moving ===
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/bool]]
 
=== connection_points ===
'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]
 
=== draw_copper_wires ===
'''Type''': [[Types/bool]]


'''Default''': true
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}


=== draw_circuit_wires ===
{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
'''Type''': [[Types/bool]]
Drawn when the electric pole is connected to an electric network.


'''Default''': true
{{Prototype property|track_coverage_during_build_by_moving|[[Types/bool|bool]]|false|optional=true}}

Latest revision as of 18:45, 19 April 2022

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/ElectricPole


An electric pole - part of the electric system.


Prototype/ElectricPole — electric-pole
connection_points::table of WireConnectionPoint
pictures::RotatedSprite
supply_area_distance::double
active_picture::Sprite (optional)
draw_circuit_wires::bool (optional)
draw_copper_wires::bool (optional)
light::LightDefinition (optional)
maximum_wire_distance::double (optional)
radius_visualisation_picture::Sprite (optional)
track_coverage_during_build_by_moving::bool (optional)
Inherited from Prototype/EntityWithOwner
allow_run_time_change_of_is_military_target::bool (optional)
is_military_target::bool (optional)
Inherited from Prototype/EntityWithHealth
alert_when_damaged::bool (optional)
attack_reaction::AttackReaction (optional)
corpse::string or table of strings (optional)
create_ghost_on_death::bool (optional)
damaged_trigger_effect::TriggerEffect (optional)
dying_explosion::ExplosionDefinition or table of ExplosionDefinition (optional)
dying_trigger_effect::TriggerEffect (optional)
healing_per_tick::float (optional)
hide_resistances::bool (optional)
integration_patch::Sprite4Way (optional)
integration_patch_render_layer::RenderLayer (optional)
loot::Loot (optional)
max_health::float (optional)
random_corpse_variation::bool (optional)
repair_sound::Sound (optional)
repair_speed_modifier::float (optional)
resistances::Resistances (optional)
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)::IconSpecification
additional_pastable_entities::table of string (optional)
alert_icon_scale::float (optional)
alert_icon_shift::vector (optional)
allow_copy_paste::bool (optional)
autoplace::AutoplaceSpecification (optional)
build_base_evolution_requirement::double (optional)
build_grid_size::uint8 (optional)
build_sound::Sound (optional)
close_sound::Sound (optional)
collision_box::BoundingBox (optional)
collision_mask::CollisionMask (optional)
created_effect::Trigger (optional)
created_smoke::CreateTrivialSmokeEffectItem (optional)
drawing_box::BoundingBox (optional)
emissions_per_second::double (optional)
enemy_map_color::Color (optional)
fast_replaceable_group::string (optional)
flags::EntityPrototypeFlags (optional)
friendly_map_color::Color (optional)
hit_visualization_box::BoundingBox (optional)
map_color::Color (optional)
map_generator_bounding_box::BoundingBox (optional)
minable::MinableProperties (optional)
mined_sound::Sound (optional)
mining_sound::Sound (optional)
next_upgrade::string (optional)
open_sound::Sound (optional)
placeable_by::ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building::bool (optional)
radius_visualisation_specification::RadiusVisualisationSpecification (optional)
remains_when_mined::string or table of string (optional)
remove_decoratives::string (optional)
rotated_sound::Sound (optional)
selectable_in_game::bool (optional)
selection_box::BoundingBox (optional)
selection_priority::uint8 (optional)
shooting_cursor_size::double (optional)
sticker_box::BoundingBox (optional)
subgroup::string (optional)
tile_height::uint32 (optional)
tile_width::uint32 (optional)
trigger_target_mask::TriggerTargetMask (optional)
vehicle_impact_sound::Sound (optional)
water_reflection::WaterReflectionDefinition (optional)
working_sound::WorkingSound (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

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

Retrieved from "https://testing-wiki.factorio.com/index.php?title=Prototype/ElectricPole&oldid=189027"