Prototype/Pump: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(A page for the pump entity.)
 
(1.1.51: Prototype/EntityWithOwner added)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Basics==
{{Prototype parent|Prototype/EntityWithOwner}}
The Pump is used to transfer liquids or gas between tanks, and pipes.
The Pump is used to transfer liquids or gas between tanks, and pipes.
==Properties==
===fluid_box===
===energy_source===
'''Type''': [[Types/EnergySource]]


{{Prototype TOC|pump}}
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
The area of the entity where fluid inputs and outputs.
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The type of energy the pump uses.
The type of energy the pump uses.


===energy_usage===
{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
'''Type''': [[Types/EnergyUsage]]
The amount of energy the pump uses.
 
{{Prototype property|pumping_speed|[[Types/double|double]]}}
The amount of fluid this pump transfers per tick.
 
{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]}}
The animation for the pump.
 
== Optional properties ==
 
{{Prototype property|fluid_wagon_connector_speed|[[Types/double|double]]|1 / 64.0|optional=true}}
 
{{Prototype property|fluid_wagon_connector_alignment_tolerance|[[Types/double|double]]|2 / 32.0|optional=true}}


The amount of energy the pump uses.
{{Prototype property|fluid_wagon_connector_frame_count|[[Types/uint8|uint8]]|1|optional=true}}
 
{{Prototype property|fluid_animation|[[Types/Animation4Way|Animation4Way]]|optional=true}}
 
{{Prototype property|glass_pictures|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}


===pumping_speed===
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
'''Type''': [[Types/unsigned]]


The amount of fluid or gas this pump and transfer at. Default is 200.
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}


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


The animation for the pump.
{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance  > 0.


===fluid_box===
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
'''Type''': [[Types/FluidBox]]
Mandatory if circuit_wire_max_distance  > 0.


The area of the entity where fluid/gas inputs, and outputs.
{{Prototype property|fluid_wagon_connector_graphics|[[Types/table|table]] of [[Types/PumpConnectorGraphics|PumpConnectorGraphics]]|optional=true}}
Needs <code>load_animations</code> and <code>unload_animations</code> keys, both with a [[Types/PumpConnectorGraphics|PumpConnectorGraphics]] as the value.

Latest revision as of 19:27, 21 January 2022

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


The Pump is used to transfer liquids or gas between tanks, and pipes.


Prototype/Pump — pump
animations::Animation4Way
energy_source::EnergySource
energy_usage::Energy
fluid_box::FluidBox
pumping_speed::double
circuit_connector_sprites::table of CircuitConnectorSprites (optional)
circuit_wire_connection_points::table of WireConnectionPoint (optional)
circuit_wire_max_distance::double (optional)
draw_circuit_wires::bool (optional)
draw_copper_wires::bool (optional)
fluid_animation::Animation4Way (optional)
fluid_wagon_connector_alignment_tolerance::double (optional)
fluid_wagon_connector_frame_count::uint8 (optional)
fluid_wagon_connector_graphics::table of PumpConnectorGraphics (optional)
fluid_wagon_connector_speed::double (optional)
glass_pictures::Sprite4Way (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.

fluid_box

Type: FluidBox
The area of the entity where fluid inputs and outputs.

energy_source

Type: EnergySource
The type of energy the pump uses.

energy_usage

Type: Energy
The amount of energy the pump uses.

pumping_speed

Type: double
The amount of fluid this pump transfers per tick.

animations

Type: Animation4Way
The animation for the pump.

Optional properties

fluid_wagon_connector_speed

Type: double
Default: 1 / 64.0

fluid_wagon_connector_alignment_tolerance

Type: double
Default: 2 / 32.0

fluid_wagon_connector_frame_count

Type: uint8
Default: 1

fluid_animation

Type: Animation4Way

glass_pictures

Type: Sprite4Way

circuit_wire_max_distance

Type: double
Default: 0

draw_copper_wires

Type: bool
Default: true

draw_circuit_wires

Type: bool
Default: true

circuit_wire_connection_points

Type: table of WireConnectionPoint
Mandatory if circuit_wire_max_distance > 0.

circuit_connector_sprites

Type: table of CircuitConnectorSprites
Mandatory if circuit_wire_max_distance > 0.

fluid_wagon_connector_graphics

Type: table of PumpConnectorGraphics
Needs load_animations and unload_animations keys, both with a PumpConnectorGraphics as the value.

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