Prototype/ParticleSource: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Converted to SMW format)
(Updated styling of prototype doc migration note)
 
(4 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/ParticleSourcePrototype.html https://lua-api.factorio.com/latest/prototypes/ParticleSourcePrototype.html]
</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}}
{{Prototype parent|Prototype/Entity}}
Creates particles.
Creates particles.
Line 6: Line 12:
== Mandatory properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Entity]].
This prototype inherits all the properties from [[Prototype/Entity]].
{{Prototype property|particle|[[Types/string|string]]}}
Name of an entity.


{{Prototype property|time_to_live|[[Types/float|float]]}}
{{Prototype property|time_to_live|[[Types/float|float]]}}
Line 21: Line 24:


== Optional properties ==
== Optional properties ==
{{Prototype property|particle|[[Types/string|string]]|optional=true}}
Name of a [[Prototype/Particle]]. Either this or <code>smoke</code> must be defined.
{{Prototype property|smoke|[[Types/table|table]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}
Array of 1 or more smoke sources. Either this or <code>particle</code> must be defined.


{{Prototype property|time_to_live_deviation|[[Types/float|float]]|0|optional=true}}
{{Prototype property|time_to_live_deviation|[[Types/float|float]]|0|optional=true}}

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/ParticleSourcePrototype.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/ParticleSource


Creates particles.


Prototype/ParticleSource — particle-source
height::float
horizontal_speed::float
time_before_start::float
time_to_live::float
vertical_speed::float
height_deviation::float (optional)
horizontal_speed_deviation::float (optional)
particle::string (optional)
smoke::table of SmokeSource (optional)
time_before_start_deviation::float (optional)
time_to_live_deviation::float (optional)
vertical_speed_deviation::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.

time_to_live

Type: float

time_before_start

Type: float

height

Type: float

vertical_speed

Type: float

horizontal_speed

Type: float

Optional properties

particle

Type: string
Name of a Prototype/Particle. Either this or smoke must be defined.

smoke

Type: table of SmokeSource
Array of 1 or more smoke sources. Either this or particle must be defined.

time_to_live_deviation

Type: float
Default: 0

time_before_start_deviation

Type: float
Default: 0

height_deviation

Type: float
Default: 0

vertical_speed_deviation

Type: float
Default: 0

horizontal_speed_deviation

Type: float
Default: 0