Prototype/Pipe: Difference between revisions

Revision as of 16:46, 5 August 2019

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

An entity to transport gas and fluids over a distance, and between machines.

Prototype/Pipe — `pipe`
fluid_box	::	FluidBox
horizontal_window_bounding_box	::	BoundingBox
pictures	::	table
vertical_window_bounding_box	::	BoundingBox
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)

Extensions

Prototype/InfinityPipe infinity-pipe

Mandatory properties

fluid_box

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

horizontal_window_bounding_box

Type: BoundingBox

vertical_window_bounding_box

Type: BoundingBox

pictures

Type: table
Table with the following mandatory members:

straight_vertical_single - Sprite
straight_vertical - Sprite
straight_vertical_window - Sprite
straight_horizontal - Sprite
straight_horizontal_window - Sprite
corner_up_right - Sprite
corner_up_left - Sprite
corner_down_right - Sprite
corner_down_left - Sprite
t_up - Sprite
t_down - Sprite
t_right - Sprite
t_left - Sprite
cross - Sprite
ending_up - Sprite
ending_down - Sprite
ending_right - Sprite
ending_left - Sprite
horizontal_window_background - Sprite
vertical_window_background - Sprite
fluid_background - Sprite
low_temperature_flow - Sprite
middle_temperature_flow - Sprite
high_temperature_flow - Sprite
gas_flow - Animation

@@ Line 1: / Line 1: @@
-== Basics ==
+{{Prototype parent|Prototype/EntityWithHealth}}
-An entity to transport gas and fluids over a distance, and between machines. This is an extension of [[Prototype/EntityWithHealth]]
+An entity to transport gas and fluids over a distance, and between machines.
-== Mandatory properties ==
-=== fluid_box ===
-'''Type''': [[Types/FluidBox]]
-The area of the entity where fluid/gas inputs, and outputs.
+{{Prototype TOC|pipe}}
-=== horizontal_window_bounding_box ===
+== Extensions ==
-'''Type''': [[Types/BoundingBox]]
+* [[Prototype/InfinityPipe]] '''infinity-pipe'''
-=== vertical_window_bounding_box ===
+== Mandatory properties ==
-'''Type''': [[Types/BoundingBox]]
-=== pictures ===
+{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
-This property is a huge table. See below.
+The area of the entity where fluid/gas inputs, and outputs.
-== pictures (all sub properties are mandatory) ==
-=== pipeStraightVerticalSingle ===
-'''Type''': [[Types/Sprite]]
-=== pipeStraightVertical ===
-'''Type''': [[Types/Sprite]]
-=== pipeStraightVerticalWindow ===
-'''Type''': [[Types/Sprite]]
-=== pipeStraightHorizontal ===
-'''Type''': [[Types/Sprite]]
-=== pipeStraightHorizontalWindow ===
-'''Type''': [[Types/Sprite]]
-=== pipeCornerUpRight ===
-'''Type''': [[Types/Sprite]]
-=== pipeCornerUpLeft ===
-'''Type''': [[Types/Sprite]]
-=== pipeCornerDownRight ===
-'''Type''': [[Types/Sprite]]
-=== pipeCornerDownLeft ===
-'''Type''': [[Types/Sprite]]
-=== pipeTUp ===
-'''Type''': [[Types/Sprite]]
-=== pipeTDown ===
-'''Type''': [[Types/Sprite]]
-=== pipeTRight ===
-'''Type''': [[Types/Sprite]]
-=== pipeTLeft ===
-'''Type''': [[Types/Sprite]]
-=== pipeCross ===
-'''Type''': [[Types/Sprite]]
-=== pipeEndingUp ===
-'''Type''': [[Types/Sprite]]
-=== pipeEndingDown ===
-'''Type''': [[Types/Sprite]]
-=== pipeEndingRight ===
-'''Type''': [[Types/Sprite]]
-=== pipeEndingLeft ===
-'''Type''': [[Types/Sprite]]
-=== horizontalWindowBackground ===
-'''Type''': [[Types/Sprite]]
-=== verticalWindowBackground ===
-'''Type''': [[Types/Sprite]]
-=== fluidBackground ===
-'''Type''': [[Types/Sprite]]
-=== lowTemperatureFlow ===
+{{Prototype property|horizontal_window_bounding_box|[[Types/BoundingBox|BoundingBox]]}}
-'''Type''': [[Types/Sprite]]
-=== middleTemperatureFlow ===
+{{Prototype property|vertical_window_bounding_box|[[Types/BoundingBox|BoundingBox]]}}
-'''Type''': [[Types/Sprite]]
-=== highTemperatureFlow ===
+{{Prototype property|pictures|[[Types/table|table]]}}
-'''Type''': [[Types/Sprite]]
+Table with the following mandatory members:
-=== gasFlow ===
+* straight_vertical_single - [[Types/Sprite|Sprite]]
-'''Type''': [[Types/Animation]]
+* straight_vertical - [[Types/Sprite|Sprite]]
+* straight_vertical_window - [[Types/Sprite|Sprite]]
+* straight_horizontal - [[Types/Sprite|Sprite]]
+* straight_horizontal_window - [[Types/Sprite|Sprite]]
+* corner_up_right - [[Types/Sprite|Sprite]]
+* corner_up_left - [[Types/Sprite|Sprite]]
+* corner_down_right - [[Types/Sprite|Sprite]]
+* corner_down_left - [[Types/Sprite|Sprite]]
+* t_up - [[Types/Sprite|Sprite]]
+* t_down - [[Types/Sprite|Sprite]]
+* t_right - [[Types/Sprite|Sprite]]
+* t_left - [[Types/Sprite|Sprite]]
+* cross - [[Types/Sprite|Sprite]]
+* ending_up - [[Types/Sprite|Sprite]]
+* ending_down - [[Types/Sprite|Sprite]]
+* ending_right - [[Types/Sprite|Sprite]]
+* ending_left - [[Types/Sprite|Sprite]]
+* horizontal_window_background - [[Types/Sprite|Sprite]]
+* vertical_window_background - [[Types/Sprite|Sprite]]
+* fluid_background - [[Types/Sprite|Sprite]]
+* low_temperature_flow - [[Types/Sprite|Sprite]]
+* middle_temperature_flow - [[Types/Sprite|Sprite]]
+* high_temperature_flow - [[Types/Sprite|Sprite]]
+* gas_flow - [[Types/Animation|Animation]]