Prototype/Particle: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.18.19: vertical_acceleration, fade_away_duration)
(Removed old prototype docs)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Prototype parent|PrototypeBase}}
<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/ParticlePrototype.html https://lua-api.factorio.com/latest/prototypes/ParticlePrototype.html]
An entity with a limited lifetime that can use trigger effects


{{Prototype TOC|optimized-particle}}
</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>
 
== Mandatory properties ==
This prototype inherits all the properties from [[PrototypeBase]].
 
{{Prototype property|pictures|[[Types/AnimationVariations|AnimationVariations]]}}
Picture variation count and individual frame count must be equal to shadow variation count.
 
{{Prototype property|life_time|[[Types/uint16|uint16]]}}
Can't be 1.
 
== Optional properties ==
 
{{Prototype property|shadows|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}
Shadow variation variation count and individual frame count must be equal to picture variation count.
 
{{Prototype property|draw_shadow_when_on_ground|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|regular_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
 
{{Prototype property|ended_in_water_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
 
{{Prototype property|ended_on_ground_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
 
{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"object"}}
 
{{Prototype property|render_layer_when_on_ground|[[Types/RenderLayer|RenderLayer]]|"lower-object"}}
 
{{Prototype property|regular_trigger_effect_frequency|[[Types/uint32|uint32]]|0|optional=true}}
Can't be 1.
 
{{Prototype property|movement_modifier_when_on_ground|[[Types/double|double]]|0.8|optional=true}}
 
{{Prototype property|movement_modifier|[[Types/double|double]]|1|optional=true}}
 
{{Prototype property|vertical_acceleration|[[Types/float|float]]|-0.004|optional=true}}
Has to be >= -0.01 and <= 0.01.
 
{{Prototype property|mining_particle_frame_speed|[[Types/float|float]]|0|optional=true}}
 
{{Prototype property|fade_away_duration|[[Types/uint16|uint16]]|optional=true}}
Defaults to <code>life_time</code> / 5, but at most 60. If this is 0, it is silently changed to 1.

Latest revision as of 14:32, 25 October 2024

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/ParticlePrototype.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.