123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/ParticleProcessMaterial.xml.
- .. _class_ParticleProcessMaterial:
- ParticleProcessMaterial
- =======================
- **Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Particle properties for :ref:`GPUParticles3D<class_GPUParticles3D>` and :ref:`GPUParticles2D<class_GPUParticles2D>` nodes.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- ParticleProcessMaterial defines particle properties and behavior. It is used in the ``process_material`` of :ref:`GPUParticles3D<class_GPUParticles3D>` and :ref:`GPUParticles2D<class_GPUParticles2D>` emitter nodes.
- Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture<class_CurveTexture>` applied to vary values over the lifetime of the particle.
- Particle animation is available only in :ref:`GPUParticles2D<class_GPUParticles2D>`. To use it, attach a :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`, with :ref:`CanvasItemMaterial.particles_animation<class_CanvasItemMaterial_property_particles_animation>` enabled, to the particles node.
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`angle_curve<class_ParticleProcessMaterial_property_angle_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`angular_velocity_curve<class_ParticleProcessMaterial_property_angular_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`angular_velocity_min<class_ParticleProcessMaterial_property_angular_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`anim_offset_curve<class_ParticleProcessMaterial_property_anim_offset_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`anim_offset_min<class_ParticleProcessMaterial_property_anim_offset_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`anim_speed_curve<class_ParticleProcessMaterial_property_anim_speed_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`anim_speed_min<class_ParticleProcessMaterial_property_anim_speed_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`attractor_interaction_enabled<class_ParticleProcessMaterial_property_attractor_interaction_enabled>` | ``true`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`collision_bounce<class_ParticleProcessMaterial_property_collision_bounce>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`collision_friction<class_ParticleProcessMaterial_property_collision_friction>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` | :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` | ``0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`collision_use_scale<class_ParticleProcessMaterial_property_collision_use_scale>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Color<class_Color>` | :ref:`color<class_ParticleProcessMaterial_property_color>` | ``Color(1, 1, 1, 1)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`damping_curve<class_ParticleProcessMaterial_property_damping_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`damping_min<class_ParticleProcessMaterial_property_damping_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`direction<class_ParticleProcessMaterial_property_direction>` | ``Vector3(1, 0, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_ParticleProcessMaterial_property_emission_box_extents>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_normal_texture<class_ParticleProcessMaterial_property_emission_normal_texture>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`int<class_int>` | :ref:`emission_point_count<class_ParticleProcessMaterial_property_emission_point_count>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`emission_ring_axis<class_ParticleProcessMaterial_property_emission_ring_axis>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_height<class_ParticleProcessMaterial_property_emission_ring_height>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_inner_radius<class_ParticleProcessMaterial_property_emission_ring_inner_radius>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_radius<class_ParticleProcessMaterial_property_emission_ring_radius>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` | :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` | ``0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_ParticleProcessMaterial_property_emission_sphere_radius>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`flatness<class_ParticleProcessMaterial_property_flatness>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_ParticleProcessMaterial_property_gravity>` | ``Vector3(0, -9.8, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`hue_variation_curve<class_ParticleProcessMaterial_property_hue_variation_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`hue_variation_min<class_ParticleProcessMaterial_property_hue_variation_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`initial_velocity_min<class_ParticleProcessMaterial_property_initial_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`lifetime_randomness<class_ParticleProcessMaterial_property_lifetime_randomness>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`linear_accel_curve<class_ParticleProcessMaterial_property_linear_accel_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`linear_accel_min<class_ParticleProcessMaterial_property_linear_accel_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`orbit_velocity_curve<class_ParticleProcessMaterial_property_orbit_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`orbit_velocity_min<class_ParticleProcessMaterial_property_orbit_velocity_min>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_align_y<class_ParticleProcessMaterial_property_particle_flag_align_y>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`radial_accel_curve<class_ParticleProcessMaterial_property_radial_accel_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`radial_accel_min<class_ParticleProcessMaterial_property_radial_accel_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`scale_curve<class_ParticleProcessMaterial_property_scale_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>` | ``1.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`scale_min<class_ParticleProcessMaterial_property_scale_min>` | ``1.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`spread<class_ParticleProcessMaterial_property_spread>` | ``45.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_collision<class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_end<class_ParticleProcessMaterial_property_sub_emitter_amount_at_end>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`sub_emitter_frequency<class_ParticleProcessMaterial_property_sub_emitter_frequency>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`sub_emitter_keep_velocity<class_ParticleProcessMaterial_property_sub_emitter_keep_velocity>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` | :ref:`sub_emitter_mode<class_ParticleProcessMaterial_property_sub_emitter_mode>` | ``0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`tangential_accel_curve<class_ParticleProcessMaterial_property_tangential_accel_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`tangential_accel_min<class_ParticleProcessMaterial_property_tangential_accel_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`bool<class_bool>` | :ref:`turbulence_enabled<class_ParticleProcessMaterial_property_turbulence_enabled>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` | ``0.1`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` | ``0.1`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_noise_scale<class_ParticleProcessMaterial_property_turbulence_noise_scale>` | ``9.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`turbulence_noise_speed<class_ParticleProcessMaterial_property_turbulence_noise_speed>` | ``Vector3(0.5, 0.5, 0.5)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_noise_speed_random<class_ParticleProcessMaterial_property_turbulence_noise_speed_random>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_noise_strength<class_ParticleProcessMaterial_property_turbulence_noise_strength>` | ``1.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+----------------------------+
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_param_max<class_ParticleProcessMaterial_method_get_param_max>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const| |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_param_min<class_ParticleProcessMaterial_method_get_param_min>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const| |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`get_param_texture<class_ParticleProcessMaterial_method_get_param_texture>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const| |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_ParticleProcessMaterial_method_get_particle_flag>` **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const| |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)** |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)** |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)** |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)** |
- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Enumerations
- ------------
- .. _enum_ParticleProcessMaterial_Parameter:
- .. rst-class:: classref-enumeration
- enum **Parameter**:
- .. _class_ParticleProcessMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set initial velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANGULAR_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGULAR_VELOCITY** = ``1``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set angular velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ORBIT_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ORBIT_VELOCITY** = ``2``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set orbital velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_LINEAR_ACCEL:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_LINEAR_ACCEL** = ``3``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set linear acceleration properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_ACCEL:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_RADIAL_ACCEL** = ``4``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set radial acceleration properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_TANGENTIAL_ACCEL:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TANGENTIAL_ACCEL** = ``5``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set tangential acceleration properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_DAMPING:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_DAMPING** = ``6``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set damping properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANGLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGLE** = ``7``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set angle properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_SCALE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_SCALE** = ``8``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set scale properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_HUE_VARIATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_HUE_VARIATION** = ``9``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set hue variation properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_SPEED:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_SPEED** = ``10``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set animation speed properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_OFFSET:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_OFFSET** = ``11``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set animation offset properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_MAX** = ``15``
- Represents the size of the :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` enum.
- .. _class_ParticleProcessMaterial_constant_PARAM_TURB_VEL_INFLUENCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_VEL_INFLUENCE** = ``13``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>` and :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>` to set the turbulence minimum und maximum influence on each particles velocity.
- .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INIT_DISPLACEMENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INIT_DISPLACEMENT** = ``14``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>` and :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>` to set the turbulence minimum and maximum displacement of the particles spawn position.
- .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INFLUENCE_OVER_LIFE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INFLUENCE_OVER_LIFE** = ``12``
- Use with :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set the turbulence influence over the particles life time.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_ParticleFlags:
- .. rst-class:: classref-enumeration
- enum **ParticleFlags**:
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY** = ``0``
- Use with :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` to set :ref:`particle_flag_align_y<class_ParticleProcessMaterial_property_particle_flag_align_y>`.
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ROTATE_Y:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ROTATE_Y** = ``1``
- Use with :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` to set :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>`.
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DISABLE_Z:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_DISABLE_Z** = ``2``
- Use with :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` to set :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>`.
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_MAX** = ``3``
- Represents the size of the :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_EmissionShape:
- .. rst-class:: classref-enumeration
- enum **EmissionShape**:
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINT:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINT** = ``0``
- All particles will be emitted from a single point.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE** = ``1``
- Particles will be emitted in the volume of a sphere.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE_SURFACE:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE_SURFACE** = ``2``
- Particles will be emitted on the surface of a sphere.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_BOX** = ``3``
- Particles will be emitted in the volume of a box.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINTS** = ``4``
- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>`.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_DIRECTED_POINTS** = ``5``
- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`. Particle velocity and rotation will be set based on :ref:`emission_normal_texture<class_ParticleProcessMaterial_property_emission_normal_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>`.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_RING** = ``6``
- Particles will be emitted in a ring or cylinder.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_MAX** = ``7``
- Represents the size of the :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_SubEmitterMode:
- .. rst-class:: classref-enumeration
- enum **SubEmitterMode**:
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_DISABLED** = ``0``
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_CONSTANT:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_CONSTANT** = ``1``
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_END:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_END** = ``2``
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_COLLISION:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_COLLISION** = ``3``
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_MAX** = ``4``
- Represents the size of the :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_CollisionMode:
- .. rst-class:: classref-enumeration
- enum **CollisionMode**:
- .. _class_ParticleProcessMaterial_constant_COLLISION_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_DISABLED** = ``0``
- No collision for particles. Particles will go through :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
- .. _class_ParticleProcessMaterial_constant_COLLISION_RIGID:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_RIGID** = ``1``
- :ref:`RigidBody3D<class_RigidBody3D>`-style collision for particles using :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
- .. _class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_HIDE_ON_CONTACT** = ``2``
- Hide particles instantly when colliding with a :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` node. This can be combined with a subemitter that uses the :ref:`COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>` collision mode to "replace" the parent particle with the subemitter on impact.
- .. _class_ParticleProcessMaterial_constant_COLLISION_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_MAX** = ``3``
- Represents the size of the :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` enum.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_ParticleProcessMaterial_property_angle_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **angle_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's rotation will be animated along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angle_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angle_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum initial rotation applied to each particle, in degrees.
- Only applied when :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` or :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` are ``true`` or the :ref:`BaseMaterial3D<class_BaseMaterial3D>` being used to draw the particle is using :ref:`BaseMaterial3D.BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angle_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angle_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angular_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **angular_velocity_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's angular velocity (rotation speed) will vary along this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angular_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angular_velocity_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second.
- Only applied when :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` or :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` are ``true`` or the :ref:`BaseMaterial3D<class_BaseMaterial3D>` being used to draw the particle is using :ref:`BaseMaterial3D.BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angular_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angular_velocity_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_offset_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **anim_offset_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's animation offset will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_offset_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_offset_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum animation offset that corresponds to frame index in the texture. ``0`` is the first frame, ``1`` is the last one. See :ref:`CanvasItemMaterial.particles_animation<class_CanvasItemMaterial_property_particles_animation>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_offset_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_offset_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_speed_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **anim_speed_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's animation speed will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_speed_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_speed_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum particle animation speed. Animation speed of ``1`` means that the particles will make full ``0`` to ``1`` offset cycle during lifetime, ``2`` means ``2`` cycles etc.
- With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMaterial.particles_anim_loop<class_CanvasItemMaterial_property_particles_anim_loop>` property if you want the animation to repeat.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_speed_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_speed_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_attractor_interaction_enabled:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **attractor_interaction_enabled** = ``true``
- .. rst-class:: classref-property-setget
- - void **set_attractor_interaction_enabled** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **is_attractor_interaction_enabled** **(** **)**
- True if the interaction with particle attractors is enabled.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_bounce:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **collision_bounce**
- .. rst-class:: classref-property-setget
- - void **set_collision_bounce** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_collision_bounce** **(** **)**
- The particles' bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). Only effective if :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` is :ref:`COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_friction:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **collision_friction**
- .. rst-class:: classref-property-setget
- - void **set_collision_friction** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_collision_friction** **(** **)**
- The particles' friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Only effective if :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` is :ref:`COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_mode:
- .. rst-class:: classref-property
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **collision_mode** = ``0``
- .. rst-class:: classref-property-setget
- - void **set_collision_mode** **(** :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` value **)**
- - :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **get_collision_mode** **(** **)**
- The particles' collision mode.
- \ **Note:** 3D Particles can only collide with :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes, not :ref:`PhysicsBody3D<class_PhysicsBody3D>` nodes. To make particles collide with various objects, you can add :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes as children of :ref:`PhysicsBody3D<class_PhysicsBody3D>` nodes.
- \ **Note:** 2D Particles can only collide with :ref:`LightOccluder2D<class_LightOccluder2D>` nodes, not :ref:`PhysicsBody2D<class_PhysicsBody2D>` nodes.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_use_scale:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **collision_use_scale** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_collision_use_scale** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **is_collision_using_scale** **(** **)**
- Should collision take scale into account.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_color:
- .. rst-class:: classref-property
- :ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)``
- .. rst-class:: classref-property-setget
- - void **set_color** **(** :ref:`Color<class_Color>` value **)**
- - :ref:`Color<class_Color>` **get_color** **(** **)**
- Each particle's initial color. If the :ref:`GPUParticles2D<class_GPUParticles2D>`'s ``texture`` is defined, it will be multiplied by this color.
- \ **Note:** :ref:`color<class_ParticleProcessMaterial_property_color>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color<class_ParticleProcessMaterial_property_color>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_color_initial_ramp:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **color_initial_ramp**
- .. rst-class:: classref-property-setget
- - void **set_color_initial_ramp** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- - :ref:`Texture2D<class_Texture2D>` **get_color_initial_ramp** **(** **)**
- Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
- \ **Note:** :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_color_ramp:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **color_ramp**
- .. rst-class:: classref-property-setget
- - void **set_color_ramp** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- - :ref:`Texture2D<class_Texture2D>` **get_color_ramp** **(** **)**
- Each particle's color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` over its lifetime (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
- \ **Note:** :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_damping_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **damping_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Damping will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_damping_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **damping_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- The maximum rate at which particles lose velocity. For example value of ``100`` means that the particle will go from ``100`` velocity to ``0`` in ``1`` second.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_damping_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **damping_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_direction:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **direction** = ``Vector3(1, 0, 0)``
- .. rst-class:: classref-property-setget
- - void **set_direction** **(** :ref:`Vector3<class_Vector3>` value **)**
- - :ref:`Vector3<class_Vector3>` **get_direction** **(** **)**
- Unit vector specifying the particles' emission direction.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_box_extents:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **emission_box_extents**
- .. rst-class:: classref-property-setget
- - void **set_emission_box_extents** **(** :ref:`Vector3<class_Vector3>` value **)**
- - :ref:`Vector3<class_Vector3>` **get_emission_box_extents** **(** **)**
- The box's extents if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_BOX<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_color_texture:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_color_texture**
- .. rst-class:: classref-property-setget
- - void **set_emission_color_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- - :ref:`Texture2D<class_Texture2D>` **get_emission_color_texture** **(** **)**
- Particle color will be modulated by color determined by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`.
- \ **Note:** :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_normal_texture:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_normal_texture**
- .. rst-class:: classref-property-setget
- - void **set_emission_normal_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- - :ref:`Texture2D<class_Texture2D>` **get_emission_normal_texture** **(** **)**
- Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`. Used only in :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_point_count:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **emission_point_count**
- .. rst-class:: classref-property-setget
- - void **set_emission_point_count** **(** :ref:`int<class_int>` value **)**
- - :ref:`int<class_int>` **get_emission_point_count** **(** **)**
- The number of emission points if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_point_texture:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_point_texture**
- .. rst-class:: classref-property-setget
- - void **set_emission_point_texture** **(** :ref:`Texture2D<class_Texture2D>` value **)**
- - :ref:`Texture2D<class_Texture2D>` **get_emission_point_texture** **(** **)**
- Particles will be emitted at positions determined by sampling this texture at a random position. Used with :ref:`EMISSION_SHAPE_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS>` and :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_axis:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **emission_ring_axis**
- .. rst-class:: classref-property-setget
- - void **set_emission_ring_axis** **(** :ref:`Vector3<class_Vector3>` value **)**
- - :ref:`Vector3<class_Vector3>` **get_emission_ring_axis** **(** **)**
- The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_height:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_height**
- .. rst-class:: classref-property-setget
- - void **set_emission_ring_height** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_emission_ring_height** **(** **)**
- The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_inner_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_inner_radius**
- .. rst-class:: classref-property-setget
- - void **set_emission_ring_inner_radius** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_emission_ring_inner_radius** **(** **)**
- The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_radius**
- .. rst-class:: classref-property-setget
- - void **set_emission_ring_radius** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_emission_ring_radius** **(** **)**
- The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_shape:
- .. rst-class:: classref-property
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **emission_shape** = ``0``
- .. rst-class:: classref-property-setget
- - void **set_emission_shape** **(** :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` value **)**
- - :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **get_emission_shape** **(** **)**
- Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` constants for values.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_sphere_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_sphere_radius**
- .. rst-class:: classref-property-setget
- - void **set_emission_sphere_radius** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_emission_sphere_radius** **(** **)**
- The sphere's radius if ``emission_shape`` is set to :ref:`EMISSION_SHAPE_SPHERE<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_flatness:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **flatness** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_flatness** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_flatness** **(** **)**
- Amount of :ref:`spread<class_ParticleProcessMaterial_property_spread>` along the Y axis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_gravity:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **gravity** = ``Vector3(0, -9.8, 0)``
- .. rst-class:: classref-property-setget
- - void **set_gravity** **(** :ref:`Vector3<class_Vector3>` value **)**
- - :ref:`Vector3<class_Vector3>` **get_gravity** **(** **)**
- Gravity applied to every particle.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_hue_variation_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **hue_variation_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's hue will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_hue_variation_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **hue_variation_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_hue_variation_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **hue_variation_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_initial_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **initial_velocity_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction<class_ParticleProcessMaterial_property_direction>` and :ref:`spread<class_ParticleProcessMaterial_property_spread>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_initial_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **initial_velocity_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_lifetime_randomness:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **lifetime_randomness** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_lifetime_randomness** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_lifetime_randomness** **(** **)**
- Particle lifetime randomness ratio. The lifetime will be multiplied by a value interpolated between ``1.0`` and a random number less than one. For example a random ratio of ``0.4`` would scale the original lifetime between ``0.4-1.0`` of its original value.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_linear_accel_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **linear_accel_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's linear acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_linear_accel_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **linear_accel_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum linear acceleration applied to each particle in the direction of motion.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_linear_accel_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **linear_accel_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_orbit_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **orbit_velocity_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's orbital velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_orbit_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **orbit_velocity_max**
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
- Only available when :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` is ``true``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_orbit_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **orbit_velocity_min**
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_align_y:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_align_y** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
- - :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
- Align Y axis of particle with the direction of its velocity.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_disable_z:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_disable_z** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
- - :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
- If ``true``, particles will not move on the z axis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_rotate_y:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_rotate_y** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
- - :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
- If ``true``, particles rotate around Y axis by :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_accel_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **radial_accel_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's radial acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_accel_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radial_accel_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_accel_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radial_accel_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **scale_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's scale will vary along this :ref:`CurveTexture<class_CurveTexture>`. If a :ref:`CurveXYZTexture<class_CurveXYZTexture>` is supplied instead, the scale will be separated per-axis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **scale_max** = ``1.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum initial scale applied to each particle.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **scale_min** = ``1.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_spread:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **spread** = ``45.0``
- .. rst-class:: classref-property-setget
- - void **set_spread** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_spread** **(** **)**
- Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **sub_emitter_amount_at_collision**
- .. rst-class:: classref-property-setget
- - void **set_sub_emitter_amount_at_collision** **(** :ref:`int<class_int>` value **)**
- - :ref:`int<class_int>` **get_sub_emitter_amount_at_collision** **(** **)**
- Sub particle amount on collision.
- Maximum amount set in the sub particles emitter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_end:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **sub_emitter_amount_at_end**
- .. rst-class:: classref-property-setget
- - void **set_sub_emitter_amount_at_end** **(** :ref:`int<class_int>` value **)**
- - :ref:`int<class_int>` **get_sub_emitter_amount_at_end** **(** **)**
- .. container:: contribute
- There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_frequency:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **sub_emitter_frequency**
- .. rst-class:: classref-property-setget
- - void **set_sub_emitter_frequency** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_sub_emitter_frequency** **(** **)**
- .. container:: contribute
- There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_keep_velocity:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **sub_emitter_keep_velocity** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_sub_emitter_keep_velocity** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **get_sub_emitter_keep_velocity** **(** **)**
- .. container:: contribute
- There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_mode:
- .. rst-class:: classref-property
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **sub_emitter_mode** = ``0``
- .. rst-class:: classref-property-setget
- - void **set_sub_emitter_mode** **(** :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` value **)**
- - :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **get_sub_emitter_mode** **(** **)**
- .. container:: contribute
- There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_tangential_accel_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **tangential_accel_curve**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's tangential acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_tangential_accel_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **tangential_accel_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_tangential_accel_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **tangential_accel_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum equivalent of :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_enabled:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **turbulence_enabled** = ``false``
- .. rst-class:: classref-property-setget
- - void **set_turbulence_enabled** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **get_turbulence_enabled** **(** **)**
- If ``true``, enables turbulence for the particle system. Turbulence can be used to vary particle movement according to its position (based on a 3D noise pattern).
- \ **Note:** Enabling turbulence has a high performance cost on the GPU. Only enable turbulence on a few particle systems at once at most, and consider disabling it when targeting mobile/web platforms.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_influence_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_influence_max** = ``0.1``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum turbulence influence on each particle.
- The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` and :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_influence_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_influence_min** = ``0.1``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum turbulence influence on each particle.
- The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` and :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_influence_over_life:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **turbulence_influence_over_life**
- .. rst-class:: classref-property-setget
- - void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Each particle's amount of turbulence will be influenced along this :ref:`CurveTexture<class_CurveTexture>` over its life time.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_initial_displacement_max** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Maximum displacement of each particle's spawn position by the turbulence.
- The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` and :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_initial_displacement_min** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Minimum displacement of each particle's spawn position by the turbulence.
- The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` and :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_scale:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_noise_scale** = ``9.0``
- .. rst-class:: classref-property-setget
- - void **set_turbulence_noise_scale** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_turbulence_noise_scale** **(** **)**
- This value controls the overall scale/frequency of the turbulence noise pattern.
- A small scale will result in smaller features with more detail while a high scale will result in smoother noise with larger features.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_speed:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **turbulence_noise_speed** = ``Vector3(0.5, 0.5, 0.5)``
- .. rst-class:: classref-property-setget
- - void **set_turbulence_noise_speed** **(** :ref:`Vector3<class_Vector3>` value **)**
- - :ref:`Vector3<class_Vector3>` **get_turbulence_noise_speed** **(** **)**
- The movement speed of the turbulence pattern. This changes how quickly the noise changes over time.
- A value of ``Vector3(0.0, 0.0, 0.0)`` will freeze the turbulence pattern in place.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_speed_random:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_noise_speed_random** = ``0.0``
- .. rst-class:: classref-property-setget
- - void **set_turbulence_noise_speed_random** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_turbulence_noise_speed_random** **(** **)**
- Use to influence the noise speed in a random pattern. This helps break up visible movement patterns.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_strength:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_noise_strength** = ``1.0``
- .. rst-class:: classref-property-setget
- - void **set_turbulence_noise_strength** **(** :ref:`float<class_float>` value **)**
- - :ref:`float<class_float>` **get_turbulence_noise_strength** **(** **)**
- The turbulence noise strength. Increasing this will result in a stronger, more contrasting noise pattern.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_ParticleProcessMaterial_method_get_param_max:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Returns the maximum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_param_min:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Returns the minimum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_param_texture:
- .. rst-class:: classref-method
- :ref:`Texture2D<class_Texture2D>` **get_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param **)** |const|
- Returns the :ref:`Texture2D<class_Texture2D>` used by the specified parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_particle_flag:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **get_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag **)** |const|
- Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param_max:
- .. rst-class:: classref-method
- void **set_param_max** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- Sets the maximum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param_min:
- .. rst-class:: classref-method
- void **set_param_min** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`float<class_float>` value **)**
- Sets the minimum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param_texture:
- .. rst-class:: classref-method
- void **set_param_texture** **(** :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- Sets the :ref:`Texture2D<class_Texture2D>` for the specified :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_particle_flag:
- .. rst-class:: classref-method
- void **set_particle_flag** **(** :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` particle_flag, :ref:`bool<class_bool>` enable **)**
- If ``true``, enables the specified particle flag. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|