Prototype/Smoke: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(Descriptions and more)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/Entity}}
This type is abstract and cannot be created directly.
Abstract entity that has an animation.


Extends [[Prototype/Entity]].
{{Prototype TOC|''abstract''}}


== Extensions ==
== Extensions ==
* [[Prototype/SimpleSmoke]] '''smoke'''
* [[Prototype/SimpleSmoke]] '''smoke''' (deprecated)
* [[Prototype/SmokeWithTrigger]] '''smoke-with-trigger'''
* [[Prototype/SmokeWithTrigger]] '''smoke-with-trigger'''


Line 11: Line 11:
This prototype inherits all the properties from [[Prototype/Entity]].
This prototype inherits all the properties from [[Prototype/Entity]].


=== animation ===
{{Prototype property|animation|[[Types/Animation|Animation]]}}
'''Type''': [[Types/Animation]]


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


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


'''Default''': false
{{Prototype property|duration|[[Types/uint32|uint32]]|0|optional=true}}
May not be 0 if cyclic is true.


=== duration ===
{{Prototype property|spread_duration|[[Types/uint32|uint32]]|0|optional=true}}
'''Type''': [[Types/uint32]]


'''Default''': 0
{{Prototype property|fade_away_duration|[[Types/uint32|uint32]]|0|optional=true}}
<code>fade_in_duration</code> + <code>fade_away_duration</code> must be <= <code>duration</code>.


=== fade_away_duration ===
{{Prototype property|fade_in_duration|[[Types/uint32|uint32]]|0|optional=true}}
'''Type''': [[Types/uint32]]
<code>fade_in_duration</code> + <code>fade_away_duration</code> must be <= <code>duration</code>.


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


=== fade_in_duration ===
{{Prototype property|end_scale|[[Types/double|double]]|1.0|optional=true}}
'''Type''': [[Types/uint32]]


'''Default''': 0
{{Prototype property|color|[[Types/Color|Color]]|<nowiki>{r=0.375, g=0.375, b=0.375, a=0.375}</nowiki>|optional=true}}


=== start_scale ===
{{Prototype property|affected_by_wind|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/double]]
Smoke always moves randomly unless <code>movement_slow_down_factor</code> is 0. If <code>affected_by_wind</code> is true, the smoke will also be moved by wind.


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


=== end_scale ===
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"smoke"|optional=true}}
'''Type''': [[Types/double]]


'''Default''': 1.0
{{Prototype property|movement_slow_down_factor|[[Types/double|double]]|0.995|optional=true}}
Value between 0 and 1, with 0 being no movement.


=== color ===
{{Prototype property|glow_fade_away_duration|[[Types/uint32|uint32]]|The value of <code>fade_away_duration</code>|optional=true}}
'''Type''': [[Types/Color]]


'''Default''': {r=0.375, g=0.375, b=0.375, a=0.375}
{{Prototype property|glow_animation|[[Types/Animation|Animation]]|optional=true}}


=== affected_by_wind ===
== Mandatory values ==
'''Type''': [[Types/bool]]
Smoke must have a collision box size of zero.
 
'''Default''': true
 
Smoke always moves randomly unless <code>movement_slow_down_factor</code> is 1. If <code>affected_by_wind</code> is true, the smoke will also be moved by wind.
 
=== show_when_smoke_off ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== render_layer ===
'''Type''': [[Types/RenderLayer]]
 
'''Default''': "smoke"
 
=== movement_slow_down_factor ===
'''Type''': [[Types/double]]
 
'''Default''': 0.995
 
Value between 0 and 1, with 1 being no movement.
 
=== glow_fade_away_duration ===
'''Type''': [[Types/uint32]]
 
'''Default''': The value of <code>fade_away_duration</code>
 
=== glow_animation ===
'''Type''': [[Types/Animation]]

Latest revision as of 12:44, 16 March 2020

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/Smoke


Abstract entity that has an animation.


Prototype/Smoke — abstract
animation::Animation
affected_by_wind::bool (optional)
color::Color (optional)
cyclic::bool (optional)
duration::uint32 (optional)
end_scale::double (optional)
fade_away_duration::uint32 (optional)
fade_in_duration::uint32 (optional)
glow_animation::Animation (optional)
glow_fade_away_duration::uint32 (optional)
movement_slow_down_factor::double (optional)
render_layer::RenderLayer (optional)
show_when_smoke_off::bool (optional)
spread_duration::uint32 (optional)
start_scale::double (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

Mandatory properties

This prototype inherits all the properties from Prototype/Entity.

animation

Type: Animation

Optional properties

cyclic

Type: bool
Default: false

duration

Type: uint32
Default: 0
May not be 0 if cyclic is true.

spread_duration

Type: uint32
Default: 0

fade_away_duration

Type: uint32
Default: 0
fade_in_duration + fade_away_duration must be <= duration.

fade_in_duration

Type: uint32
Default: 0
fade_in_duration + fade_away_duration must be <= duration.

start_scale

Type: double
Default: 1.0

end_scale

Type: double
Default: 1.0

color

Type: Color
Default: {r=0.375, g=0.375, b=0.375, a=0.375}

affected_by_wind

Type: bool
Default: true
Smoke always moves randomly unless movement_slow_down_factor is 0. If affected_by_wind is true, the smoke will also be moved by wind.

show_when_smoke_off

Type: bool
Default: false

render_layer

Type: RenderLayer
Default: "smoke"

movement_slow_down_factor

Type: double
Default: 0.995
Value between 0 and 1, with 0 being no movement.

glow_fade_away_duration

Type: uint32
Default: The value of fade_away_duration

glow_animation

Type: Animation

Mandatory values

Smoke must have a collision box size of zero.

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