Prototype/FluidStream: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent|Prototype/Entity}}
{{Prototype parent|Prototype/Entity}}
Used for example for the handheld flamethrower.


== Basics ==
{{Prototype TOC|stream}}
Prototype type: '''stream'''
 
Extends [[Prototype/Entity]].


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


=== particle_spawn_interval ===
{{Prototype property|particle_spawn_interval|[[Types/uint16|uint16]]}}
'''Type''': [[Types/uint16]]
 
=== particle_horizontal_speed ===
'''Type''': [[Types/double]]


{{Prototype property|particle_horizontal_speed|[[Types/double|double]]}}
Must be larger than 0. particle_horizontal_speed has to be greater than particle_horizontal_speed_deviation.
Must be larger than 0. particle_horizontal_speed has to be greater than particle_horizontal_speed_deviation.


=== particle_horizontal_speed_deviation ===
{{Prototype property|particle_horizontal_speed_deviation|[[Types/double|double]]}}
'''Type''': [[Types/double]]


=== particle_vertical_acceleration ===
{{Prototype property|particle_vertical_acceleration|[[Types/double|double]]}}
'''Type''': [[Types/double]]


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


=== initial_action ===
{{Prototype property|initial_action|[[Types/Trigger|Trigger]]|optional=true}}
'''Type''': [[Types/Trigger]]
 
=== action ===
'''Type''': [[Types/Trigger]]
 
=== special_neutral_target_damage ===
'''Type''': [[Types/DamagePrototype]]


=== width ===
{{Prototype property|action|[[Types/Trigger|Trigger]]|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 0.5
{{Prototype property|special_neutral_target_damage|[[Types/DamagePrototype|DamagePrototype]]|optional=true}}


=== particle_buffer_size ===
{{Prototype property|width|[[Types/float|float]]|0.5|optional=true}}
'''Type''': [[Types/uint32]]
 
'''Default''': 20


{{Prototype property|particle_buffer_size|[[Types/uint32|uint32]]|20|optional=true}}
Has to be less than 256.
Has to be less than 256.


=== particle_spawn_timeout ===
{{Prototype property|particle_spawn_timeout|[[Types/uint16|uint16]]|4 * <code>particle_spawn_interval</code>|optional=true}}
'''Type''': [[Types/uint16]]
 
'''Default''': 4 * <code>particle_spawn_interval</code>
 
=== particle_start_alpha ===
'''Type''': [[Types/float]]
 
'''Default''': 1
 
=== particle_end_alpha ===
'''Type''': [[Types/float]]
 
'''Default''': 1


=== particle_start_scale ===
{{Prototype property|particle_start_alpha|[[Types/float|float]]|1|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 1
{{Prototype property|particle_end_alpha|[[Types/float|float]]|1|optional=true}}


=== particle_alpha_per_part ===
{{Prototype property|particle_start_scale|[[Types/float|float]]|1|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 1
{{Prototype property|particle_alpha_per_part|[[Types/float|float]]|1|optional=true}}


=== particle_scale_per_part ===
{{Prototype property|particle_scale_per_part|[[Types/float|float]]|1|optional=true}}
'''Type''': [[Types/float]]
 
'''Default''': 1
 
=== particle_fade_out_threshold ===
'''Type''': [[Types/float]]
 
'''Default''': 1


{{Prototype property|particle_fade_out_threshold|[[Types/float|float]]|1|optional=true}}
Value between 0 and 1.
Value between 0 and 1.


=== particle_loop_exit_threshold ===
{{Prototype property|particle_loop_exit_threshold|[[Types/float|float]]|0|optional=true}}
'''Type''': [[Types/float]]
 
'''Default''': 0
 
Value between 0 and 1.
Value between 0 and 1.


=== particle_loop_frame_count ===
{{Prototype property|particle_loop_frame_count|[[Types/uint16|uint16]]|1|optional=true}}
'''Type''': [[Types/uint16]]
 
'''Default''': 1
 
Will be set to 1 by the game if less than 1.
Will be set to 1 by the game if less than 1.


=== particle_fade_out_duration ===
{{Prototype property|particle_fade_out_duration|[[Types/uint16|uint16]]|max uint16 (65553)|optional=true}}
'''Type''': [[Types/uint16]]
 
'''Default''': max uint16 (65553)
 
Will be set to 1 by the game if less than 1.
Will be set to 1 by the game if less than 1.


=== spine_animation ===
{{Prototype property|spine_animation|[[Types/Animation|Animation]]|optional=true}}
'''Type''': [[Types/Animation]]
 
=== particle ===
'''Type''': [[Types/Animation]]
 
=== shadow ===
'''Type''': [[Types/Animation]]
 
=== smoke_sources ===
'''Type''': [[Types/table]] of [[Types/SmokeSource]]
 
=== progress_to_create_smoke ===
'''Type''': [[Types/float]]


'''Default''': 0.5
{{Prototype property|particle|[[Types/Animation|Animation]]|optional=true}}


=== stream_light ===
{{Prototype property|shadow|[[Types/Animation|Animation]]|optional=true}}
'''Type''': [[Types/LightDefinition]]


=== ground_light ===
{{Prototype property|smoke_sources|[[Types/table|table]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}
'''Type''': [[Types/LightDefinition]]


=== target_position_deviation ===
{{Prototype property|progress_to_create_smoke|[[Types/float|float]]|0.5|optional=true}}
'''Type''': [[Types/double]]


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


=== oriented_particle ===
{{Prototype property|ground_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': false
{{Prototype property|target_position_deviation|[[Types/double|double]]|0|optional=true}}


=== shadow_scale_enabled ===
{{Prototype property|oriented_particle|[[Types/bool|bool]]|false|optional=true}}
'''Type''': [[Types/bool]]


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

Revision as of 21:08, 5 August 2019

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

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

Type: Trigger

special_neutral_target_damage

Type: DamagePrototype

width

Type: float
Default: 0.5

particle_buffer_size

Type: uint32
Default: 20
Has to be 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

progress_to_create_smoke

Type: float
Default: 0.5

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