Prototype/FluidStream

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/FluidStream

Used for example for the handheld flamethrower.

Prototype/FluidStream — stream
particle_horizontal_speed	::	double
particle_horizontal_speed_deviation	::	double
particle_spawn_interval	::	uint16
particle_vertical_acceleration	::	double
action	::	Trigger (optional)
ground_light	::	LightDefinition (optional)
initial_action	::	Trigger (optional)
oriented_particle	::	bool (optional)
particle	::	Animation (optional)
particle_alpha_per_part	::	float (optional)
particle_buffer_size	::	uint32 (optional)
particle_end_alpha	::	float (optional)
particle_fade_out_duration	::	uint16 (optional)
particle_fade_out_threshold	::	float (optional)
particle_loop_exit_threshold	::	float (optional)
particle_loop_frame_count	::	uint16 (optional)
particle_scale_per_part	::	float (optional)
particle_spawn_timeout	::	uint16 (optional)
particle_start_alpha	::	float (optional)
particle_start_scale	::	float (optional)
progress_to_create_smoke	::	float (optional)
shadow	::	Animation (optional)
shadow_scale_enabled	::	bool (optional)
smoke_sources	::	table of SmokeSource (optional)
special_neutral_target_damage	::	DamagePrototype (optional)
spine_animation	::	Animation (optional)
stream_light	::	LightDefinition (optional)
target_position_deviation	::	double (optional)
width	::	float (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/Entity.

particle_spawn_interval

Type: uint16
The stream will spawn one particle every particle_spawn_interval ticks until the particle_spawn_timeout is reached. The first particle will trigger an initial_action upon landing. Each particle triggers an action upon landing. Particles spawned within a single particle_spawn_timeout interval will be connected by a stretched spine_animation.

particle_horizontal_speed

Type: double
Must be larger than 0. particle_horizontal_speed has to be greater than particle_horizontal_speed_deviation.

particle_horizontal_speed_deviation

Type: double

particle_vertical_acceleration

Type: double

Optional properties

initial_action

Type: Trigger
Action that is triggered when the first particle lands.

action

Type: Trigger
Action that is triggered every time a particle lands. Not triggered for the first particle if initial_action is defined.

special_neutral_target_damage

Type: DamagePrototype

width

Type: float
Default: 0.5

particle_buffer_size

Type: uint32
Default: 20
Number of spawned child particles of the stream. Must be greater than 0 and less than 256.

particle_spawn_timeout

Type: uint16
Default: 4 * particle_spawn_interval

particle_start_alpha

Type: float
Default: 1

particle_end_alpha

Type: float
Default: 1

particle_start_scale

Type: float
Default: 1

particle_alpha_per_part

Type: float
Default: 1

particle_scale_per_part

Type: float
Default: 1

particle_fade_out_threshold

Type: float
Default: 1
Value between 0 and 1.

particle_loop_exit_threshold

Type: float
Default: 0
Value between 0 and 1.

particle_loop_frame_count

Type: uint16
Default: 1
Will be set to 1 by the game if less than 1.

particle_fade_out_duration

Type: uint16
Default: max uint16 (65553)
Will be set to 1 by the game if less than 1.

spine_animation

Type: Animation

particle

Type: Animation

shadow

Type: Animation

smoke_sources

Type: table of SmokeSource
Smoke spawning is controlled by progress_to_create_smoke.

progress_to_create_smoke

Type: float
Default: 0.5
The point in the particles projectile arc to start spawning smoke. 0.5 (the default) starts spawning smoke at the halfway point between the source and target.

stream_light

Type: LightDefinition

ground_light

Type: LightDefinition

target_position_deviation

Type: double
Default: 0

oriented_particle

Type: bool
Default: false

shadow_scale_enabled

Type: bool
Default: false