class_particleprocessmaterial.rst 145 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParticleProcessMaterial.xml.
  6. .. _class_ParticleProcessMaterial:
  7. ParticleProcessMaterial
  8. =======================
  9. **Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Holds a particle configuration for :ref:`GPUParticles2D<class_GPUParticles2D>` or :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **ParticleProcessMaterial** defines particle properties and behavior. It is used in the ``process_material`` of the :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>` nodes. Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture<class_CurveTexture>` or a :ref:`GradientTexture1D<class_GradientTexture1D>` applied to vary numerical or color values over the lifetime of the particle.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  21. | :ref:`Texture2D<class_Texture2D>` | :ref:`alpha_curve<class_ParticleProcessMaterial_property_alpha_curve>` | |
  22. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  23. | :ref:`Texture2D<class_Texture2D>` | :ref:`angle_curve<class_ParticleProcessMaterial_property_angle_curve>` | |
  24. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  25. | :ref:`float<class_float>` | :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>` | ``0.0`` |
  26. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  27. | :ref:`float<class_float>` | :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>` | ``0.0`` |
  28. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  29. | :ref:`Texture2D<class_Texture2D>` | :ref:`angular_velocity_curve<class_ParticleProcessMaterial_property_angular_velocity_curve>` | |
  30. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  31. | :ref:`float<class_float>` | :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>` | ``0.0`` |
  32. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  33. | :ref:`float<class_float>` | :ref:`angular_velocity_min<class_ParticleProcessMaterial_property_angular_velocity_min>` | ``0.0`` |
  34. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  35. | :ref:`Texture2D<class_Texture2D>` | :ref:`anim_offset_curve<class_ParticleProcessMaterial_property_anim_offset_curve>` | |
  36. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  37. | :ref:`float<class_float>` | :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>` | ``0.0`` |
  38. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  39. | :ref:`float<class_float>` | :ref:`anim_offset_min<class_ParticleProcessMaterial_property_anim_offset_min>` | ``0.0`` |
  40. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  41. | :ref:`Texture2D<class_Texture2D>` | :ref:`anim_speed_curve<class_ParticleProcessMaterial_property_anim_speed_curve>` | |
  42. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  43. | :ref:`float<class_float>` | :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>` | ``0.0`` |
  44. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  45. | :ref:`float<class_float>` | :ref:`anim_speed_min<class_ParticleProcessMaterial_property_anim_speed_min>` | ``0.0`` |
  46. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  47. | :ref:`bool<class_bool>` | :ref:`attractor_interaction_enabled<class_ParticleProcessMaterial_property_attractor_interaction_enabled>` | ``true`` |
  48. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  49. | :ref:`float<class_float>` | :ref:`collision_bounce<class_ParticleProcessMaterial_property_collision_bounce>` | |
  50. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  51. | :ref:`float<class_float>` | :ref:`collision_friction<class_ParticleProcessMaterial_property_collision_friction>` | |
  52. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  53. | :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` | :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` | ``0`` |
  54. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`collision_use_scale<class_ParticleProcessMaterial_property_collision_use_scale>` | ``false`` |
  56. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  57. | :ref:`Color<class_Color>` | :ref:`color<class_ParticleProcessMaterial_property_color>` | ``Color(1, 1, 1, 1)`` |
  58. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  59. | :ref:`Texture2D<class_Texture2D>` | :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` | |
  60. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  61. | :ref:`Texture2D<class_Texture2D>` | :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` | |
  62. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  63. | :ref:`Texture2D<class_Texture2D>` | :ref:`damping_curve<class_ParticleProcessMaterial_property_damping_curve>` | |
  64. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  65. | :ref:`float<class_float>` | :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>` | ``0.0`` |
  66. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  67. | :ref:`float<class_float>` | :ref:`damping_min<class_ParticleProcessMaterial_property_damping_min>` | ``0.0`` |
  68. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  69. | :ref:`Vector3<class_Vector3>` | :ref:`direction<class_ParticleProcessMaterial_property_direction>` | ``Vector3(1, 0, 0)`` |
  70. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  71. | :ref:`Texture2D<class_Texture2D>` | :ref:`directional_velocity_curve<class_ParticleProcessMaterial_property_directional_velocity_curve>` | |
  72. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  73. | :ref:`float<class_float>` | :ref:`directional_velocity_max<class_ParticleProcessMaterial_property_directional_velocity_max>` | |
  74. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  75. | :ref:`float<class_float>` | :ref:`directional_velocity_min<class_ParticleProcessMaterial_property_directional_velocity_min>` | |
  76. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  77. | :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_ParticleProcessMaterial_property_emission_box_extents>` | |
  78. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  79. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` | |
  80. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  81. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_curve<class_ParticleProcessMaterial_property_emission_curve>` | |
  82. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  83. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_normal_texture<class_ParticleProcessMaterial_property_emission_normal_texture>` | |
  84. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  85. | :ref:`int<class_int>` | :ref:`emission_point_count<class_ParticleProcessMaterial_property_emission_point_count>` | |
  86. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  87. | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>` | |
  88. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  89. | :ref:`Vector3<class_Vector3>` | :ref:`emission_ring_axis<class_ParticleProcessMaterial_property_emission_ring_axis>` | |
  90. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  91. | :ref:`float<class_float>` | :ref:`emission_ring_cone_angle<class_ParticleProcessMaterial_property_emission_ring_cone_angle>` | |
  92. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  93. | :ref:`float<class_float>` | :ref:`emission_ring_height<class_ParticleProcessMaterial_property_emission_ring_height>` | |
  94. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  95. | :ref:`float<class_float>` | :ref:`emission_ring_inner_radius<class_ParticleProcessMaterial_property_emission_ring_inner_radius>` | |
  96. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  97. | :ref:`float<class_float>` | :ref:`emission_ring_radius<class_ParticleProcessMaterial_property_emission_ring_radius>` | |
  98. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  99. | :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` | :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` | ``0`` |
  100. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  101. | :ref:`Vector3<class_Vector3>` | :ref:`emission_shape_offset<class_ParticleProcessMaterial_property_emission_shape_offset>` | ``Vector3(0, 0, 0)`` |
  102. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  103. | :ref:`Vector3<class_Vector3>` | :ref:`emission_shape_scale<class_ParticleProcessMaterial_property_emission_shape_scale>` | ``Vector3(1, 1, 1)`` |
  104. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  105. | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_ParticleProcessMaterial_property_emission_sphere_radius>` | |
  106. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  107. | :ref:`float<class_float>` | :ref:`flatness<class_ParticleProcessMaterial_property_flatness>` | ``0.0`` |
  108. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  109. | :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_ParticleProcessMaterial_property_gravity>` | ``Vector3(0, -9.8, 0)`` |
  110. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  111. | :ref:`Texture2D<class_Texture2D>` | :ref:`hue_variation_curve<class_ParticleProcessMaterial_property_hue_variation_curve>` | |
  112. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  113. | :ref:`float<class_float>` | :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>` | ``0.0`` |
  114. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  115. | :ref:`float<class_float>` | :ref:`hue_variation_min<class_ParticleProcessMaterial_property_hue_variation_min>` | ``0.0`` |
  116. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  117. | :ref:`float<class_float>` | :ref:`inherit_velocity_ratio<class_ParticleProcessMaterial_property_inherit_velocity_ratio>` | ``0.0`` |
  118. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  119. | :ref:`float<class_float>` | :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>` | ``0.0`` |
  120. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  121. | :ref:`float<class_float>` | :ref:`initial_velocity_min<class_ParticleProcessMaterial_property_initial_velocity_min>` | ``0.0`` |
  122. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  123. | :ref:`float<class_float>` | :ref:`lifetime_randomness<class_ParticleProcessMaterial_property_lifetime_randomness>` | ``0.0`` |
  124. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  125. | :ref:`Texture2D<class_Texture2D>` | :ref:`linear_accel_curve<class_ParticleProcessMaterial_property_linear_accel_curve>` | |
  126. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  127. | :ref:`float<class_float>` | :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>` | ``0.0`` |
  128. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  129. | :ref:`float<class_float>` | :ref:`linear_accel_min<class_ParticleProcessMaterial_property_linear_accel_min>` | ``0.0`` |
  130. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  131. | :ref:`Texture2D<class_Texture2D>` | :ref:`orbit_velocity_curve<class_ParticleProcessMaterial_property_orbit_velocity_curve>` | |
  132. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  133. | :ref:`float<class_float>` | :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>` | ``0.0`` |
  134. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  135. | :ref:`float<class_float>` | :ref:`orbit_velocity_min<class_ParticleProcessMaterial_property_orbit_velocity_min>` | ``0.0`` |
  136. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  137. | :ref:`bool<class_bool>` | :ref:`particle_flag_align_y<class_ParticleProcessMaterial_property_particle_flag_align_y>` | ``false`` |
  138. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  139. | :ref:`bool<class_bool>` | :ref:`particle_flag_damping_as_friction<class_ParticleProcessMaterial_property_particle_flag_damping_as_friction>` | ``false`` |
  140. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  141. | :ref:`bool<class_bool>` | :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` | ``false`` |
  142. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  143. | :ref:`bool<class_bool>` | :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` | ``false`` |
  144. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  145. | :ref:`Texture2D<class_Texture2D>` | :ref:`radial_accel_curve<class_ParticleProcessMaterial_property_radial_accel_curve>` | |
  146. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  147. | :ref:`float<class_float>` | :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>` | ``0.0`` |
  148. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  149. | :ref:`float<class_float>` | :ref:`radial_accel_min<class_ParticleProcessMaterial_property_radial_accel_min>` | ``0.0`` |
  150. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  151. | :ref:`Texture2D<class_Texture2D>` | :ref:`radial_velocity_curve<class_ParticleProcessMaterial_property_radial_velocity_curve>` | |
  152. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  153. | :ref:`float<class_float>` | :ref:`radial_velocity_max<class_ParticleProcessMaterial_property_radial_velocity_max>` | ``0.0`` |
  154. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  155. | :ref:`float<class_float>` | :ref:`radial_velocity_min<class_ParticleProcessMaterial_property_radial_velocity_min>` | ``0.0`` |
  156. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  157. | :ref:`Texture2D<class_Texture2D>` | :ref:`scale_curve<class_ParticleProcessMaterial_property_scale_curve>` | |
  158. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  159. | :ref:`float<class_float>` | :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>` | ``1.0`` |
  160. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  161. | :ref:`float<class_float>` | :ref:`scale_min<class_ParticleProcessMaterial_property_scale_min>` | ``1.0`` |
  162. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  163. | :ref:`Texture2D<class_Texture2D>` | :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>` | |
  164. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  165. | :ref:`float<class_float>` | :ref:`scale_over_velocity_max<class_ParticleProcessMaterial_property_scale_over_velocity_max>` | ``0.0`` |
  166. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  167. | :ref:`float<class_float>` | :ref:`scale_over_velocity_min<class_ParticleProcessMaterial_property_scale_over_velocity_min>` | ``0.0`` |
  168. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  169. | :ref:`float<class_float>` | :ref:`spread<class_ParticleProcessMaterial_property_spread>` | ``45.0`` |
  170. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  171. | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_collision<class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision>` | |
  172. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  173. | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_end<class_ParticleProcessMaterial_property_sub_emitter_amount_at_end>` | |
  174. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  175. | :ref:`float<class_float>` | :ref:`sub_emitter_frequency<class_ParticleProcessMaterial_property_sub_emitter_frequency>` | |
  176. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  177. | :ref:`bool<class_bool>` | :ref:`sub_emitter_keep_velocity<class_ParticleProcessMaterial_property_sub_emitter_keep_velocity>` | ``false`` |
  178. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  179. | :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` | :ref:`sub_emitter_mode<class_ParticleProcessMaterial_property_sub_emitter_mode>` | ``0`` |
  180. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  181. | :ref:`Texture2D<class_Texture2D>` | :ref:`tangential_accel_curve<class_ParticleProcessMaterial_property_tangential_accel_curve>` | |
  182. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  183. | :ref:`float<class_float>` | :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>` | ``0.0`` |
  184. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  185. | :ref:`float<class_float>` | :ref:`tangential_accel_min<class_ParticleProcessMaterial_property_tangential_accel_min>` | ``0.0`` |
  186. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  187. | :ref:`bool<class_bool>` | :ref:`turbulence_enabled<class_ParticleProcessMaterial_property_turbulence_enabled>` | ``false`` |
  188. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  189. | :ref:`float<class_float>` | :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` | ``0.1`` |
  190. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  191. | :ref:`float<class_float>` | :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` | ``0.1`` |
  192. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  193. | :ref:`Texture2D<class_Texture2D>` | :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>` | |
  194. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  195. | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>` | ``0.0`` |
  196. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  197. | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` | ``0.0`` |
  198. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  199. | :ref:`float<class_float>` | :ref:`turbulence_noise_scale<class_ParticleProcessMaterial_property_turbulence_noise_scale>` | ``9.0`` |
  200. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  201. | :ref:`Vector3<class_Vector3>` | :ref:`turbulence_noise_speed<class_ParticleProcessMaterial_property_turbulence_noise_speed>` | ``Vector3(0, 0, 0)`` |
  202. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  203. | :ref:`float<class_float>` | :ref:`turbulence_noise_speed_random<class_ParticleProcessMaterial_property_turbulence_noise_speed_random>` | ``0.2`` |
  204. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  205. | :ref:`float<class_float>` | :ref:`turbulence_noise_strength<class_ParticleProcessMaterial_property_turbulence_noise_strength>` | ``1.0`` |
  206. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  207. | :ref:`Texture2D<class_Texture2D>` | :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` | |
  208. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  209. | :ref:`Vector3<class_Vector3>` | :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>` | ``Vector3(0, 0, 0)`` |
  210. +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
  211. .. rst-class:: classref-reftable-group
  212. Methods
  213. -------
  214. .. table::
  215. :widths: auto
  216. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`Vector2<class_Vector2>` | :ref:`get_param<class_ParticleProcessMaterial_method_get_param>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
  218. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`float<class_float>` | :ref:`get_param_max<class_ParticleProcessMaterial_method_get_param_max>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
  220. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`float<class_float>` | :ref:`get_param_min<class_ParticleProcessMaterial_method_get_param_min>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
  222. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :ref:`Texture2D<class_Texture2D>` | :ref:`get_param_texture<class_ParticleProcessMaterial_method_get_param_texture>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
  224. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_ParticleProcessMaterial_method_get_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const| |
  226. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`set_param<class_ParticleProcessMaterial_method_set_param>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`Vector2<class_Vector2>`\ ) |
  228. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) |
  230. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) |
  232. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) |
  234. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ ) |
  236. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. .. rst-class:: classref-section-separator
  238. ----
  239. .. rst-class:: classref-descriptions-group
  240. Enumerations
  241. ------------
  242. .. _enum_ParticleProcessMaterial_Parameter:
  243. .. rst-class:: classref-enumeration
  244. enum **Parameter**: :ref:`🔗<enum_ParticleProcessMaterial_Parameter>`
  245. .. _class_ParticleProcessMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY:
  246. .. rst-class:: classref-enumeration-constant
  247. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0``
  248. 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.
  249. .. _class_ParticleProcessMaterial_constant_PARAM_ANGULAR_VELOCITY:
  250. .. rst-class:: classref-enumeration-constant
  251. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGULAR_VELOCITY** = ``1``
  252. 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.
  253. .. _class_ParticleProcessMaterial_constant_PARAM_ORBIT_VELOCITY:
  254. .. rst-class:: classref-enumeration-constant
  255. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ORBIT_VELOCITY** = ``2``
  256. 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.
  257. .. _class_ParticleProcessMaterial_constant_PARAM_LINEAR_ACCEL:
  258. .. rst-class:: classref-enumeration-constant
  259. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_LINEAR_ACCEL** = ``3``
  260. 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.
  261. .. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_ACCEL:
  262. .. rst-class:: classref-enumeration-constant
  263. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_RADIAL_ACCEL** = ``4``
  264. 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.
  265. .. _class_ParticleProcessMaterial_constant_PARAM_TANGENTIAL_ACCEL:
  266. .. rst-class:: classref-enumeration-constant
  267. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TANGENTIAL_ACCEL** = ``5``
  268. 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.
  269. .. _class_ParticleProcessMaterial_constant_PARAM_DAMPING:
  270. .. rst-class:: classref-enumeration-constant
  271. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_DAMPING** = ``6``
  272. 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.
  273. .. _class_ParticleProcessMaterial_constant_PARAM_ANGLE:
  274. .. rst-class:: classref-enumeration-constant
  275. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGLE** = ``7``
  276. 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.
  277. .. _class_ParticleProcessMaterial_constant_PARAM_SCALE:
  278. .. rst-class:: classref-enumeration-constant
  279. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_SCALE** = ``8``
  280. 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.
  281. .. _class_ParticleProcessMaterial_constant_PARAM_HUE_VARIATION:
  282. .. rst-class:: classref-enumeration-constant
  283. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_HUE_VARIATION** = ``9``
  284. 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.
  285. .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_SPEED:
  286. .. rst-class:: classref-enumeration-constant
  287. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_SPEED** = ``10``
  288. 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.
  289. .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_OFFSET:
  290. .. rst-class:: classref-enumeration-constant
  291. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_OFFSET** = ``11``
  292. 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.
  293. .. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_VELOCITY:
  294. .. rst-class:: classref-enumeration-constant
  295. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_RADIAL_VELOCITY** = ``15``
  296. 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 velocity properties.
  297. .. _class_ParticleProcessMaterial_constant_PARAM_DIRECTIONAL_VELOCITY:
  298. .. rst-class:: classref-enumeration-constant
  299. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_DIRECTIONAL_VELOCITY** = ``16``
  300. 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 directional velocity properties.
  301. .. _class_ParticleProcessMaterial_constant_PARAM_SCALE_OVER_VELOCITY:
  302. .. rst-class:: classref-enumeration-constant
  303. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_SCALE_OVER_VELOCITY** = ``17``
  304. 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 over velocity properties.
  305. .. _class_ParticleProcessMaterial_constant_PARAM_MAX:
  306. .. rst-class:: classref-enumeration-constant
  307. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_MAX** = ``18``
  308. Represents the size of the :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` enum.
  309. .. _class_ParticleProcessMaterial_constant_PARAM_TURB_VEL_INFLUENCE:
  310. .. rst-class:: classref-enumeration-constant
  311. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_VEL_INFLUENCE** = ``13``
  312. 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.
  313. .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INIT_DISPLACEMENT:
  314. .. rst-class:: classref-enumeration-constant
  315. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INIT_DISPLACEMENT** = ``14``
  316. 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.
  317. .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INFLUENCE_OVER_LIFE:
  318. .. rst-class:: classref-enumeration-constant
  319. :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INFLUENCE_OVER_LIFE** = ``12``
  320. Use with :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set the turbulence influence over the particles life time.
  321. .. rst-class:: classref-item-separator
  322. ----
  323. .. _enum_ParticleProcessMaterial_ParticleFlags:
  324. .. rst-class:: classref-enumeration
  325. enum **ParticleFlags**: :ref:`🔗<enum_ParticleProcessMaterial_ParticleFlags>`
  326. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY:
  327. .. rst-class:: classref-enumeration-constant
  328. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY** = ``0``
  329. 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>`.
  330. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ROTATE_Y:
  331. .. rst-class:: classref-enumeration-constant
  332. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ROTATE_Y** = ``1``
  333. 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>`.
  334. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DISABLE_Z:
  335. .. rst-class:: classref-enumeration-constant
  336. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_DISABLE_Z** = ``2``
  337. 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>`.
  338. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DAMPING_AS_FRICTION:
  339. .. rst-class:: classref-enumeration-constant
  340. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_DAMPING_AS_FRICTION** = ``3``
  341. .. container:: contribute
  342. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  343. .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_MAX:
  344. .. rst-class:: classref-enumeration-constant
  345. :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_MAX** = ``4``
  346. Represents the size of the :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` enum.
  347. .. rst-class:: classref-item-separator
  348. ----
  349. .. _enum_ParticleProcessMaterial_EmissionShape:
  350. .. rst-class:: classref-enumeration
  351. enum **EmissionShape**: :ref:`🔗<enum_ParticleProcessMaterial_EmissionShape>`
  352. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINT:
  353. .. rst-class:: classref-enumeration-constant
  354. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINT** = ``0``
  355. All particles will be emitted from a single point.
  356. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE:
  357. .. rst-class:: classref-enumeration-constant
  358. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE** = ``1``
  359. Particles will be emitted in the volume of a sphere.
  360. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE_SURFACE:
  361. .. rst-class:: classref-enumeration-constant
  362. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE_SURFACE** = ``2``
  363. Particles will be emitted on the surface of a sphere.
  364. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX:
  365. .. rst-class:: classref-enumeration-constant
  366. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_BOX** = ``3``
  367. Particles will be emitted in the volume of a box.
  368. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS:
  369. .. rst-class:: classref-enumeration-constant
  370. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINTS** = ``4``
  371. 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>`.
  372. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS:
  373. .. rst-class:: classref-enumeration-constant
  374. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_DIRECTED_POINTS** = ``5``
  375. 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>`.
  376. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING:
  377. .. rst-class:: classref-enumeration-constant
  378. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_RING** = ``6``
  379. Particles will be emitted in a ring or cylinder.
  380. .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_MAX:
  381. .. rst-class:: classref-enumeration-constant
  382. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_MAX** = ``7``
  383. Represents the size of the :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` enum.
  384. .. rst-class:: classref-item-separator
  385. ----
  386. .. _enum_ParticleProcessMaterial_SubEmitterMode:
  387. .. rst-class:: classref-enumeration
  388. enum **SubEmitterMode**: :ref:`🔗<enum_ParticleProcessMaterial_SubEmitterMode>`
  389. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_DISABLED:
  390. .. rst-class:: classref-enumeration-constant
  391. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_DISABLED** = ``0``
  392. .. container:: contribute
  393. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  394. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_CONSTANT:
  395. .. rst-class:: classref-enumeration-constant
  396. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_CONSTANT** = ``1``
  397. .. container:: contribute
  398. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  399. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_END:
  400. .. rst-class:: classref-enumeration-constant
  401. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_END** = ``2``
  402. .. container:: contribute
  403. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  404. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_COLLISION:
  405. .. rst-class:: classref-enumeration-constant
  406. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_COLLISION** = ``3``
  407. .. container:: contribute
  408. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  409. .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_MAX:
  410. .. rst-class:: classref-enumeration-constant
  411. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_MAX** = ``4``
  412. Represents the size of the :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` enum.
  413. .. rst-class:: classref-item-separator
  414. ----
  415. .. _enum_ParticleProcessMaterial_CollisionMode:
  416. .. rst-class:: classref-enumeration
  417. enum **CollisionMode**: :ref:`🔗<enum_ParticleProcessMaterial_CollisionMode>`
  418. .. _class_ParticleProcessMaterial_constant_COLLISION_DISABLED:
  419. .. rst-class:: classref-enumeration-constant
  420. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_DISABLED** = ``0``
  421. No collision for particles. Particles will go through :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
  422. .. _class_ParticleProcessMaterial_constant_COLLISION_RIGID:
  423. .. rst-class:: classref-enumeration-constant
  424. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_RIGID** = ``1``
  425. :ref:`RigidBody3D<class_RigidBody3D>`-style collision for particles using :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
  426. .. _class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT:
  427. .. rst-class:: classref-enumeration-constant
  428. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_HIDE_ON_CONTACT** = ``2``
  429. 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.
  430. .. _class_ParticleProcessMaterial_constant_COLLISION_MAX:
  431. .. rst-class:: classref-enumeration-constant
  432. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_MAX** = ``3``
  433. Represents the size of the :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` enum.
  434. .. rst-class:: classref-section-separator
  435. ----
  436. .. rst-class:: classref-descriptions-group
  437. Property Descriptions
  438. ---------------------
  439. .. _class_ParticleProcessMaterial_property_alpha_curve:
  440. .. rst-class:: classref-property
  441. :ref:`Texture2D<class_Texture2D>` **alpha_curve** :ref:`🔗<class_ParticleProcessMaterial_property_alpha_curve>`
  442. .. rst-class:: classref-property-setget
  443. - |void| **set_alpha_curve**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  444. - :ref:`Texture2D<class_Texture2D>` **get_alpha_curve**\ (\ )
  445. The alpha value of each particle's color will be multiplied by this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
  446. \ **Note:** :ref:`alpha_curve<class_ParticleProcessMaterial_property_alpha_curve>` 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:`alpha_curve<class_ParticleProcessMaterial_property_alpha_curve>` will have no visible effect.
  447. .. rst-class:: classref-item-separator
  448. ----
  449. .. _class_ParticleProcessMaterial_property_angle_curve:
  450. .. rst-class:: classref-property
  451. :ref:`Texture2D<class_Texture2D>` **angle_curve** :ref:`🔗<class_ParticleProcessMaterial_property_angle_curve>`
  452. .. rst-class:: classref-property-setget
  453. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  454. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  455. Each particle's rotation will be animated along this :ref:`CurveTexture<class_CurveTexture>`.
  456. .. rst-class:: classref-item-separator
  457. ----
  458. .. _class_ParticleProcessMaterial_property_angle_max:
  459. .. rst-class:: classref-property
  460. :ref:`float<class_float>` **angle_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_angle_max>`
  461. .. rst-class:: classref-property-setget
  462. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  463. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  464. Maximum initial rotation applied to each particle, in degrees.
  465. 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>`.
  466. .. rst-class:: classref-item-separator
  467. ----
  468. .. _class_ParticleProcessMaterial_property_angle_min:
  469. .. rst-class:: classref-property
  470. :ref:`float<class_float>` **angle_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_angle_min>`
  471. .. rst-class:: classref-property-setget
  472. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  473. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  474. Minimum equivalent of :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>`.
  475. .. rst-class:: classref-item-separator
  476. ----
  477. .. _class_ParticleProcessMaterial_property_angular_velocity_curve:
  478. .. rst-class:: classref-property
  479. :ref:`Texture2D<class_Texture2D>` **angular_velocity_curve** :ref:`🔗<class_ParticleProcessMaterial_property_angular_velocity_curve>`
  480. .. rst-class:: classref-property-setget
  481. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  482. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  483. Each particle's angular velocity (rotation speed) will vary along this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
  484. .. rst-class:: classref-item-separator
  485. ----
  486. .. _class_ParticleProcessMaterial_property_angular_velocity_max:
  487. .. rst-class:: classref-property
  488. :ref:`float<class_float>` **angular_velocity_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_angular_velocity_max>`
  489. .. rst-class:: classref-property-setget
  490. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  491. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  492. Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second.
  493. 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>`.
  494. .. rst-class:: classref-item-separator
  495. ----
  496. .. _class_ParticleProcessMaterial_property_angular_velocity_min:
  497. .. rst-class:: classref-property
  498. :ref:`float<class_float>` **angular_velocity_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_angular_velocity_min>`
  499. .. rst-class:: classref-property-setget
  500. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  501. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  502. Minimum equivalent of :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>`.
  503. .. rst-class:: classref-item-separator
  504. ----
  505. .. _class_ParticleProcessMaterial_property_anim_offset_curve:
  506. .. rst-class:: classref-property
  507. :ref:`Texture2D<class_Texture2D>` **anim_offset_curve** :ref:`🔗<class_ParticleProcessMaterial_property_anim_offset_curve>`
  508. .. rst-class:: classref-property-setget
  509. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  510. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  511. Each particle's animation offset will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  512. .. rst-class:: classref-item-separator
  513. ----
  514. .. _class_ParticleProcessMaterial_property_anim_offset_max:
  515. .. rst-class:: classref-property
  516. :ref:`float<class_float>` **anim_offset_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_anim_offset_max>`
  517. .. rst-class:: classref-property-setget
  518. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  519. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  520. 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>`.
  521. .. rst-class:: classref-item-separator
  522. ----
  523. .. _class_ParticleProcessMaterial_property_anim_offset_min:
  524. .. rst-class:: classref-property
  525. :ref:`float<class_float>` **anim_offset_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_anim_offset_min>`
  526. .. rst-class:: classref-property-setget
  527. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  528. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  529. Minimum equivalent of :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>`.
  530. .. rst-class:: classref-item-separator
  531. ----
  532. .. _class_ParticleProcessMaterial_property_anim_speed_curve:
  533. .. rst-class:: classref-property
  534. :ref:`Texture2D<class_Texture2D>` **anim_speed_curve** :ref:`🔗<class_ParticleProcessMaterial_property_anim_speed_curve>`
  535. .. rst-class:: classref-property-setget
  536. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  537. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  538. Each particle's animation speed will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  539. .. rst-class:: classref-item-separator
  540. ----
  541. .. _class_ParticleProcessMaterial_property_anim_speed_max:
  542. .. rst-class:: classref-property
  543. :ref:`float<class_float>` **anim_speed_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_anim_speed_max>`
  544. .. rst-class:: classref-property-setget
  545. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  546. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  547. 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.
  548. 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.
  549. .. rst-class:: classref-item-separator
  550. ----
  551. .. _class_ParticleProcessMaterial_property_anim_speed_min:
  552. .. rst-class:: classref-property
  553. :ref:`float<class_float>` **anim_speed_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_anim_speed_min>`
  554. .. rst-class:: classref-property-setget
  555. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  556. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  557. Minimum equivalent of :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>`.
  558. .. rst-class:: classref-item-separator
  559. ----
  560. .. _class_ParticleProcessMaterial_property_attractor_interaction_enabled:
  561. .. rst-class:: classref-property
  562. :ref:`bool<class_bool>` **attractor_interaction_enabled** = ``true`` :ref:`🔗<class_ParticleProcessMaterial_property_attractor_interaction_enabled>`
  563. .. rst-class:: classref-property-setget
  564. - |void| **set_attractor_interaction_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  565. - :ref:`bool<class_bool>` **is_attractor_interaction_enabled**\ (\ )
  566. If ``true``, interaction with particle attractors is enabled. In 3D, attraction only occurs within the area defined by the :ref:`GPUParticles3D<class_GPUParticles3D>` node's :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  567. .. rst-class:: classref-item-separator
  568. ----
  569. .. _class_ParticleProcessMaterial_property_collision_bounce:
  570. .. rst-class:: classref-property
  571. :ref:`float<class_float>` **collision_bounce** :ref:`🔗<class_ParticleProcessMaterial_property_collision_bounce>`
  572. .. rst-class:: classref-property-setget
  573. - |void| **set_collision_bounce**\ (\ value\: :ref:`float<class_float>`\ )
  574. - :ref:`float<class_float>` **get_collision_bounce**\ (\ )
  575. 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>`.
  576. .. rst-class:: classref-item-separator
  577. ----
  578. .. _class_ParticleProcessMaterial_property_collision_friction:
  579. .. rst-class:: classref-property
  580. :ref:`float<class_float>` **collision_friction** :ref:`🔗<class_ParticleProcessMaterial_property_collision_friction>`
  581. .. rst-class:: classref-property-setget
  582. - |void| **set_collision_friction**\ (\ value\: :ref:`float<class_float>`\ )
  583. - :ref:`float<class_float>` **get_collision_friction**\ (\ )
  584. 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>`.
  585. .. rst-class:: classref-item-separator
  586. ----
  587. .. _class_ParticleProcessMaterial_property_collision_mode:
  588. .. rst-class:: classref-property
  589. :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **collision_mode** = ``0`` :ref:`🔗<class_ParticleProcessMaterial_property_collision_mode>`
  590. .. rst-class:: classref-property-setget
  591. - |void| **set_collision_mode**\ (\ value\: :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>`\ )
  592. - :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **get_collision_mode**\ (\ )
  593. The particles' collision mode.
  594. \ **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. In 3D, collisions only occur within the area defined by the :ref:`GPUParticles3D<class_GPUParticles3D>` node's :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  595. \ **Note:** 2D Particles can only collide with :ref:`LightOccluder2D<class_LightOccluder2D>` nodes, not :ref:`PhysicsBody2D<class_PhysicsBody2D>` nodes.
  596. .. rst-class:: classref-item-separator
  597. ----
  598. .. _class_ParticleProcessMaterial_property_collision_use_scale:
  599. .. rst-class:: classref-property
  600. :ref:`bool<class_bool>` **collision_use_scale** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_collision_use_scale>`
  601. .. rst-class:: classref-property-setget
  602. - |void| **set_collision_use_scale**\ (\ value\: :ref:`bool<class_bool>`\ )
  603. - :ref:`bool<class_bool>` **is_collision_using_scale**\ (\ )
  604. If ``true``, :ref:`GPUParticles3D.collision_base_size<class_GPUParticles3D_property_collision_base_size>` is multiplied by the particle's effective scale (see :ref:`scale_min<class_ParticleProcessMaterial_property_scale_min>`, :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>`, :ref:`scale_curve<class_ParticleProcessMaterial_property_scale_curve>`, and :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`).
  605. .. rst-class:: classref-item-separator
  606. ----
  607. .. _class_ParticleProcessMaterial_property_color:
  608. .. rst-class:: classref-property
  609. :ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_ParticleProcessMaterial_property_color>`
  610. .. rst-class:: classref-property-setget
  611. - |void| **set_color**\ (\ value\: :ref:`Color<class_Color>`\ )
  612. - :ref:`Color<class_Color>` **get_color**\ (\ )
  613. Each particle's initial color. If the :ref:`GPUParticles2D<class_GPUParticles2D>`'s ``texture`` is defined, it will be multiplied by this color.
  614. \ **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.
  615. .. rst-class:: classref-item-separator
  616. ----
  617. .. _class_ParticleProcessMaterial_property_color_initial_ramp:
  618. .. rst-class:: classref-property
  619. :ref:`Texture2D<class_Texture2D>` **color_initial_ramp** :ref:`🔗<class_ParticleProcessMaterial_property_color_initial_ramp>`
  620. .. rst-class:: classref-property-setget
  621. - |void| **set_color_initial_ramp**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  622. - :ref:`Texture2D<class_Texture2D>` **get_color_initial_ramp**\ (\ )
  623. Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
  624. \ **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.
  625. .. rst-class:: classref-item-separator
  626. ----
  627. .. _class_ParticleProcessMaterial_property_color_ramp:
  628. .. rst-class:: classref-property
  629. :ref:`Texture2D<class_Texture2D>` **color_ramp** :ref:`🔗<class_ParticleProcessMaterial_property_color_ramp>`
  630. .. rst-class:: classref-property-setget
  631. - |void| **set_color_ramp**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  632. - :ref:`Texture2D<class_Texture2D>` **get_color_ramp**\ (\ )
  633. Each particle's color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` over its lifetime (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
  634. \ **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.
  635. .. rst-class:: classref-item-separator
  636. ----
  637. .. _class_ParticleProcessMaterial_property_damping_curve:
  638. .. rst-class:: classref-property
  639. :ref:`Texture2D<class_Texture2D>` **damping_curve** :ref:`🔗<class_ParticleProcessMaterial_property_damping_curve>`
  640. .. rst-class:: classref-property-setget
  641. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  642. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  643. Damping will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  644. .. rst-class:: classref-item-separator
  645. ----
  646. .. _class_ParticleProcessMaterial_property_damping_max:
  647. .. rst-class:: classref-property
  648. :ref:`float<class_float>` **damping_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_damping_max>`
  649. .. rst-class:: classref-property-setget
  650. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  651. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  652. 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.
  653. .. rst-class:: classref-item-separator
  654. ----
  655. .. _class_ParticleProcessMaterial_property_damping_min:
  656. .. rst-class:: classref-property
  657. :ref:`float<class_float>` **damping_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_damping_min>`
  658. .. rst-class:: classref-property-setget
  659. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  660. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  661. Minimum equivalent of :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>`.
  662. .. rst-class:: classref-item-separator
  663. ----
  664. .. _class_ParticleProcessMaterial_property_direction:
  665. .. rst-class:: classref-property
  666. :ref:`Vector3<class_Vector3>` **direction** = ``Vector3(1, 0, 0)`` :ref:`🔗<class_ParticleProcessMaterial_property_direction>`
  667. .. rst-class:: classref-property-setget
  668. - |void| **set_direction**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  669. - :ref:`Vector3<class_Vector3>` **get_direction**\ (\ )
  670. Unit vector specifying the particles' emission direction.
  671. .. rst-class:: classref-item-separator
  672. ----
  673. .. _class_ParticleProcessMaterial_property_directional_velocity_curve:
  674. .. rst-class:: classref-property
  675. :ref:`Texture2D<class_Texture2D>` **directional_velocity_curve** :ref:`🔗<class_ParticleProcessMaterial_property_directional_velocity_curve>`
  676. .. rst-class:: classref-property-setget
  677. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  678. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  679. A curve that specifies the velocity along each of the axes of the particle system along its lifetime.
  680. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  681. .. rst-class:: classref-item-separator
  682. ----
  683. .. _class_ParticleProcessMaterial_property_directional_velocity_max:
  684. .. rst-class:: classref-property
  685. :ref:`float<class_float>` **directional_velocity_max** :ref:`🔗<class_ParticleProcessMaterial_property_directional_velocity_max>`
  686. .. rst-class:: classref-property-setget
  687. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  688. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  689. Maximum directional velocity value, which is multiplied by :ref:`directional_velocity_curve<class_ParticleProcessMaterial_property_directional_velocity_curve>`.
  690. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  691. .. rst-class:: classref-item-separator
  692. ----
  693. .. _class_ParticleProcessMaterial_property_directional_velocity_min:
  694. .. rst-class:: classref-property
  695. :ref:`float<class_float>` **directional_velocity_min** :ref:`🔗<class_ParticleProcessMaterial_property_directional_velocity_min>`
  696. .. rst-class:: classref-property-setget
  697. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  698. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  699. Minimum directional velocity value, which is multiplied by :ref:`directional_velocity_curve<class_ParticleProcessMaterial_property_directional_velocity_curve>`.
  700. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  701. .. rst-class:: classref-item-separator
  702. ----
  703. .. _class_ParticleProcessMaterial_property_emission_box_extents:
  704. .. rst-class:: classref-property
  705. :ref:`Vector3<class_Vector3>` **emission_box_extents** :ref:`🔗<class_ParticleProcessMaterial_property_emission_box_extents>`
  706. .. rst-class:: classref-property-setget
  707. - |void| **set_emission_box_extents**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  708. - :ref:`Vector3<class_Vector3>` **get_emission_box_extents**\ (\ )
  709. The box's extents if :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX>`.
  710. \ **Note:** :ref:`emission_box_extents<class_ParticleProcessMaterial_property_emission_box_extents>` starts from the center point and applies the X, Y, and Z values in both directions. The size is twice the area of the extents.
  711. .. rst-class:: classref-item-separator
  712. ----
  713. .. _class_ParticleProcessMaterial_property_emission_color_texture:
  714. .. rst-class:: classref-property
  715. :ref:`Texture2D<class_Texture2D>` **emission_color_texture** :ref:`🔗<class_ParticleProcessMaterial_property_emission_color_texture>`
  716. .. rst-class:: classref-property-setget
  717. - |void| **set_emission_color_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  718. - :ref:`Texture2D<class_Texture2D>` **get_emission_color_texture**\ (\ )
  719. 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>`.
  720. \ **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.
  721. .. rst-class:: classref-item-separator
  722. ----
  723. .. _class_ParticleProcessMaterial_property_emission_curve:
  724. .. rst-class:: classref-property
  725. :ref:`Texture2D<class_Texture2D>` **emission_curve** :ref:`🔗<class_ParticleProcessMaterial_property_emission_curve>`
  726. .. rst-class:: classref-property-setget
  727. - |void| **set_emission_curve**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  728. - :ref:`Texture2D<class_Texture2D>` **get_emission_curve**\ (\ )
  729. Each particle's color will be multiplied by this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
  730. \ **Note:** :ref:`emission_curve<class_ParticleProcessMaterial_property_emission_curve>` 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_curve<class_ParticleProcessMaterial_property_emission_curve>` will have no visible effect.
  731. .. rst-class:: classref-item-separator
  732. ----
  733. .. _class_ParticleProcessMaterial_property_emission_normal_texture:
  734. .. rst-class:: classref-property
  735. :ref:`Texture2D<class_Texture2D>` **emission_normal_texture** :ref:`🔗<class_ParticleProcessMaterial_property_emission_normal_texture>`
  736. .. rst-class:: classref-property-setget
  737. - |void| **set_emission_normal_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  738. - :ref:`Texture2D<class_Texture2D>` **get_emission_normal_texture**\ (\ )
  739. 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.
  740. .. rst-class:: classref-item-separator
  741. ----
  742. .. _class_ParticleProcessMaterial_property_emission_point_count:
  743. .. rst-class:: classref-property
  744. :ref:`int<class_int>` **emission_point_count** :ref:`🔗<class_ParticleProcessMaterial_property_emission_point_count>`
  745. .. rst-class:: classref-property-setget
  746. - |void| **set_emission_point_count**\ (\ value\: :ref:`int<class_int>`\ )
  747. - :ref:`int<class_int>` **get_emission_point_count**\ (\ )
  748. The number of emission points if :ref:`emission_shape<class_ParticleProcessMaterial_property_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>`.
  749. .. rst-class:: classref-item-separator
  750. ----
  751. .. _class_ParticleProcessMaterial_property_emission_point_texture:
  752. .. rst-class:: classref-property
  753. :ref:`Texture2D<class_Texture2D>` **emission_point_texture** :ref:`🔗<class_ParticleProcessMaterial_property_emission_point_texture>`
  754. .. rst-class:: classref-property-setget
  755. - |void| **set_emission_point_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  756. - :ref:`Texture2D<class_Texture2D>` **get_emission_point_texture**\ (\ )
  757. 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.
  758. .. rst-class:: classref-item-separator
  759. ----
  760. .. _class_ParticleProcessMaterial_property_emission_ring_axis:
  761. .. rst-class:: classref-property
  762. :ref:`Vector3<class_Vector3>` **emission_ring_axis** :ref:`🔗<class_ParticleProcessMaterial_property_emission_ring_axis>`
  763. .. rst-class:: classref-property-setget
  764. - |void| **set_emission_ring_axis**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  765. - :ref:`Vector3<class_Vector3>` **get_emission_ring_axis**\ (\ )
  766. The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  767. .. rst-class:: classref-item-separator
  768. ----
  769. .. _class_ParticleProcessMaterial_property_emission_ring_cone_angle:
  770. .. rst-class:: classref-property
  771. :ref:`float<class_float>` **emission_ring_cone_angle** :ref:`🔗<class_ParticleProcessMaterial_property_emission_ring_cone_angle>`
  772. .. rst-class:: classref-property-setget
  773. - |void| **set_emission_ring_cone_angle**\ (\ value\: :ref:`float<class_float>`\ )
  774. - :ref:`float<class_float>` **get_emission_ring_cone_angle**\ (\ )
  775. The angle of the cone when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`. The default angle of 90 degrees results in a ring, while an angle of 0 degrees results in a cone. Intermediate values will result in a ring where one end is larger than the other.
  776. \ **Note:** Depending on :ref:`emission_ring_height<class_ParticleProcessMaterial_property_emission_ring_height>`, the angle may be clamped if the ring's end is reached to form a perfect cone.
  777. .. rst-class:: classref-item-separator
  778. ----
  779. .. _class_ParticleProcessMaterial_property_emission_ring_height:
  780. .. rst-class:: classref-property
  781. :ref:`float<class_float>` **emission_ring_height** :ref:`🔗<class_ParticleProcessMaterial_property_emission_ring_height>`
  782. .. rst-class:: classref-property-setget
  783. - |void| **set_emission_ring_height**\ (\ value\: :ref:`float<class_float>`\ )
  784. - :ref:`float<class_float>` **get_emission_ring_height**\ (\ )
  785. The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  786. .. rst-class:: classref-item-separator
  787. ----
  788. .. _class_ParticleProcessMaterial_property_emission_ring_inner_radius:
  789. .. rst-class:: classref-property
  790. :ref:`float<class_float>` **emission_ring_inner_radius** :ref:`🔗<class_ParticleProcessMaterial_property_emission_ring_inner_radius>`
  791. .. rst-class:: classref-property-setget
  792. - |void| **set_emission_ring_inner_radius**\ (\ value\: :ref:`float<class_float>`\ )
  793. - :ref:`float<class_float>` **get_emission_ring_inner_radius**\ (\ )
  794. The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  795. .. rst-class:: classref-item-separator
  796. ----
  797. .. _class_ParticleProcessMaterial_property_emission_ring_radius:
  798. .. rst-class:: classref-property
  799. :ref:`float<class_float>` **emission_ring_radius** :ref:`🔗<class_ParticleProcessMaterial_property_emission_ring_radius>`
  800. .. rst-class:: classref-property-setget
  801. - |void| **set_emission_ring_radius**\ (\ value\: :ref:`float<class_float>`\ )
  802. - :ref:`float<class_float>` **get_emission_ring_radius**\ (\ )
  803. The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
  804. .. rst-class:: classref-item-separator
  805. ----
  806. .. _class_ParticleProcessMaterial_property_emission_shape:
  807. .. rst-class:: classref-property
  808. :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **emission_shape** = ``0`` :ref:`🔗<class_ParticleProcessMaterial_property_emission_shape>`
  809. .. rst-class:: classref-property-setget
  810. - |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>`\ )
  811. - :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **get_emission_shape**\ (\ )
  812. Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` constants for values.
  813. .. rst-class:: classref-item-separator
  814. ----
  815. .. _class_ParticleProcessMaterial_property_emission_shape_offset:
  816. .. rst-class:: classref-property
  817. :ref:`Vector3<class_Vector3>` **emission_shape_offset** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_ParticleProcessMaterial_property_emission_shape_offset>`
  818. .. rst-class:: classref-property-setget
  819. - |void| **set_emission_shape_offset**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  820. - :ref:`Vector3<class_Vector3>` **get_emission_shape_offset**\ (\ )
  821. The offset for the :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>`, in local space.
  822. .. rst-class:: classref-item-separator
  823. ----
  824. .. _class_ParticleProcessMaterial_property_emission_shape_scale:
  825. .. rst-class:: classref-property
  826. :ref:`Vector3<class_Vector3>` **emission_shape_scale** = ``Vector3(1, 1, 1)`` :ref:`🔗<class_ParticleProcessMaterial_property_emission_shape_scale>`
  827. .. rst-class:: classref-property-setget
  828. - |void| **set_emission_shape_scale**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  829. - :ref:`Vector3<class_Vector3>` **get_emission_shape_scale**\ (\ )
  830. The scale of the :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>`, in local space.
  831. .. rst-class:: classref-item-separator
  832. ----
  833. .. _class_ParticleProcessMaterial_property_emission_sphere_radius:
  834. .. rst-class:: classref-property
  835. :ref:`float<class_float>` **emission_sphere_radius** :ref:`🔗<class_ParticleProcessMaterial_property_emission_sphere_radius>`
  836. .. rst-class:: classref-property-setget
  837. - |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float<class_float>`\ )
  838. - :ref:`float<class_float>` **get_emission_sphere_radius**\ (\ )
  839. The sphere's radius if :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE>`.
  840. .. rst-class:: classref-item-separator
  841. ----
  842. .. _class_ParticleProcessMaterial_property_flatness:
  843. .. rst-class:: classref-property
  844. :ref:`float<class_float>` **flatness** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_flatness>`
  845. .. rst-class:: classref-property-setget
  846. - |void| **set_flatness**\ (\ value\: :ref:`float<class_float>`\ )
  847. - :ref:`float<class_float>` **get_flatness**\ (\ )
  848. Amount of :ref:`spread<class_ParticleProcessMaterial_property_spread>` along the Y axis.
  849. .. rst-class:: classref-item-separator
  850. ----
  851. .. _class_ParticleProcessMaterial_property_gravity:
  852. .. rst-class:: classref-property
  853. :ref:`Vector3<class_Vector3>` **gravity** = ``Vector3(0, -9.8, 0)`` :ref:`🔗<class_ParticleProcessMaterial_property_gravity>`
  854. .. rst-class:: classref-property-setget
  855. - |void| **set_gravity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  856. - :ref:`Vector3<class_Vector3>` **get_gravity**\ (\ )
  857. Gravity applied to every particle.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _class_ParticleProcessMaterial_property_hue_variation_curve:
  861. .. rst-class:: classref-property
  862. :ref:`Texture2D<class_Texture2D>` **hue_variation_curve** :ref:`🔗<class_ParticleProcessMaterial_property_hue_variation_curve>`
  863. .. rst-class:: classref-property-setget
  864. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  865. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  866. Each particle's hue will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  867. .. rst-class:: classref-item-separator
  868. ----
  869. .. _class_ParticleProcessMaterial_property_hue_variation_max:
  870. .. rst-class:: classref-property
  871. :ref:`float<class_float>` **hue_variation_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_hue_variation_max>`
  872. .. rst-class:: classref-property-setget
  873. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  874. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  875. Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
  876. .. rst-class:: classref-item-separator
  877. ----
  878. .. _class_ParticleProcessMaterial_property_hue_variation_min:
  879. .. rst-class:: classref-property
  880. :ref:`float<class_float>` **hue_variation_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_hue_variation_min>`
  881. .. rst-class:: classref-property-setget
  882. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  883. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  884. Minimum equivalent of :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>`.
  885. .. rst-class:: classref-item-separator
  886. ----
  887. .. _class_ParticleProcessMaterial_property_inherit_velocity_ratio:
  888. .. rst-class:: classref-property
  889. :ref:`float<class_float>` **inherit_velocity_ratio** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_inherit_velocity_ratio>`
  890. .. rst-class:: classref-property-setget
  891. - |void| **set_inherit_velocity_ratio**\ (\ value\: :ref:`float<class_float>`\ )
  892. - :ref:`float<class_float>` **get_inherit_velocity_ratio**\ (\ )
  893. Percentage of the velocity of the respective :ref:`GPUParticles2D<class_GPUParticles2D>` or :ref:`GPUParticles3D<class_GPUParticles3D>` inherited by each particle when spawning.
  894. .. rst-class:: classref-item-separator
  895. ----
  896. .. _class_ParticleProcessMaterial_property_initial_velocity_max:
  897. .. rst-class:: classref-property
  898. :ref:`float<class_float>` **initial_velocity_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_initial_velocity_max>`
  899. .. rst-class:: classref-property-setget
  900. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  901. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  902. Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction<class_ParticleProcessMaterial_property_direction>` and :ref:`spread<class_ParticleProcessMaterial_property_spread>`.
  903. .. rst-class:: classref-item-separator
  904. ----
  905. .. _class_ParticleProcessMaterial_property_initial_velocity_min:
  906. .. rst-class:: classref-property
  907. :ref:`float<class_float>` **initial_velocity_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_initial_velocity_min>`
  908. .. rst-class:: classref-property-setget
  909. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  910. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  911. Minimum equivalent of :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>`.
  912. .. rst-class:: classref-item-separator
  913. ----
  914. .. _class_ParticleProcessMaterial_property_lifetime_randomness:
  915. .. rst-class:: classref-property
  916. :ref:`float<class_float>` **lifetime_randomness** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_lifetime_randomness>`
  917. .. rst-class:: classref-property-setget
  918. - |void| **set_lifetime_randomness**\ (\ value\: :ref:`float<class_float>`\ )
  919. - :ref:`float<class_float>` **get_lifetime_randomness**\ (\ )
  920. Particle lifetime randomness ratio. The equation for the lifetime of a particle is ``lifetime * (1.0 - randf() * lifetime_randomness)``. For example, a :ref:`lifetime_randomness<class_ParticleProcessMaterial_property_lifetime_randomness>` of ``0.4`` scales the lifetime between ``0.6`` to ``1.0`` of its original value.
  921. .. rst-class:: classref-item-separator
  922. ----
  923. .. _class_ParticleProcessMaterial_property_linear_accel_curve:
  924. .. rst-class:: classref-property
  925. :ref:`Texture2D<class_Texture2D>` **linear_accel_curve** :ref:`🔗<class_ParticleProcessMaterial_property_linear_accel_curve>`
  926. .. rst-class:: classref-property-setget
  927. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  928. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  929. Each particle's linear acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  930. .. rst-class:: classref-item-separator
  931. ----
  932. .. _class_ParticleProcessMaterial_property_linear_accel_max:
  933. .. rst-class:: classref-property
  934. :ref:`float<class_float>` **linear_accel_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_linear_accel_max>`
  935. .. rst-class:: classref-property-setget
  936. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  937. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  938. Maximum linear acceleration applied to each particle in the direction of motion.
  939. .. rst-class:: classref-item-separator
  940. ----
  941. .. _class_ParticleProcessMaterial_property_linear_accel_min:
  942. .. rst-class:: classref-property
  943. :ref:`float<class_float>` **linear_accel_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_linear_accel_min>`
  944. .. rst-class:: classref-property-setget
  945. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  946. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  947. Minimum equivalent of :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>`.
  948. .. rst-class:: classref-item-separator
  949. ----
  950. .. _class_ParticleProcessMaterial_property_orbit_velocity_curve:
  951. .. rst-class:: classref-property
  952. :ref:`Texture2D<class_Texture2D>` **orbit_velocity_curve** :ref:`🔗<class_ParticleProcessMaterial_property_orbit_velocity_curve>`
  953. .. rst-class:: classref-property-setget
  954. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  955. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  956. Each particle's orbital velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  957. \ **Note:** For 3D orbital velocity, use a :ref:`CurveXYZTexture<class_CurveXYZTexture>`.
  958. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  959. .. rst-class:: classref-item-separator
  960. ----
  961. .. _class_ParticleProcessMaterial_property_orbit_velocity_max:
  962. .. rst-class:: classref-property
  963. :ref:`float<class_float>` **orbit_velocity_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_orbit_velocity_max>`
  964. .. rst-class:: classref-property-setget
  965. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  966. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  967. Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
  968. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  969. .. rst-class:: classref-item-separator
  970. ----
  971. .. _class_ParticleProcessMaterial_property_orbit_velocity_min:
  972. .. rst-class:: classref-property
  973. :ref:`float<class_float>` **orbit_velocity_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_orbit_velocity_min>`
  974. .. rst-class:: classref-property-setget
  975. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  976. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  977. Minimum equivalent of :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>`.
  978. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  979. .. rst-class:: classref-item-separator
  980. ----
  981. .. _class_ParticleProcessMaterial_property_particle_flag_align_y:
  982. .. rst-class:: classref-property
  983. :ref:`bool<class_bool>` **particle_flag_align_y** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_particle_flag_align_y>`
  984. .. rst-class:: classref-property-setget
  985. - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
  986. - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
  987. Align Y axis of particle with the direction of its velocity.
  988. .. rst-class:: classref-item-separator
  989. ----
  990. .. _class_ParticleProcessMaterial_property_particle_flag_damping_as_friction:
  991. .. rst-class:: classref-property
  992. :ref:`bool<class_bool>` **particle_flag_damping_as_friction** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_particle_flag_damping_as_friction>`
  993. .. rst-class:: classref-property-setget
  994. - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
  995. - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
  996. Changes the behavior of the damping properties from a linear deceleration to a deceleration based on speed percentage.
  997. .. rst-class:: classref-item-separator
  998. ----
  999. .. _class_ParticleProcessMaterial_property_particle_flag_disable_z:
  1000. .. rst-class:: classref-property
  1001. :ref:`bool<class_bool>` **particle_flag_disable_z** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_particle_flag_disable_z>`
  1002. .. rst-class:: classref-property-setget
  1003. - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
  1004. - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
  1005. If ``true``, particles will not move on the z axis.
  1006. .. rst-class:: classref-item-separator
  1007. ----
  1008. .. _class_ParticleProcessMaterial_property_particle_flag_rotate_y:
  1009. .. rst-class:: classref-property
  1010. :ref:`bool<class_bool>` **particle_flag_rotate_y** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_particle_flag_rotate_y>`
  1011. .. rst-class:: classref-property-setget
  1012. - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
  1013. - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
  1014. If ``true``, particles rotate around Y axis by :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>`.
  1015. .. rst-class:: classref-item-separator
  1016. ----
  1017. .. _class_ParticleProcessMaterial_property_radial_accel_curve:
  1018. .. rst-class:: classref-property
  1019. :ref:`Texture2D<class_Texture2D>` **radial_accel_curve** :ref:`🔗<class_ParticleProcessMaterial_property_radial_accel_curve>`
  1020. .. rst-class:: classref-property-setget
  1021. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  1022. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1023. Each particle's radial acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  1024. .. rst-class:: classref-item-separator
  1025. ----
  1026. .. _class_ParticleProcessMaterial_property_radial_accel_max:
  1027. .. rst-class:: classref-property
  1028. :ref:`float<class_float>` **radial_accel_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_radial_accel_max>`
  1029. .. rst-class:: classref-property-setget
  1030. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1031. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1032. Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
  1033. .. rst-class:: classref-item-separator
  1034. ----
  1035. .. _class_ParticleProcessMaterial_property_radial_accel_min:
  1036. .. rst-class:: classref-property
  1037. :ref:`float<class_float>` **radial_accel_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_radial_accel_min>`
  1038. .. rst-class:: classref-property-setget
  1039. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1040. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1041. Minimum equivalent of :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>`.
  1042. .. rst-class:: classref-item-separator
  1043. ----
  1044. .. _class_ParticleProcessMaterial_property_radial_velocity_curve:
  1045. .. rst-class:: classref-property
  1046. :ref:`Texture2D<class_Texture2D>` **radial_velocity_curve** :ref:`🔗<class_ParticleProcessMaterial_property_radial_velocity_curve>`
  1047. .. rst-class:: classref-property-setget
  1048. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  1049. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1050. A :ref:`CurveTexture<class_CurveTexture>` that defines the velocity over the particle's lifetime away (or toward) the :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>`.
  1051. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  1052. .. rst-class:: classref-item-separator
  1053. ----
  1054. .. _class_ParticleProcessMaterial_property_radial_velocity_max:
  1055. .. rst-class:: classref-property
  1056. :ref:`float<class_float>` **radial_velocity_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_radial_velocity_max>`
  1057. .. rst-class:: classref-property-setget
  1058. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1059. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1060. Maximum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>`, or toward it if negative.
  1061. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  1062. .. rst-class:: classref-item-separator
  1063. ----
  1064. .. _class_ParticleProcessMaterial_property_radial_velocity_min:
  1065. .. rst-class:: classref-property
  1066. :ref:`float<class_float>` **radial_velocity_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_radial_velocity_min>`
  1067. .. rst-class:: classref-property-setget
  1068. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1069. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1070. Minimum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>`, or toward it if negative.
  1071. \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
  1072. .. rst-class:: classref-item-separator
  1073. ----
  1074. .. _class_ParticleProcessMaterial_property_scale_curve:
  1075. .. rst-class:: classref-property
  1076. :ref:`Texture2D<class_Texture2D>` **scale_curve** :ref:`🔗<class_ParticleProcessMaterial_property_scale_curve>`
  1077. .. rst-class:: classref-property-setget
  1078. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  1079. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1080. Each particle's scale will vary along this :ref:`CurveTexture<class_CurveTexture>` over its lifetime. If a :ref:`CurveXYZTexture<class_CurveXYZTexture>` is supplied instead, the scale will be separated per-axis.
  1081. .. rst-class:: classref-item-separator
  1082. ----
  1083. .. _class_ParticleProcessMaterial_property_scale_max:
  1084. .. rst-class:: classref-property
  1085. :ref:`float<class_float>` **scale_max** = ``1.0`` :ref:`🔗<class_ParticleProcessMaterial_property_scale_max>`
  1086. .. rst-class:: classref-property-setget
  1087. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1088. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1089. Maximum initial scale applied to each particle.
  1090. .. rst-class:: classref-item-separator
  1091. ----
  1092. .. _class_ParticleProcessMaterial_property_scale_min:
  1093. .. rst-class:: classref-property
  1094. :ref:`float<class_float>` **scale_min** = ``1.0`` :ref:`🔗<class_ParticleProcessMaterial_property_scale_min>`
  1095. .. rst-class:: classref-property-setget
  1096. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1097. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1098. Minimum equivalent of :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>`.
  1099. .. rst-class:: classref-item-separator
  1100. ----
  1101. .. _class_ParticleProcessMaterial_property_scale_over_velocity_curve:
  1102. .. rst-class:: classref-property
  1103. :ref:`Texture2D<class_Texture2D>` **scale_over_velocity_curve** :ref:`🔗<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`
  1104. .. rst-class:: classref-property-setget
  1105. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  1106. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1107. Either a :ref:`CurveTexture<class_CurveTexture>` or a :ref:`CurveXYZTexture<class_CurveXYZTexture>` that scales each particle based on its velocity.
  1108. .. rst-class:: classref-item-separator
  1109. ----
  1110. .. _class_ParticleProcessMaterial_property_scale_over_velocity_max:
  1111. .. rst-class:: classref-property
  1112. :ref:`float<class_float>` **scale_over_velocity_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_scale_over_velocity_max>`
  1113. .. rst-class:: classref-property-setget
  1114. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1115. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1116. Maximum velocity value reference for :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`.
  1117. \ :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>` will be interpolated between :ref:`scale_over_velocity_min<class_ParticleProcessMaterial_property_scale_over_velocity_min>` and :ref:`scale_over_velocity_max<class_ParticleProcessMaterial_property_scale_over_velocity_max>`.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_ParticleProcessMaterial_property_scale_over_velocity_min:
  1121. .. rst-class:: classref-property
  1122. :ref:`float<class_float>` **scale_over_velocity_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_scale_over_velocity_min>`
  1123. .. rst-class:: classref-property-setget
  1124. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1125. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1126. Minimum velocity value reference for :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`.
  1127. \ :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>` will be interpolated between :ref:`scale_over_velocity_min<class_ParticleProcessMaterial_property_scale_over_velocity_min>` and :ref:`scale_over_velocity_max<class_ParticleProcessMaterial_property_scale_over_velocity_max>`.
  1128. .. rst-class:: classref-item-separator
  1129. ----
  1130. .. _class_ParticleProcessMaterial_property_spread:
  1131. .. rst-class:: classref-property
  1132. :ref:`float<class_float>` **spread** = ``45.0`` :ref:`🔗<class_ParticleProcessMaterial_property_spread>`
  1133. .. rst-class:: classref-property-setget
  1134. - |void| **set_spread**\ (\ value\: :ref:`float<class_float>`\ )
  1135. - :ref:`float<class_float>` **get_spread**\ (\ )
  1136. Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
  1137. .. rst-class:: classref-item-separator
  1138. ----
  1139. .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision:
  1140. .. rst-class:: classref-property
  1141. :ref:`int<class_int>` **sub_emitter_amount_at_collision** :ref:`🔗<class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision>`
  1142. .. rst-class:: classref-property-setget
  1143. - |void| **set_sub_emitter_amount_at_collision**\ (\ value\: :ref:`int<class_int>`\ )
  1144. - :ref:`int<class_int>` **get_sub_emitter_amount_at_collision**\ (\ )
  1145. The amount of particles to spawn from the subemitter node when a collision occurs. When combined with :ref:`COLLISION_HIDE_ON_CONTACT<class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT>` on the main particles material, this can be used to achieve effects such as raindrops hitting the ground.
  1146. \ **Note:** This value shouldn't exceed :ref:`GPUParticles2D.amount<class_GPUParticles2D_property_amount>` or :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>` defined on the *subemitter node* (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.
  1147. .. rst-class:: classref-item-separator
  1148. ----
  1149. .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_end:
  1150. .. rst-class:: classref-property
  1151. :ref:`int<class_int>` **sub_emitter_amount_at_end** :ref:`🔗<class_ParticleProcessMaterial_property_sub_emitter_amount_at_end>`
  1152. .. rst-class:: classref-property-setget
  1153. - |void| **set_sub_emitter_amount_at_end**\ (\ value\: :ref:`int<class_int>`\ )
  1154. - :ref:`int<class_int>` **get_sub_emitter_amount_at_end**\ (\ )
  1155. The amount of particles to spawn from the subemitter node when the particle expires.
  1156. \ **Note:** This value shouldn't exceed :ref:`GPUParticles2D.amount<class_GPUParticles2D_property_amount>` or :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>` defined on the *subemitter node* (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.
  1157. .. rst-class:: classref-item-separator
  1158. ----
  1159. .. _class_ParticleProcessMaterial_property_sub_emitter_frequency:
  1160. .. rst-class:: classref-property
  1161. :ref:`float<class_float>` **sub_emitter_frequency** :ref:`🔗<class_ParticleProcessMaterial_property_sub_emitter_frequency>`
  1162. .. rst-class:: classref-property-setget
  1163. - |void| **set_sub_emitter_frequency**\ (\ value\: :ref:`float<class_float>`\ )
  1164. - :ref:`float<class_float>` **get_sub_emitter_frequency**\ (\ )
  1165. The frequency at which particles should be emitted from the subemitter node. One particle will be spawned every :ref:`sub_emitter_frequency<class_ParticleProcessMaterial_property_sub_emitter_frequency>` seconds.
  1166. \ **Note:** This value shouldn't exceed :ref:`GPUParticles2D.amount<class_GPUParticles2D_property_amount>` or :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>` defined on the *subemitter node* (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.
  1167. .. rst-class:: classref-item-separator
  1168. ----
  1169. .. _class_ParticleProcessMaterial_property_sub_emitter_keep_velocity:
  1170. .. rst-class:: classref-property
  1171. :ref:`bool<class_bool>` **sub_emitter_keep_velocity** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_sub_emitter_keep_velocity>`
  1172. .. rst-class:: classref-property-setget
  1173. - |void| **set_sub_emitter_keep_velocity**\ (\ value\: :ref:`bool<class_bool>`\ )
  1174. - :ref:`bool<class_bool>` **get_sub_emitter_keep_velocity**\ (\ )
  1175. If ``true``, the subemitter inherits the parent particle's velocity when it spawns.
  1176. .. rst-class:: classref-item-separator
  1177. ----
  1178. .. _class_ParticleProcessMaterial_property_sub_emitter_mode:
  1179. .. rst-class:: classref-property
  1180. :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **sub_emitter_mode** = ``0`` :ref:`🔗<class_ParticleProcessMaterial_property_sub_emitter_mode>`
  1181. .. rst-class:: classref-property-setget
  1182. - |void| **set_sub_emitter_mode**\ (\ value\: :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>`\ )
  1183. - :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **get_sub_emitter_mode**\ (\ )
  1184. The particle subemitter mode (see :ref:`GPUParticles2D.sub_emitter<class_GPUParticles2D_property_sub_emitter>` and :ref:`GPUParticles3D.sub_emitter<class_GPUParticles3D_property_sub_emitter>`).
  1185. .. rst-class:: classref-item-separator
  1186. ----
  1187. .. _class_ParticleProcessMaterial_property_tangential_accel_curve:
  1188. .. rst-class:: classref-property
  1189. :ref:`Texture2D<class_Texture2D>` **tangential_accel_curve** :ref:`🔗<class_ParticleProcessMaterial_property_tangential_accel_curve>`
  1190. .. rst-class:: classref-property-setget
  1191. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  1192. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1193. Each particle's tangential acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
  1194. .. rst-class:: classref-item-separator
  1195. ----
  1196. .. _class_ParticleProcessMaterial_property_tangential_accel_max:
  1197. .. rst-class:: classref-property
  1198. :ref:`float<class_float>` **tangential_accel_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_tangential_accel_max>`
  1199. .. rst-class:: classref-property-setget
  1200. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1201. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1202. Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
  1203. .. rst-class:: classref-item-separator
  1204. ----
  1205. .. _class_ParticleProcessMaterial_property_tangential_accel_min:
  1206. .. rst-class:: classref-property
  1207. :ref:`float<class_float>` **tangential_accel_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_tangential_accel_min>`
  1208. .. rst-class:: classref-property-setget
  1209. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1210. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1211. Minimum equivalent of :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>`.
  1212. .. rst-class:: classref-item-separator
  1213. ----
  1214. .. _class_ParticleProcessMaterial_property_turbulence_enabled:
  1215. .. rst-class:: classref-property
  1216. :ref:`bool<class_bool>` **turbulence_enabled** = ``false`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_enabled>`
  1217. .. rst-class:: classref-property-setget
  1218. - |void| **set_turbulence_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  1219. - :ref:`bool<class_bool>` **get_turbulence_enabled**\ (\ )
  1220. 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). In 3D, :ref:`GPUParticlesAttractorVectorField3D<class_GPUParticlesAttractorVectorField3D>` with :ref:`NoiseTexture3D<class_NoiseTexture3D>` can be used as an alternative to turbulence that works in world space and with multiple particle systems reacting in the same way.
  1221. \ **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.
  1222. .. rst-class:: classref-item-separator
  1223. ----
  1224. .. _class_ParticleProcessMaterial_property_turbulence_influence_max:
  1225. .. rst-class:: classref-property
  1226. :ref:`float<class_float>` **turbulence_influence_max** = ``0.1`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_influence_max>`
  1227. .. rst-class:: classref-property-setget
  1228. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1229. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1230. Maximum turbulence influence on each particle.
  1231. 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>`.
  1232. .. rst-class:: classref-item-separator
  1233. ----
  1234. .. _class_ParticleProcessMaterial_property_turbulence_influence_min:
  1235. .. rst-class:: classref-property
  1236. :ref:`float<class_float>` **turbulence_influence_min** = ``0.1`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_influence_min>`
  1237. .. rst-class:: classref-property-setget
  1238. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1239. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1240. Minimum turbulence influence on each particle.
  1241. 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>`.
  1242. .. rst-class:: classref-item-separator
  1243. ----
  1244. .. _class_ParticleProcessMaterial_property_turbulence_influence_over_life:
  1245. .. rst-class:: classref-property
  1246. :ref:`Texture2D<class_Texture2D>` **turbulence_influence_over_life** :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_influence_over_life>`
  1247. .. rst-class:: classref-property-setget
  1248. - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
  1249. - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1250. Each particle's amount of turbulence will be influenced along this :ref:`CurveTexture<class_CurveTexture>` over its life time.
  1251. .. rst-class:: classref-item-separator
  1252. ----
  1253. .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_max:
  1254. .. rst-class:: classref-property
  1255. :ref:`float<class_float>` **turbulence_initial_displacement_max** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>`
  1256. .. rst-class:: classref-property-setget
  1257. - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1258. - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1259. Maximum displacement of each particle's spawn position by the turbulence.
  1260. 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>`.
  1261. .. rst-class:: classref-item-separator
  1262. ----
  1263. .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_min:
  1264. .. rst-class:: classref-property
  1265. :ref:`float<class_float>` **turbulence_initial_displacement_min** = ``0.0`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>`
  1266. .. rst-class:: classref-property-setget
  1267. - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
  1268. - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
  1269. Minimum displacement of each particle's spawn position by the turbulence.
  1270. 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>`.
  1271. .. rst-class:: classref-item-separator
  1272. ----
  1273. .. _class_ParticleProcessMaterial_property_turbulence_noise_scale:
  1274. .. rst-class:: classref-property
  1275. :ref:`float<class_float>` **turbulence_noise_scale** = ``9.0`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_noise_scale>`
  1276. .. rst-class:: classref-property-setget
  1277. - |void| **set_turbulence_noise_scale**\ (\ value\: :ref:`float<class_float>`\ )
  1278. - :ref:`float<class_float>` **get_turbulence_noise_scale**\ (\ )
  1279. This value controls the overall scale/frequency of the turbulence noise pattern.
  1280. A small scale will result in smaller features with more detail while a high scale will result in smoother noise with larger features.
  1281. .. rst-class:: classref-item-separator
  1282. ----
  1283. .. _class_ParticleProcessMaterial_property_turbulence_noise_speed:
  1284. .. rst-class:: classref-property
  1285. :ref:`Vector3<class_Vector3>` **turbulence_noise_speed** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_noise_speed>`
  1286. .. rst-class:: classref-property-setget
  1287. - |void| **set_turbulence_noise_speed**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  1288. - :ref:`Vector3<class_Vector3>` **get_turbulence_noise_speed**\ (\ )
  1289. A scrolling velocity for the turbulence field. This sets a directional trend for the pattern to move in over time.
  1290. The default value of ``Vector3(0, 0, 0)`` turns off the scrolling.
  1291. .. rst-class:: classref-item-separator
  1292. ----
  1293. .. _class_ParticleProcessMaterial_property_turbulence_noise_speed_random:
  1294. .. rst-class:: classref-property
  1295. :ref:`float<class_float>` **turbulence_noise_speed_random** = ``0.2`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_noise_speed_random>`
  1296. .. rst-class:: classref-property-setget
  1297. - |void| **set_turbulence_noise_speed_random**\ (\ value\: :ref:`float<class_float>`\ )
  1298. - :ref:`float<class_float>` **get_turbulence_noise_speed_random**\ (\ )
  1299. The in-place rate of change of the turbulence field. This defines how quickly the noise pattern varies over time.
  1300. A value of 0.0 will result in a fixed pattern.
  1301. .. rst-class:: classref-item-separator
  1302. ----
  1303. .. _class_ParticleProcessMaterial_property_turbulence_noise_strength:
  1304. .. rst-class:: classref-property
  1305. :ref:`float<class_float>` **turbulence_noise_strength** = ``1.0`` :ref:`🔗<class_ParticleProcessMaterial_property_turbulence_noise_strength>`
  1306. .. rst-class:: classref-property-setget
  1307. - |void| **set_turbulence_noise_strength**\ (\ value\: :ref:`float<class_float>`\ )
  1308. - :ref:`float<class_float>` **get_turbulence_noise_strength**\ (\ )
  1309. The turbulence noise strength. Increasing this will result in a stronger, more contrasting, flow pattern.
  1310. .. rst-class:: classref-item-separator
  1311. ----
  1312. .. _class_ParticleProcessMaterial_property_velocity_limit_curve:
  1313. .. rst-class:: classref-property
  1314. :ref:`Texture2D<class_Texture2D>` **velocity_limit_curve** :ref:`🔗<class_ParticleProcessMaterial_property_velocity_limit_curve>`
  1315. .. rst-class:: classref-property-setget
  1316. - |void| **set_velocity_limit_curve**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
  1317. - :ref:`Texture2D<class_Texture2D>` **get_velocity_limit_curve**\ (\ )
  1318. A :ref:`CurveTexture<class_CurveTexture>` that defines the maximum velocity of a particle during its lifetime.
  1319. .. rst-class:: classref-item-separator
  1320. ----
  1321. .. _class_ParticleProcessMaterial_property_velocity_pivot:
  1322. .. rst-class:: classref-property
  1323. :ref:`Vector3<class_Vector3>` **velocity_pivot** = ``Vector3(0, 0, 0)`` :ref:`🔗<class_ParticleProcessMaterial_property_velocity_pivot>`
  1324. .. rst-class:: classref-property-setget
  1325. - |void| **set_velocity_pivot**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
  1326. - :ref:`Vector3<class_Vector3>` **get_velocity_pivot**\ (\ )
  1327. A pivot point used to calculate radial and orbital velocity of particles.
  1328. .. rst-class:: classref-section-separator
  1329. ----
  1330. .. rst-class:: classref-descriptions-group
  1331. Method Descriptions
  1332. -------------------
  1333. .. _class_ParticleProcessMaterial_method_get_param:
  1334. .. rst-class:: classref-method
  1335. :ref:`Vector2<class_Vector2>` **get_param**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`🔗<class_ParticleProcessMaterial_method_get_param>`
  1336. Returns the minimum and maximum values of the given ``param`` as a vector.
  1337. The ``x`` component of the returned vector corresponds to minimum and the ``y`` component corresponds to maximum.
  1338. .. rst-class:: classref-item-separator
  1339. ----
  1340. .. _class_ParticleProcessMaterial_method_get_param_max:
  1341. .. rst-class:: classref-method
  1342. :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`🔗<class_ParticleProcessMaterial_method_get_param_max>`
  1343. Returns the maximum value range for the given parameter.
  1344. .. rst-class:: classref-item-separator
  1345. ----
  1346. .. _class_ParticleProcessMaterial_method_get_param_min:
  1347. .. rst-class:: classref-method
  1348. :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`🔗<class_ParticleProcessMaterial_method_get_param_min>`
  1349. Returns the minimum value range for the given parameter.
  1350. .. rst-class:: classref-item-separator
  1351. ----
  1352. .. _class_ParticleProcessMaterial_method_get_param_texture:
  1353. .. rst-class:: classref-method
  1354. :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`🔗<class_ParticleProcessMaterial_method_get_param_texture>`
  1355. Returns the :ref:`Texture2D<class_Texture2D>` used by the specified parameter.
  1356. .. rst-class:: classref-item-separator
  1357. ----
  1358. .. _class_ParticleProcessMaterial_method_get_particle_flag:
  1359. .. rst-class:: classref-method
  1360. :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const| :ref:`🔗<class_ParticleProcessMaterial_method_get_particle_flag>`
  1361. Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
  1362. .. rst-class:: classref-item-separator
  1363. ----
  1364. .. _class_ParticleProcessMaterial_method_set_param:
  1365. .. rst-class:: classref-method
  1366. |void| **set_param**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_ParticleProcessMaterial_method_set_param>`
  1367. Sets the minimum and maximum values of the given ``param``.
  1368. The ``x`` component of the argument vector corresponds to minimum and the ``y`` component corresponds to maximum.
  1369. .. rst-class:: classref-item-separator
  1370. ----
  1371. .. _class_ParticleProcessMaterial_method_set_param_max:
  1372. .. rst-class:: classref-method
  1373. |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_ParticleProcessMaterial_method_set_param_max>`
  1374. Sets the maximum value range for the given parameter.
  1375. .. rst-class:: classref-item-separator
  1376. ----
  1377. .. _class_ParticleProcessMaterial_method_set_param_min:
  1378. .. rst-class:: classref-method
  1379. |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_ParticleProcessMaterial_method_set_param_min>`
  1380. Sets the minimum value range for the given parameter.
  1381. .. rst-class:: classref-item-separator
  1382. ----
  1383. .. _class_ParticleProcessMaterial_method_set_param_texture:
  1384. .. rst-class:: classref-method
  1385. |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_ParticleProcessMaterial_method_set_param_texture>`
  1386. Sets the :ref:`Texture2D<class_Texture2D>` for the specified :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`.
  1387. .. rst-class:: classref-item-separator
  1388. ----
  1389. .. _class_ParticleProcessMaterial_method_set_particle_flag:
  1390. .. rst-class:: classref-method
  1391. |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_ParticleProcessMaterial_method_set_particle_flag>`
  1392. If ``true``, enables the specified particle flag. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
  1393. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1394. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1395. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1396. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1397. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1398. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1399. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  1400. .. |void| replace:: :abbr:`void (No return value.)`