Prototype/Smoke: Difference between revisions
(Added prototype type to page) |
(Updated styling of prototype doc migration note) |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
= | <div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/SmokePrototype.html https://lua-api.factorio.com/latest/prototypes/SmokePrototype.html] | ||
This | |||
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
{{Prototype parent|Prototype/Entity}} | |||
Abstract entity that has an animation. | |||
{{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 17: | ||
This prototype inherits all the properties from [[Prototype/Entity]]. | This prototype inherits all the properties from [[Prototype/Entity]]. | ||
{{Prototype property|animation|[[Types/Animation|Animation]]}} | |||
== Optional properties == | == Optional properties == | ||
{{Prototype property|cyclic|[[Types/bool|bool]]|false|optional=true}} | |||
= | |||
{{Prototype property|duration|[[Types/uint32|uint32]]|0|optional=true}} | |||
May not be 0 if cyclic is true. | |||
{{Prototype property|spread_duration|[[Types/uint32|uint32]]|0|optional=true}} | |||
{{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>. | |||
{{Prototype property|fade_in_duration|[[Types/uint32|uint32]]|0|optional=true}} | |||
<code>fade_in_duration</code> + <code>fade_away_duration</code> must be <= <code>duration</code>. | |||
{{Prototype property|start_scale|[[Types/double|double]]|1.0|optional=true}} | |||
{{Prototype property|end_scale|[[Types/double|double]]|1.0|optional=true}} | |||
{{Prototype property|color|[[Types/Color|Color]]|<nowiki>{r=0.375, g=0.375, b=0.375, a=0.375}</nowiki>|optional=true}} | |||
{{Prototype property|affected_by_wind|[[Types/bool|bool]]|true|optional=true}} | |||
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. | |||
{{Prototype property|show_when_smoke_off|[[Types/bool|bool]]|false|optional=true}} | |||
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"smoke"|optional=true}} | |||
Value between 0 and 1, with | {{Prototype property|movement_slow_down_factor|[[Types/double|double]]|0.995|optional=true}} | ||
Value between 0 and 1, with 0 being no movement. | |||
{{Prototype property|glow_fade_away_duration|[[Types/uint32|uint32]]|The value of <code>fade_away_duration</code>|optional=true}} | |||
{{Prototype property|glow_animation|[[Types/Animation|Animation]]|optional=true}} | |||
== | == Mandatory values == | ||
Smoke must have a collision box size of zero. |
Latest revision as of 10:43, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/SmokePrototype.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/Smoke
Abstract entity that has an animation.
Extensions
- Prototype/SimpleSmoke smoke (deprecated)
- Prototype/SmokeWithTrigger smoke-with-trigger
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.