Prototype/OffshorePump: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (whitespace)
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithHealth}}
{{Prototype parent|Prototype/EntityWithHealth}}
An [[offshore pump]].


== Basics ==
{{Prototype TOC|offshore-pump}}
Prototype type: '''offshore-pump'''
 
Extends [[Prototype/EntityWithHealth]].


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


=== fluid_box ===
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
'''Type''': [[Types/FluidBox]]
 
=== pumping_speed ===
'''Type''': [[Types/float]]


{{Prototype property|pumping_speed|[[Types/float|float]]}}
How many units of fluid are produced per tick.
How many units of fluid are produced per tick.


=== fluid ===
{{Prototype property|fluid|[[Types/string|string]]}}
'''Type''': [[Types/string]]
 
The name of the fluid that is produced by the pump.
The name of the fluid that is produced by the pump.


=== picture ===
{{Prototype property|picture|[[Types/Sprite4Way|Sprite4Way]]}}
'''Type''': [[Types/Sprite4Way]]


== Optional properties ==
== Optional properties ==


=== fluid_box_tile_collision_test ===
{{Prototype property|fluid_box_tile_collision_test|[[Types/CollisionMask|CollisionMask]]|"ground-tile"|optional=true}}
'''Type''': [[Types/CollisionMask]]
 
'''Default''': "ground-tile"
 
=== adjacent_tile_collision_test ===
'''Type''': [[Types/CollisionMask]]
 
'''Default''': "water-tile"
 
=== placeable_position_visualization ===
'''Type''': [[Types/Sprite]]


=== circuit_wire_max_distance ===
{{Prototype property|adjacent_tile_collision_test|[[Types/CollisionMask|CollisionMask]]|"water-tile"|optional=true}}
'''Type''': [[Types/double]]


'''Default''': 0
{{Prototype property|placeable_position_visualization|[[Types/Sprite|Sprite]]||optional=true}}


{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.
The maximum circuit wire distance for this entity.


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


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


'''Default''': false
{{Prototype property|remove_on_tile_collision|[[Types/bool|bool]]|false|optional=true}}
 
=== circuit_wire_connection_points ===
'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]


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


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

Revision as of 16:45, 5 August 2019

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


An offshore pump.


Prototype/OffshorePump — offshore-pump
fluid::string
fluid_box::FluidBox
pumping_speed::float
adjacent_tile_collision_box::BoundingBox (optional)
adjacent_tile_collision_mask::CollisionMask (optional)
adjacent_tile_collision_test::CollisionMask (optional)
always_draw_fluid::bool (optional)
center_collision_mask::CollisionMask (optional)
check_bounding_box_collides_with_tiles::bool (optional)
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_box_tile_collision_test::CollisionMask (optional)
graphics_set::table (optional)
min_perceived_performance::float (optional)
picture::Sprite4Way (optional)
placeable_position_visualization::Sprite (optional)
remove_on_tile_collision::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/EntityWithHealth.

fluid_box

Type: FluidBox

pumping_speed

Type: float
How many units of fluid are produced per tick.

fluid

Type: string
The name of the fluid that is produced by the pump.

picture

Type: Sprite4Way

Optional properties

fluid_box_tile_collision_test

Type: CollisionMask
Default: "ground-tile"

adjacent_tile_collision_test

Type: CollisionMask
Default: "water-tile"

placeable_position_visualization

Type: Sprite

circuit_wire_max_distance

Type: double
Default: 0
The maximum circuit wire distance for this entity.

draw_copper_wires

Type: bool
Default: true

draw_circuit_wires

Type: bool
Default: true

remove_on_tile_collision

Type: bool
Default: false

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.