class_particleprocessmaterial.rst 135 KB

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